e([VR @ s d d l Z d d l Z d d l Z d d l m Z m Z m Z m Z m Z m Z m
Z
m Z d d l m
Z
d d l m Z m Z d d l m Z d d l m Z e Z d: Z d Z d d Z d d d d Z d d d d d d d d d d Z d d d d d d d Z d d Z d d d Z d d d d d d d d! d" d# d$ d% d d d& d' Z d( d) Z d d d d d d d d d* d+ Z d, d- Z! d d d d d. d/ Z" d d d d d0 d d1 d2 Z# d d d3 d4 Z$ d Z% d d5 d6 Z& d7 d d8 d9 Z' d S); N ) raw_input text_type string_typesisatty
strip_ansiget_winterm_sizeDEFAULT_COLUMNSWIN)echo)Abort
UsageError) convert_type)resolve_color_defaultblackredgreenyellowbluemagentacyanwhiteresetz[0mc C s d d l } | j | S)Nr )getpass)promptr r
/termui.pyhidden_prompt_func s r Fc C s0 | } | d k r( | r( d | | f } | | S)Nz%s [%s]r )textsuffix show_defaultdefaultr r r r
_build_prompt s r" z: Tc s d } f d d }
| d k r6 t | | } t | | | | } x x* |
| } | rg PqQ | d k rQ | SqQ Wy | | } Wn? t k
r }
z t d |
j d wN WYd d }
~
Xn X| s | Sx |
d } | r Pq W| | k r| St d d qN Wd S)a Prompts a user for input. This is a convenience function that can
be used to prompt a user for input later.
If the user aborts the input by sending a interrupt signal, this
function will catch it and raise a :exc:`Abort` exception.
.. versionadded:: 6.0
Added unicode support for cmd.exe on Windows.
.. versionadded:: 4.0
Added the `err` parameter.
:param text: the text to show for the prompt.
:param default: the default value to use if no input happens. If this
is not given it will prompt until it's aborted.
:param hide_input: if this is set to true then the input value will
be hidden.
:param confirmation_prompt: asks for confirmation for the value.
:param type: the type to use to check the value against.
:param value_proc: if this parameter is provided it's a function that
is invoked instead of the type conversion to
convert a value.
:param prompt_suffix: a suffix that should be added to the prompt.
:param show_default: shows or hides the default value in the prompt.
:param err: if set to true the file defaults to ``stderr`` instead of
``stdout``, the same as with echo.
Nc st r t p t } y$ t | d d d | d SWn7 t t f k
ro rb t d d t Yn Xd S)NnlFerr )r visible_prompt_funcr KeyboardInterruptEOFErrorr )r f)r$
hide_inputr r prompt_funcC s zprompt.<locals>.prompt_funcz Error: %sr$ zRepeat for confirmation: z*Error: the two entered values do not match)r r" r
r message)r r! r* Zconfirmation_prompttypeZ
value_proc
prompt_suffixr r$ resultr+ r valueeZvalue2r )r$ r* r r " s4 r c C s t | | | | r d p d } x y2 t | d d d | t d j j } Wn! t t f k
ry t Yn X| d
k r d } n= | d k r d } n( | d k r | } n t d d | q$ Pq$ W| r | r t | S)a Prompts for confirmation (yes/no question).
If the user aborts the input by sending a interrupt signal this
function will catch it and raise a :exc:`Abort` exception.
.. versionadded:: 4.0
Added the `err` parameter.
:param text: the question to ask.
:param default: the default for the prompt.
:param abort: if this is set to `True` a negative answer aborts the
exception by raising :exc:`Abort`.
:param prompt_suffix: a suffix that should be added to the prompt.
:param show_default: shows or hides the default value in the prompt.
:param err: if set to true the file defaults to ``stderr`` instead of
``stdout``, the same as with echo.
zY/nzy/Nr# Fr$ r% yyesTnnozError: invalid input)r2 zyes)r4 zno)r" r r& lowerstripr' r( r ) r r! abortr. r r$ r r0 rvr r r confirmq s(
r: c C sO t j d k rL d d l } t | d d } | rL | } | j | j f St d k r_ t Sd d } | d p | d p | d } | s y@ t j t j t j
} z | | } Wd t j | XWn t k
r Yn X| s| d s| d r1t j
j d d
t j
j d t f } t | d t | d f S)
zoReturns the current size of the terminal as tuple in the form
``(width, height)`` in columns and rows.
r Nget_terminal_sizec S s] y@ d d l } d d l } t j d | j | | j d } Wn t k
rX d SYn X| S)Nr ZhhZ1234)fcntltermiosstructunpackZioctlZ
TIOCGWINSZ Exception)fdr= r> crr r r ioctl_gwinsz s "
z'get_terminal_size.<locals>.ioctl_gwinszr LINES COLUMNS)r; r; )sys version_infoshutilgetattrcolumnslinesr osopenctermidO_RDONLYcloserA environgetr int)rK Zshutil_get_terminal_sizeZszrD rC rB r r r r< s,
$
r< c C sH t | } t | t s' t | } d d l m } | | d | S)a3 This function takes a text and shows it via an environment specific
pager on stdout.
.. versionchanged:: 3.0
Added the `color` flag.
:param text: the text to page.
:param color: controls if the pager supports ANSI colors or not. The
default is autodetection.
r )pager
)r
isinstancer r _termui_implrW )r colorrW r r r echo_via_pager s
r\ #-z %(label)s [%(bar)s] %(info)sz $ c C sw d d l m } t |
}
| d | d | d | d | d | d | d | d
| d | d |
d
| d | d | d |
S)a This function creates an iterable context manager that can be used
to iterate over something while showing a progress bar. It will
either iterate over the `iterable` or `length` items (that are counted
up). While iteration happens, this function will print a rendered
progress bar to the given `file` (defaults to stdout) and will attempt
to calculate remaining time and more. By default, this progress bar
will not be rendered if the file is not a terminal.
The context manager creates the progress bar. When the context
manager is entered the progress bar is already displayed. With every
iteration over the progress bar, the iterable passed to the bar is
advanced and the bar is updated. When the context manager exits,
a newline is printed and the progress bar is finalized on screen.
No printing must happen or the progress bar will be unintentionally
destroyed.
Example usage::
with progressbar(items) as bar:
for item in bar:
do_something_with(item)
Alternatively, if no iterable is specified, one can manually update the
progress bar through the `update()` method instead of directly
iterating over the progress bar. The update method accepts the number
of steps to increment the bar with::
with progressbar(length=chunks.total_bytes) as bar:
for chunk in chunks:
process_chunk(chunk)
bar.update(chunks.bytes)
.. versionadded:: 2.0
.. versionadded:: 4.0
Added the `color` parameter. Added a `update` method to the
progressbar object.
:param iterable: an iterable to iterate over. If not provided the length
is required.
:param length: the number of items to iterate over. By default the
progressbar will attempt to ask the iterator about its
length, which might or might not work. If an iterable is
also provided this parameter can be used to override the
length. If an iterable is not provided the progress bar
will iterate over a range of that length.
:param label: the label to show next to the progress bar.
:param show_eta: enables or disables the estimated time display. This is
automatically disabled if the length cannot be
determined.
:param show_percent: enables or disables the percentage display. The
default is `True` if the iterable has a length or
`False` if not.
:param show_pos: enables or disables the absolute position display. The
default is `False`.
:param item_show_func: a function called with the current item which
can return a string to show the current item
next to the progress bar. Note that the current
item can be `None`!
:param fill_char: the character to use to show the filled part of the
progress bar.
:param empty_char: the character to use to show the non-filled part of
the progress bar.
:param bar_template: the format string to use as template for the bar.
The parameters in it are ``label`` for the label,
``bar`` for the progress bar and ``info`` for the
info section.
:param info_sep: the separator between multiple info items (eta etc.)
:param width: the width of the progress bar in characters, 0 means full
terminal width
:param file: the file to write to. If this is not a terminal then
only the label is printed.
:param color: controls if the terminal supports ANSI colors or not. The
default is autodetection. This is only needed if ANSI
codes are included anywhere in the progress bar output
which is not the case by default.
r ) ProgressBariterablelengthshow_eta show_percentshow_positem_show_func fill_char
empty_char bar_templateinfo_sepfilelabelwidthr[ )rZ r` r )ra rb rl rc rd re rf rg rh ri rj rm rk r[ r` r r r progressbar s S rn c C s= t t j s d St r) t j d n t j j d d S)zClears the terminal screen. This will have the effect of clearing
the whole visible space of the terminal and moving the cursor to the
top left. This does not do anything if not connected to a terminal.
.. versionadded:: 2.0
Nclsz
[2J[1;1H)r rI stdoutr
rO systemwriter r r r clear5 s
rs c
C s g } | rS y" | j d t j | d Wn" t k
rR t d | Yn X| r y" | j d t j | d Wn" t k
r t d | Yn X| d k r | j d | r d n d | d k r | j d | r d n d | d k r| j d | rd n d
| d k rD| j d | r<d n d | d k rm| j d | red
n d | j | | r| j t d j | S)aH Styles a text with ANSI styles and returns the new string. By
default the styling is self contained which means that at the end
of the string a reset code is issued. This can be prevented by
passing ``reset=False``.
Examples::
click.echo(click.style('Hello World!', fg='green'))
click.echo(click.style('ATTENTION!', blink=True))
click.echo(click.style('Some things', reverse=True, fg='cyan'))
Supported color names:
* ``black`` (might be a gray)
* ``red``
* ``green``
* ``yellow`` (might be an orange)
* ``blue``
* ``magenta``
* ``cyan``
* ``white`` (might be light gray)
* ``reset`` (reset the color code only)
.. versionadded:: 2.0
:param text: the string to style with ansi codes.
:param fg: if provided this will become the foreground color.
:param bg: if provided this will become the background color.
:param bold: if provided this will enable or disable bold mode.
:param dim: if provided this will enable or disable dim mode. This is
badly supported.
:param underline: if provided this will enable or disable underline.
:param blink: if provided this will enable or disable blinking.
:param reverse: if provided this will enable or disable inverse
rendering (foreground becomes background and the
other way round).
:param reset: by default a reset-all code is added at the end of the
string which means that styles do not carry over. This
can be disabled to compose styles.
z[%dm zUnknown color %r( Nr rE rG r% )append _ansi_colorsindex
ValueError TypeError_ansi_reset_alljoin)
r ZfgZbgZboldZdimZ underlineZblinkreverser bitsr r r styleG s2 *"
"
r c C s
t | S)a Removes ANSI styling information from a string. Usually it's not
necessary to use this function as Click's echo function will
automatically remove styling if necessary.
.. versionadded:: 2.0
:param text: the text to remove style information from.
)r )r r r r unstyle s r c
K s+ t t | | d | d | d | d | S)as This function combines :func:`echo` and :func:`style` into one
call. As such the following two calls are the same::
click.secho('Hello World!', fg='green')
click.echo(click.style('Hello World!', fg='green'))
All keyword arguments are forwarded to the underlying functions
depending on which one they go with.
.. versionadded:: 2.0
rk r# r$ r[ )r r )r rk r# r$ r[ Zstylesr r r secho s r z.txtc C s[ d d l m } | d | d | d | d | } | d k rJ | j | S| j | d S)a Edits the given text in the defined editor. If an editor is given
(should be the full path to the executable but the regular operating
system search path is used for finding the executable) it overrides
the detected editor. Optionally, some environment variables can be
used. If the editor is closed without changes, `None` is returned. In
case a file is edited directly the return value is always `None` and
`require_save` and `extension` are ignored.
If the editor cannot be opened a :exc:`UsageError` is raised.
Note for Windows: to simplify cross-platform usage, the newlines are
automatically converted from POSIX to Windows and vice versa. As such,
the message here will have ``\n`` as newline markers.
:param text: the text to edit.
:param editor: optionally the editor to use. Defaults to automatic
detection.
:param env: environment variables to forward to the editor.
:param require_save: if this is true, then not saving in the editor
will make the return value become `None`.
:param extension: the extension to tell the editor about. This defaults
to `.txt` but changing this might change syntax
highlighting.
:param filename: if provided it will edit this file instead of the
provided text contents. It will not use a temporary
file as an indirection in that case.
r )Editoreditorenv require_save extensionN)rZ r editZ edit_file)r r r r r filenamer r r r r s
r c C s& d d l m } | | d | d | S)ap This function launches the given URL (or filename) in the default
viewer application for this file type. If this is an executable, it
might launch the executable in a new session. The return value is
the exit code of the launched application. Usually, ``0`` indicates
success.
Examples::
click.launch('http://click.pocoo.org/')
click.launch('/my/downloaded/file', locate=True)
.. versionadded:: 2.0
:param url: URL or filename of the thing to launch.
:param wait: waits for the program to stop.
:param locate: if this is set to `True` then instead of launching the
application associated with the URL it will attempt to
launch a file manager with the file located. This
might have weird effects if the URL does not point to
the filesystem.
r )open_urlwaitlocate)rZ r )Zurlr r r r r r launch s r c C s, t } | d k r" d d l m } | | S)a Fetches a single character from the terminal and returns it. This
will always return a unicode character and under certain rare
circumstances this might return more than one character. The
situations which more than one character is returned is when for
whatever reason multiple characters end up in the terminal buffer or
standard input was not actually a terminal.
Note that this will always read from the terminal, even if something
is piped into the standard input.
.. versionadded:: 2.0
:param echo: if set to `True`, the character read will also show up on
the terminal. The default is to not show it.
Nr )getchar)_getcharrZ r )r r) r r r r s r z Press any key to continue ...c C s t t j s t t j r$ d SzF | rC t | d d d | y t Wn t t f k
rh Yn XWd | r t d | Xd S)a This command stops execution and waits for the user to press any
key to continue. This is similar to the Windows batch "pause"
command. If the program is not run through a terminal, this command
will instead do nothing.
.. versionadded:: 2.0
.. versionadded:: 4.0
Added the `err` parameter.
:param info: the info string to print before pausing.
:param err: if set to message goes to ``stderr`` instead of
``stdout``, the same as with echo.
Nr# Fr$ )r rI stdinrp r r r' r( )infor$ r r r pause s r ) r r r r r r r r zreset)(rO rI r? Z_compatr r r r r r r r
Zutilsr
exceptionsr r
typesr globalsr r& r} r r r" r r: r< r\ rn rs r r r r r r r r r r r r <module> sJ : L + ) Y D $