argo_navis: venv/lib/python2.7/site-packages/click/termui.py annotate

author	bcclaywell
date	Mon, 12 Oct 2015 17:43:33 -0400
parents
children

rev	line source
0 d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	1 import os
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	2 import sys
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	3 import struct
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	4
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	5 from ._compat import raw_input, text_type, string_types, \
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	6 isatty, strip_ansi, get_winterm_size, DEFAULT_COLUMNS, WIN
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	7 from .utils import echo
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	8 from .exceptions import Abort, UsageError
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	9 from .types import convert_type
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	10 from .globals import resolve_color_default
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	11
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	12
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	13 # The prompt functions to use. The doc tools currently override these
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	14 # functions to customize how they work.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	15 visible_prompt_func = raw_input
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	16
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	17 _ansi_colors = ('black', 'red', 'green', 'yellow', 'blue', 'magenta',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	18 'cyan', 'white', 'reset')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	19 _ansi_reset_all = '\033[0m'
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	20
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	21
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	22 def hidden_prompt_func(prompt):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	23 import getpass
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	24 return getpass.getpass(prompt)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	25
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	26
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	27 def _build_prompt(text, suffix, show_default=False, default=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	28 prompt = text
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	29 if default is not None and show_default:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	30 prompt = '%s [%s]' % (prompt, default)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	31 return prompt + suffix
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	32
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	33
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	34 def prompt(text, default=None, hide_input=False,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	35 confirmation_prompt=False, type=None,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	36 value_proc=None, prompt_suffix=': ',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	37 show_default=True, err=False):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	38 """Prompts a user for input. This is a convenience function that can
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	39 be used to prompt a user for input later.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	40
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	41 If the user aborts the input by sending a interrupt signal, this
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	42 function will catch it and raise a :exc:`Abort` exception.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	43
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	44 .. versionadded:: 4.0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	45 Added the `err` parameter.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	46
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	47 :param text: the text to show for the prompt.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	48 :param default: the default value to use if no input happens. If this
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	49 is not given it will prompt until it's aborted.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	50 :param hide_input: if this is set to true then the input value will
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	51 be hidden.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	52 :param confirmation_prompt: asks for confirmation for the value.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	53 :param type: the type to use to check the value against.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	54 :param value_proc: if this parameter is provided it's a function that
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	55 is invoked instead of the type conversion to
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	56 convert a value.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	57 :param prompt_suffix: a suffix that should be added to the prompt.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	58 :param show_default: shows or hides the default value in the prompt.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	59 :param err: if set to true the file defaults to ``stderr`` instead of
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	60 ``stdout``, the same as with echo.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	61 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	62 result = None
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	63
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	64 def prompt_func(text):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	65 f = hide_input and hidden_prompt_func or visible_prompt_func
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	66 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	67 # Write the prompt separately so that we get nice
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	68 # coloring through colorama on Windows
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	69 echo(text, nl=False, err=err)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	70 return f('')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	71 except (KeyboardInterrupt, EOFError):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	72 # getpass doesn't print a newline if the user aborts input with ^C.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	73 # Allegedly this behavior is inherited from getpass(3).
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	74 # A doc bug has been filed at https://bugs.python.org/issue24711
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	75 if hide_input:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	76 echo(None, err=err)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	77 raise Abort()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	78
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	79 if value_proc is None:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	80 value_proc = convert_type(type, default)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	81
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	82 prompt = _build_prompt(text, prompt_suffix, show_default, default)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	83
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	84 while 1:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	85 while 1:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	86 value = prompt_func(prompt)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	87 if value:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	88 break
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	89 # If a default is set and used, then the confirmation
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	90 # prompt is always skipped because that's the only thing
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	91 # that really makes sense.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	92 elif default is not None:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	93 return default
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	94 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	95 result = value_proc(value)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	96 except UsageError as e:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	97 echo('Error: %s' % e.message, err=err)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	98 continue
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	99 if not confirmation_prompt:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	100 return result
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	101 while 1:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	102 value2 = prompt_func('Repeat for confirmation: ')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	103 if value2:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	104 break
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	105 if value == value2:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	106 return result
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	107 echo('Error: the two entered values do not match', err=err)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	108
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	109
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	110 def confirm(text, default=False, abort=False, prompt_suffix=': ',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	111 show_default=True, err=False):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	112 """Prompts for confirmation (yes/no question).
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	113
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	114 If the user aborts the input by sending a interrupt signal this
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	115 function will catch it and raise a :exc:`Abort` exception.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	116
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	117 .. versionadded:: 4.0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	118 Added the `err` parameter.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	119
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	120 :param text: the question to ask.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	121 :param default: the default for the prompt.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	122 :param abort: if this is set to `True` a negative answer aborts the
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	123 exception by raising :exc:`Abort`.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	124 :param prompt_suffix: a suffix that should be added to the prompt.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	125 :param show_default: shows or hides the default value in the prompt.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	126 :param err: if set to true the file defaults to ``stderr`` instead of
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	127 ``stdout``, the same as with echo.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	128 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	129 prompt = _build_prompt(text, prompt_suffix, show_default,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	130 default and 'Y/n' or 'y/N')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	131 while 1:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	132 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	133 # Write the prompt separately so that we get nice
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	134 # coloring through colorama on Windows
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	135 echo(prompt, nl=False, err=err)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	136 value = visible_prompt_func('').lower().strip()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	137 except (KeyboardInterrupt, EOFError):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	138 raise Abort()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	139 if value in ('y', 'yes'):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	140 rv = True
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	141 elif value in ('n', 'no'):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	142 rv = False
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	143 elif value == '':
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	144 rv = default
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	145 else:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	146 echo('Error: invalid input', err=err)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	147 continue
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	148 break
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	149 if abort and not rv:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	150 raise Abort()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	151 return rv
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	152
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	153
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	154 def get_terminal_size():
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	155 """Returns the current size of the terminal as tuple in the form
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	156 ``(width, height)`` in columns and rows.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	157 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	158 # If shutil has get_terminal_size() (Python 3.3 and later) use that
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	159 if sys.version_info >= (3, 3):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	160 import shutil
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	161 shutil_get_terminal_size = getattr(shutil, 'get_terminal_size', None)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	162 if shutil_get_terminal_size:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	163 sz = shutil_get_terminal_size()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	164 return sz.columns, sz.lines
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	165
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	166 if get_winterm_size is not None:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	167 return get_winterm_size()
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	168
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	169 def ioctl_gwinsz(fd):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	170 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	171 import fcntl
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	172 import termios
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	173 cr = struct.unpack(
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	174 'hh', fcntl.ioctl(fd, termios.TIOCGWINSZ, '1234'))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	175 except Exception:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	176 return
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	177 return cr
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	178
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	179 cr = ioctl_gwinsz(0) or ioctl_gwinsz(1) or ioctl_gwinsz(2)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	180 if not cr:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	181 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	182 fd = os.open(os.ctermid(), os.O_RDONLY)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	183 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	184 cr = ioctl_gwinsz(fd)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	185 finally:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	186 os.close(fd)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	187 except Exception:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	188 pass
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	189 if not cr or not cr[0] or not cr[1]:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	190 cr = (os.environ.get('LINES', 25),
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	191 os.environ.get('COLUMNS', DEFAULT_COLUMNS))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	192 return int(cr[1]), int(cr[0])
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	193
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	194
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	195 def echo_via_pager(text, color=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	196 """This function takes a text and shows it via an environment specific
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	197 pager on stdout.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	198
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	199 .. versionchanged:: 3.0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	200 Added the `color` flag.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	201
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	202 :param text: the text to page.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	203 :param color: controls if the pager supports ANSI colors or not. The
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	204 default is autodetection.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	205 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	206 color = resolve_color_default(color)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	207 if not isinstance(text, string_types):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	208 text = text_type(text)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	209 from ._termui_impl import pager
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	210 return pager(text + '\n', color)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	211
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	212
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	213 def progressbar(iterable=None, length=None, label=None, show_eta=True,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	214 show_percent=None, show_pos=False,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	215 item_show_func=None, fill_char='#', empty_char='-',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	216 bar_template='%(label)s [%(bar)s] %(info)s',
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	217 info_sep=' ', width=36, file=None, color=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	218 """This function creates an iterable context manager that can be used
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	219 to iterate over something while showing a progress bar. It will
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	220 either iterate over the `iterable` or `length` items (that are counted
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	221 up). While iteration happens, this function will print a rendered
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	222 progress bar to the given `file` (defaults to stdout) and will attempt
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	223 to calculate remaining time and more. By default, this progress bar
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	224 will not be rendered if the file is not a terminal.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	225
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	226 The context manager creates the progress bar. When the context
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	227 manager is entered the progress bar is already displayed. With every
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	228 iteration over the progress bar, the iterable passed to the bar is
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	229 advanced and the bar is updated. When the context manager exits,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	230 a newline is printed and the progress bar is finalized on screen.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	231
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	232 No printing must happen or the progress bar will be unintentionally
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	233 destroyed.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	234
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	235 Example usage::
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	236
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	237 with progressbar(items) as bar:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	238 for item in bar:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	239 do_something_with(item)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	240
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	241 Alternatively, if no iterable is specified, one can manually update the
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	242 progress bar through the `update()` method instead of directly
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	243 iterating over the progress bar. The update method accepts the number
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	244 of steps to increment the bar with::
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	245
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	246 with progressbar(length=chunks.total_bytes) as bar:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	247 for chunk in chunks:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	248 process_chunk(chunk)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	249 bar.update(chunks.bytes)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	250
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	251 .. versionadded:: 2.0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	252
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	253 .. versionadded:: 4.0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	254 Added the `color` parameter. Added a `update` method to the
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	255 progressbar object.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	256
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	257 :param iterable: an iterable to iterate over. If not provided the length
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	258 is required.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	259 :param length: the number of items to iterate over. By default the
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	260 progressbar will attempt to ask the iterator about its
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	261 length, which might or might not work. If an iterable is
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	262 also provided this parameter can be used to override the
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	263 length. If an iterable is not provided the progress bar
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	264 will iterate over a range of that length.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	265 :param label: the label to show next to the progress bar.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	266 :param show_eta: enables or disables the estimated time display. This is
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	267 automatically disabled if the length cannot be
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	268 determined.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	269 :param show_percent: enables or disables the percentage display. The
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	270 default is `True` if the iterable has a length or
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	271 `False` if not.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	272 :param show_pos: enables or disables the absolute position display. The
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	273 default is `False`.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	274 :param item_show_func: a function called with the current item which
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	275 can return a string to show the current item
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	276 next to the progress bar. Note that the current
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	277 item can be `None`!
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	278 :param fill_char: the character to use to show the filled part of the
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	279 progress bar.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	280 :param empty_char: the character to use to show the non-filled part of
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	281 the progress bar.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	282 :param bar_template: the format string to use as template for the bar.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	283 The parameters in it are ``label`` for the label,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	284 ``bar`` for the progress bar and ``info`` for the
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	285 info section.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	286 :param info_sep: the separator between multiple info items (eta etc.)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	287 :param width: the width of the progress bar in characters, 0 means full
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	288 terminal width
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	289 :param file: the file to write to. If this is not a terminal then
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	290 only the label is printed.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	291 :param color: controls if the terminal supports ANSI colors or not. The
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	292 default is autodetection. This is only needed if ANSI
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	293 codes are included anywhere in the progress bar output
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	294 which is not the case by default.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	295 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	296 from ._termui_impl import ProgressBar
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	297 color = resolve_color_default(color)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	298 return ProgressBar(iterable=iterable, length=length, show_eta=show_eta,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	299 show_percent=show_percent, show_pos=show_pos,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	300 item_show_func=item_show_func, fill_char=fill_char,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	301 empty_char=empty_char, bar_template=bar_template,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	302 info_sep=info_sep, file=file, label=label,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	303 width=width, color=color)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	304
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	305
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	306 def clear():
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	307 """Clears the terminal screen. This will have the effect of clearing
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	308 the whole visible space of the terminal and moving the cursor to the
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	309 top left. This does not do anything if not connected to a terminal.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	310
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	311 .. versionadded:: 2.0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	312 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	313 if not isatty(sys.stdout):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	314 return
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	315 # If we're on Windows and we don't have colorama available, then we
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	316 # clear the screen by shelling out. Otherwise we can use an escape
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	317 # sequence.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	318 if WIN:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	319 os.system('cls')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	320 else:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	321 sys.stdout.write('\033[2J\033[1;1H')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	322
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	323
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	324 def style(text, fg=None, bg=None, bold=None, dim=None, underline=None,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	325 blink=None, reverse=None, reset=True):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	326 """Styles a text with ANSI styles and returns the new string. By
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	327 default the styling is self contained which means that at the end
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	328 of the string a reset code is issued. This can be prevented by
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	329 passing ``reset=False``.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	330
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	331 Examples::
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	332
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	333 click.echo(click.style('Hello World!', fg='green'))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	334 click.echo(click.style('ATTENTION!', blink=True))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	335 click.echo(click.style('Some things', reverse=True, fg='cyan'))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	336
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	337 Supported color names:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	338
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	339 * ``black`` (might be a gray)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	340 * ``red``
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	341 * ``green``
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	342 * ``yellow`` (might be an orange)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	343 * ``blue``
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	344 * ``magenta``
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	345 * ``cyan``
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	346 * ``white`` (might be light gray)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	347 * ``reset`` (reset the color code only)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	348
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	349 .. versionadded:: 2.0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	350
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	351 :param text: the string to style with ansi codes.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	352 :param fg: if provided this will become the foreground color.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	353 :param bg: if provided this will become the background color.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	354 :param bold: if provided this will enable or disable bold mode.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	355 :param dim: if provided this will enable or disable dim mode. This is
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	356 badly supported.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	357 :param underline: if provided this will enable or disable underline.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	358 :param blink: if provided this will enable or disable blinking.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	359 :param reverse: if provided this will enable or disable inverse
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	360 rendering (foreground becomes background and the
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	361 other way round).
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	362 :param reset: by default a reset-all code is added at the end of the
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	363 string which means that styles do not carry over. This
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	364 can be disabled to compose styles.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	365 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	366 bits = []
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	367 if fg:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	368 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	369 bits.append('\033[%dm' % (_ansi_colors.index(fg) + 30))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	370 except ValueError:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	371 raise TypeError('Unknown color %r' % fg)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	372 if bg:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	373 try:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	374 bits.append('\033[%dm' % (_ansi_colors.index(bg) + 40))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	375 except ValueError:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	376 raise TypeError('Unknown color %r' % bg)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	377 if bold is not None:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	378 bits.append('\033[%dm' % (1 if bold else 22))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	379 if dim is not None:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	380 bits.append('\033[%dm' % (2 if dim else 22))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	381 if underline is not None:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	382 bits.append('\033[%dm' % (4 if underline else 24))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	383 if blink is not None:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	384 bits.append('\033[%dm' % (5 if blink else 25))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	385 if reverse is not None:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	386 bits.append('\033[%dm' % (7 if reverse else 27))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	387 bits.append(text)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	388 if reset:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	389 bits.append(_ansi_reset_all)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	390 return ''.join(bits)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	391
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	392
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	393 def unstyle(text):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	394 """Removes ANSI styling information from a string. Usually it's not
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	395 necessary to use this function as Click's echo function will
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	396 automatically remove styling if necessary.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	397
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	398 .. versionadded:: 2.0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	399
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	400 :param text: the text to remove style information from.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	401 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	402 return strip_ansi(text)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	403
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	404
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	405 def secho(text, file=None, nl=True, err=False, color=None, **styles):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	406 """This function combines :func:`echo` and :func:`style` into one
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	407 call. As such the following two calls are the same::
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	408
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	409 click.secho('Hello World!', fg='green')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	410 click.echo(click.style('Hello World!', fg='green'))
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	411
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	412 All keyword arguments are forwarded to the underlying functions
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	413 depending on which one they go with.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	414
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	415 .. versionadded:: 2.0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	416 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	417 return echo(style(text, **styles), file=file, nl=nl, err=err, color=color)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	418
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	419
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	420 def edit(text=None, editor=None, env=None, require_save=True,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	421 extension='.txt', filename=None):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	422 r"""Edits the given text in the defined editor. If an editor is given
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	423 (should be the full path to the executable but the regular operating
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	424 system search path is used for finding the executable) it overrides
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	425 the detected editor. Optionally, some environment variables can be
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	426 used. If the editor is closed without changes, `None` is returned. In
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	427 case a file is edited directly the return value is always `None` and
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	428 `require_save` and `extension` are ignored.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	429
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	430 If the editor cannot be opened a :exc:`UsageError` is raised.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	431
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	432 Note for Windows: to simplify cross-platform usage, the newlines are
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	433 automatically converted from POSIX to Windows and vice versa. As such,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	434 the message here will have ``\n`` as newline markers.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	435
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	436 :param text: the text to edit.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	437 :param editor: optionally the editor to use. Defaults to automatic
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	438 detection.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	439 :param env: environment variables to forward to the editor.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	440 :param require_save: if this is true, then not saving in the editor
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	441 will make the return value become `None`.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	442 :param extension: the extension to tell the editor about. This defaults
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	443 to `.txt` but changing this might change syntax
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	444 highlighting.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	445 :param filename: if provided it will edit this file instead of the
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	446 provided text contents. It will not use a temporary
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	447 file as an indirection in that case.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	448 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	449 from ._termui_impl import Editor
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	450 editor = Editor(editor=editor, env=env, require_save=require_save,
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	451 extension=extension)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	452 if filename is None:
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	453 return editor.edit(text)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	454 editor.edit_file(filename)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	455
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	456
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	457 def launch(url, wait=False, locate=False):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	458 """This function launches the given URL (or filename) in the default
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	459 viewer application for this file type. If this is an executable, it
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	460 might launch the executable in a new session. The return value is
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	461 the exit code of the launched application. Usually, ``0`` indicates
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	462 success.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	463
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	464 Examples::
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	465
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	466 click.launch('http://click.pocoo.org/')
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	467 click.launch('/my/downloaded/file', locate=True)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	468
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	469 .. versionadded:: 2.0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	470
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	471 :param url: URL or filename of the thing to launch.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	472 :param wait: waits for the program to stop.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	473 :param locate: if this is set to `True` then instead of launching the
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	474 application associated with the URL it will attempt to
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	475 launch a file manager with the file located. This
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	476 might have weird effects if the URL does not point to
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	477 the filesystem.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	478 """
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	479 from ._termui_impl import open_url
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	480 return open_url(url, wait=wait, locate=locate)
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	481
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	482
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	483 # If this is provided, getchar() calls into this instead. This is used
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	484 # for unittesting purposes.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	485 _getchar = None
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	486
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	487
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	488 def getchar(echo=False):
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	489 """Fetches a single character from the terminal and returns it. This
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	490 will always return a unicode character and under certain rare
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	491 circumstances this might return more than one character. The
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	492 situations which more than one character is returned is when for
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	493 whatever reason multiple characters end up in the terminal buffer or
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	494 standard input was not actually a terminal.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	495
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	496 Note that this will always read from the terminal, even if something
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	497 is piped into the standard input.
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	498
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	499 .. versionadded:: 2.0
d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b bcclaywell parents: diff changeset	500

0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

1 import os

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

2 import sys

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

3 import struct

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

4

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

5 from ._compat import raw_input, text_type, string_types, \

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

6 isatty, strip_ansi, get_winterm_size, DEFAULT_COLUMNS, WIN

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

7 from .utils import echo

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

8 from .exceptions import Abort, UsageError

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

9 from .types import convert_type

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

10 from .globals import resolve_color_default

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

11

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

12

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

13 # The prompt functions to use. The doc tools currently override these

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

14 # functions to customize how they work.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

15 visible_prompt_func = raw_input

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

16

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

17 _ansi_colors = ('black', 'red', 'green', 'yellow', 'blue', 'magenta',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

18 'cyan', 'white', 'reset')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

19 _ansi_reset_all = '\033[0m'

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

20

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

21

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

22 def hidden_prompt_func(prompt):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

23 import getpass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

24 return getpass.getpass(prompt)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

25

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

26

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

27 def _build_prompt(text, suffix, show_default=False, default=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

28 prompt = text

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

29 if default is not None and show_default:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

30 prompt = '%s [%s]' % (prompt, default)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

31 return prompt + suffix

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

32

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

33

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

34 def prompt(text, default=None, hide_input=False,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

35 confirmation_prompt=False, type=None,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

36 value_proc=None, prompt_suffix=': ',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

37 show_default=True, err=False):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

38 """Prompts a user for input. This is a convenience function that can

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

39 be used to prompt a user for input later.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

40

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

41 If the user aborts the input by sending a interrupt signal, this

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

42 function will catch it and raise a :exc:`Abort` exception.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

43

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

44 .. versionadded:: 4.0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

45 Added the `err` parameter.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

46

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

47 :param text: the text to show for the prompt.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

48 :param default: the default value to use if no input happens. If this

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

49 is not given it will prompt until it's aborted.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

50 :param hide_input: if this is set to true then the input value will

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

51 be hidden.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

52 :param confirmation_prompt: asks for confirmation for the value.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

53 :param type: the type to use to check the value against.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

54 :param value_proc: if this parameter is provided it's a function that

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

55 is invoked instead of the type conversion to

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

56 convert a value.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

57 :param prompt_suffix: a suffix that should be added to the prompt.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

58 :param show_default: shows or hides the default value in the prompt.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

59 :param err: if set to true the file defaults to ``stderr`` instead of

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

60 ``stdout``, the same as with echo.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

61 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

62 result = None

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

63

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

64 def prompt_func(text):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

65 f = hide_input and hidden_prompt_func or visible_prompt_func

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

66 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

67 # Write the prompt separately so that we get nice

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

68 # coloring through colorama on Windows

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

69 echo(text, nl=False, err=err)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

70 return f('')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

71 except (KeyboardInterrupt, EOFError):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

72 # getpass doesn't print a newline if the user aborts input with ^C.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

73 # Allegedly this behavior is inherited from getpass(3).

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

74 # A doc bug has been filed at https://bugs.python.org/issue24711

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

75 if hide_input:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

76 echo(None, err=err)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

77 raise Abort()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

78

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

79 if value_proc is None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

80 value_proc = convert_type(type, default)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

81

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

82 prompt = _build_prompt(text, prompt_suffix, show_default, default)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

83

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

84 while 1:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

85 while 1:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

86 value = prompt_func(prompt)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

87 if value:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

88 break

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

89 # If a default is set and used, then the confirmation

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

90 # prompt is always skipped because that's the only thing

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

91 # that really makes sense.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

92 elif default is not None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

93 return default

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

94 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

95 result = value_proc(value)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

96 except UsageError as e:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

97 echo('Error: %s' % e.message, err=err)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

98 continue

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

99 if not confirmation_prompt:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

100 return result

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

101 while 1:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

102 value2 = prompt_func('Repeat for confirmation: ')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

103 if value2:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

104 break

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

105 if value == value2:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

106 return result

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

107 echo('Error: the two entered values do not match', err=err)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

108

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

109

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

110 def confirm(text, default=False, abort=False, prompt_suffix=': ',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

111 show_default=True, err=False):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

112 """Prompts for confirmation (yes/no question).

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

113

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

114 If the user aborts the input by sending a interrupt signal this

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

115 function will catch it and raise a :exc:`Abort` exception.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

116

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

117 .. versionadded:: 4.0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

118 Added the `err` parameter.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

119

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

120 :param text: the question to ask.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

121 :param default: the default for the prompt.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

122 :param abort: if this is set to `True` a negative answer aborts the

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

123 exception by raising :exc:`Abort`.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

124 :param prompt_suffix: a suffix that should be added to the prompt.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

125 :param show_default: shows or hides the default value in the prompt.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

126 :param err: if set to true the file defaults to ``stderr`` instead of

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

127 ``stdout``, the same as with echo.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

128 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

129 prompt = _build_prompt(text, prompt_suffix, show_default,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

130 default and 'Y/n' or 'y/N')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

131 while 1:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

132 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

133 # Write the prompt separately so that we get nice

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

134 # coloring through colorama on Windows

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

135 echo(prompt, nl=False, err=err)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

136 value = visible_prompt_func('').lower().strip()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

137 except (KeyboardInterrupt, EOFError):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

138 raise Abort()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

139 if value in ('y', 'yes'):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

140 rv = True

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

141 elif value in ('n', 'no'):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

142 rv = False

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

143 elif value == '':

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

144 rv = default

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

145 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

146 echo('Error: invalid input', err=err)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

147 continue

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

148 break

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

149 if abort and not rv:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

150 raise Abort()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

151 return rv

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

152

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

153

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

154 def get_terminal_size():

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

155 """Returns the current size of the terminal as tuple in the form

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

156 ``(width, height)`` in columns and rows.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

157 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

158 # If shutil has get_terminal_size() (Python 3.3 and later) use that

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

159 if sys.version_info >= (3, 3):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

160 import shutil

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

161 shutil_get_terminal_size = getattr(shutil, 'get_terminal_size', None)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

162 if shutil_get_terminal_size:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

163 sz = shutil_get_terminal_size()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

164 return sz.columns, sz.lines

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

165

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

166 if get_winterm_size is not None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

167 return get_winterm_size()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

168

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

169 def ioctl_gwinsz(fd):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

170 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

171 import fcntl

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

172 import termios

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

173 cr = struct.unpack(

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

174 'hh', fcntl.ioctl(fd, termios.TIOCGWINSZ, '1234'))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

175 except Exception:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

176 return

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

177 return cr

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

178

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

179 cr = ioctl_gwinsz(0) or ioctl_gwinsz(1) or ioctl_gwinsz(2)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

180 if not cr:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

181 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

182 fd = os.open(os.ctermid(), os.O_RDONLY)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

183 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

184 cr = ioctl_gwinsz(fd)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

185 finally:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

186 os.close(fd)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

187 except Exception:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

188 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

189 if not cr or not cr[0] or not cr[1]:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

190 cr = (os.environ.get('LINES', 25),

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

191 os.environ.get('COLUMNS', DEFAULT_COLUMNS))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

192 return int(cr[1]), int(cr[0])

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

193

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

194

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

195 def echo_via_pager(text, color=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

196 """This function takes a text and shows it via an environment specific

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

197 pager on stdout.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

198

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

199 .. versionchanged:: 3.0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

200 Added the `color` flag.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

201

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

202 :param text: the text to page.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

203 :param color: controls if the pager supports ANSI colors or not. The

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

204 default is autodetection.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

205 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

206 color = resolve_color_default(color)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

207 if not isinstance(text, string_types):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

208 text = text_type(text)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

209 from ._termui_impl import pager

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

210 return pager(text + '\n', color)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

211

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

212

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

213 def progressbar(iterable=None, length=None, label=None, show_eta=True,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

214 show_percent=None, show_pos=False,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

215 item_show_func=None, fill_char='#', empty_char='-',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

216 bar_template='%(label)s [%(bar)s] %(info)s',

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

217 info_sep=' ', width=36, file=None, color=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

218 """This function creates an iterable context manager that can be used

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

219 to iterate over something while showing a progress bar. It will

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

220 either iterate over the `iterable` or `length` items (that are counted

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

221 up). While iteration happens, this function will print a rendered

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

222 progress bar to the given `file` (defaults to stdout) and will attempt

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

223 to calculate remaining time and more. By default, this progress bar

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

224 will not be rendered if the file is not a terminal.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

225

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

226 The context manager creates the progress bar. When the context

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

227 manager is entered the progress bar is already displayed. With every

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

228 iteration over the progress bar, the iterable passed to the bar is

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

229 advanced and the bar is updated. When the context manager exits,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

230 a newline is printed and the progress bar is finalized on screen.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

231

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

232 No printing must happen or the progress bar will be unintentionally

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

233 destroyed.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

234

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

235 Example usage::

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

236

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

237 with progressbar(items) as bar:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

238 for item in bar:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

239 do_something_with(item)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

240

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

241 Alternatively, if no iterable is specified, one can manually update the

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

242 progress bar through the `update()` method instead of directly

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

243 iterating over the progress bar. The update method accepts the number

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

244 of steps to increment the bar with::

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

245

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

246 with progressbar(length=chunks.total_bytes) as bar:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

247 for chunk in chunks:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

248 process_chunk(chunk)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

249 bar.update(chunks.bytes)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

250

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

251 .. versionadded:: 2.0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

252

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

253 .. versionadded:: 4.0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

254 Added the `color` parameter. Added a `update` method to the

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

255 progressbar object.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

256

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

257 :param iterable: an iterable to iterate over. If not provided the length

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

258 is required.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

259 :param length: the number of items to iterate over. By default the

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

260 progressbar will attempt to ask the iterator about its

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

261 length, which might or might not work. If an iterable is

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

262 also provided this parameter can be used to override the

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

263 length. If an iterable is not provided the progress bar

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

264 will iterate over a range of that length.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

265 :param label: the label to show next to the progress bar.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

266 :param show_eta: enables or disables the estimated time display. This is

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

267 automatically disabled if the length cannot be

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

268 determined.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

269 :param show_percent: enables or disables the percentage display. The

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

270 default is `True` if the iterable has a length or

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

271 `False` if not.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

272 :param show_pos: enables or disables the absolute position display. The

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

273 default is `False`.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

274 :param item_show_func: a function called with the current item which

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

275 can return a string to show the current item

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

276 next to the progress bar. Note that the current

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

277 item can be `None`!

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

278 :param fill_char: the character to use to show the filled part of the

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

279 progress bar.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

280 :param empty_char: the character to use to show the non-filled part of

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

281 the progress bar.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

282 :param bar_template: the format string to use as template for the bar.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

283 The parameters in it are ``label`` for the label,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

284 ``bar`` for the progress bar and ``info`` for the

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

285 info section.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

286 :param info_sep: the separator between multiple info items (eta etc.)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

287 :param width: the width of the progress bar in characters, 0 means full

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

288 terminal width

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

289 :param file: the file to write to. If this is not a terminal then

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

290 only the label is printed.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

291 :param color: controls if the terminal supports ANSI colors or not. The

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

292 default is autodetection. This is only needed if ANSI

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

293 codes are included anywhere in the progress bar output

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

294 which is not the case by default.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

295 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

296 from ._termui_impl import ProgressBar

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

297 color = resolve_color_default(color)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

298 return ProgressBar(iterable=iterable, length=length, show_eta=show_eta,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

299 show_percent=show_percent, show_pos=show_pos,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

300 item_show_func=item_show_func, fill_char=fill_char,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

301 empty_char=empty_char, bar_template=bar_template,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

302 info_sep=info_sep, file=file, label=label,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

303 width=width, color=color)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

304

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

305

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

306 def clear():

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

307 """Clears the terminal screen. This will have the effect of clearing

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

308 the whole visible space of the terminal and moving the cursor to the

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

309 top left. This does not do anything if not connected to a terminal.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

310

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

311 .. versionadded:: 2.0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

312 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

313 if not isatty(sys.stdout):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

314 return

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

315 # If we're on Windows and we don't have colorama available, then we

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

316 # clear the screen by shelling out. Otherwise we can use an escape

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

317 # sequence.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

318 if WIN:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

319 os.system('cls')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

320 else:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

321 sys.stdout.write('\033[2J\033[1;1H')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

322

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

323

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

324 def style(text, fg=None, bg=None, bold=None, dim=None, underline=None,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

325 blink=None, reverse=None, reset=True):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

326 """Styles a text with ANSI styles and returns the new string. By

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

327 default the styling is self contained which means that at the end

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

328 of the string a reset code is issued. This can be prevented by

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

329 passing ``reset=False``.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

330

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

331 Examples::

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

332

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

333 click.echo(click.style('Hello World!', fg='green'))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

334 click.echo(click.style('ATTENTION!', blink=True))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

335 click.echo(click.style('Some things', reverse=True, fg='cyan'))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

336

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

337 Supported color names:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

338

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

339 * ``black`` (might be a gray)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

340 * ``red``

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

341 * ``green``

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

342 * ``yellow`` (might be an orange)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

343 * ``blue``

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

344 * ``magenta``

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

345 * ``cyan``

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

346 * ``white`` (might be light gray)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

347 * ``reset`` (reset the color code only)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

348

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

349 .. versionadded:: 2.0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

350

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

351 :param text: the string to style with ansi codes.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

352 :param fg: if provided this will become the foreground color.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

353 :param bg: if provided this will become the background color.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

354 :param bold: if provided this will enable or disable bold mode.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

355 :param dim: if provided this will enable or disable dim mode. This is

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

356 badly supported.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

357 :param underline: if provided this will enable or disable underline.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

358 :param blink: if provided this will enable or disable blinking.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

359 :param reverse: if provided this will enable or disable inverse

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

360 rendering (foreground becomes background and the

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

361 other way round).

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

362 :param reset: by default a reset-all code is added at the end of the

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

363 string which means that styles do not carry over. This

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

364 can be disabled to compose styles.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

365 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

366 bits = []

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

367 if fg:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

368 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

369 bits.append('\033[%dm' % (_ansi_colors.index(fg) + 30))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

370 except ValueError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

371 raise TypeError('Unknown color %r' % fg)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

372 if bg:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

373 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

374 bits.append('\033[%dm' % (_ansi_colors.index(bg) + 40))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

375 except ValueError:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

376 raise TypeError('Unknown color %r' % bg)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

377 if bold is not None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

378 bits.append('\033[%dm' % (1 if bold else 22))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

379 if dim is not None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

380 bits.append('\033[%dm' % (2 if dim else 22))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

381 if underline is not None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

382 bits.append('\033[%dm' % (4 if underline else 24))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

383 if blink is not None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

384 bits.append('\033[%dm' % (5 if blink else 25))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

385 if reverse is not None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

386 bits.append('\033[%dm' % (7 if reverse else 27))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

387 bits.append(text)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

388 if reset:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

389 bits.append(_ansi_reset_all)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

390 return ''.join(bits)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

391

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

392

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

393 def unstyle(text):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

394 """Removes ANSI styling information from a string. Usually it's not

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

395 necessary to use this function as Click's echo function will

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

396 automatically remove styling if necessary.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

397

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

398 .. versionadded:: 2.0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

399

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

400 :param text: the text to remove style information from.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

401 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

402 return strip_ansi(text)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

403

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

404

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

405 def secho(text, file=None, nl=True, err=False, color=None, **styles):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

406 """This function combines :func:`echo` and :func:`style` into one

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

407 call. As such the following two calls are the same::

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

408

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

409 click.secho('Hello World!', fg='green')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

410 click.echo(click.style('Hello World!', fg='green'))

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

411

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

412 All keyword arguments are forwarded to the underlying functions

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

413 depending on which one they go with.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

414

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

415 .. versionadded:: 2.0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

416 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

417 return echo(style(text, **styles), file=file, nl=nl, err=err, color=color)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

418

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

419

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

420 def edit(text=None, editor=None, env=None, require_save=True,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

421 extension='.txt', filename=None):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

422 r"""Edits the given text in the defined editor. If an editor is given

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

423 (should be the full path to the executable but the regular operating

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

424 system search path is used for finding the executable) it overrides

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

425 the detected editor. Optionally, some environment variables can be

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

426 used. If the editor is closed without changes, `None` is returned. In

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

427 case a file is edited directly the return value is always `None` and

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

428 `require_save` and `extension` are ignored.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

429

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

430 If the editor cannot be opened a :exc:`UsageError` is raised.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

431

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

432 Note for Windows: to simplify cross-platform usage, the newlines are

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

433 automatically converted from POSIX to Windows and vice versa. As such,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

434 the message here will have ``\n`` as newline markers.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

435

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

436 :param text: the text to edit.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

437 :param editor: optionally the editor to use. Defaults to automatic

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

438 detection.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

439 :param env: environment variables to forward to the editor.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

440 :param require_save: if this is true, then not saving in the editor

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

441 will make the return value become `None`.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

442 :param extension: the extension to tell the editor about. This defaults

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

443 to `.txt` but changing this might change syntax

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

444 highlighting.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

445 :param filename: if provided it will edit this file instead of the

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

446 provided text contents. It will not use a temporary

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

447 file as an indirection in that case.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

448 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

449 from ._termui_impl import Editor

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

450 editor = Editor(editor=editor, env=env, require_save=require_save,

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

451 extension=extension)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

452 if filename is None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

453 return editor.edit(text)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

454 editor.edit_file(filename)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

455

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

456

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

457 def launch(url, wait=False, locate=False):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

458 """This function launches the given URL (or filename) in the default

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

459 viewer application for this file type. If this is an executable, it

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

460 might launch the executable in a new session. The return value is

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

461 the exit code of the launched application. Usually, ``0`` indicates

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

462 success.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

463

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

464 Examples::

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

465

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

466 click.launch('http://click.pocoo.org/')

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

467 click.launch('/my/downloaded/file', locate=True)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

468

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

469 .. versionadded:: 2.0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

470

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

471 :param url: URL or filename of the thing to launch.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

472 :param wait: waits for the program to stop.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

473 :param locate: if this is set to `True` then instead of launching the

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

474 application associated with the URL it will attempt to

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

475 launch a file manager with the file located. This

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

476 might have weird effects if the URL does not point to

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

477 the filesystem.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

478 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

479 from ._termui_impl import open_url

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

480 return open_url(url, wait=wait, locate=locate)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

481

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

482

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

483 # If this is provided, getchar() calls into this instead. This is used

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

484 # for unittesting purposes.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

485 _getchar = None

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

486

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

487

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

488 def getchar(echo=False):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

489 """Fetches a single character from the terminal and returns it. This

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

490 will always return a unicode character and under certain rare

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

491 circumstances this might return more than one character. The

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

492 situations which more than one character is returned is when for

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

493 whatever reason multiple characters end up in the terminal buffer or

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

494 standard input was not actually a terminal.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

495

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

496 Note that this will always read from the terminal, even if something

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

497 is piped into the standard input.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

498

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

499 .. versionadded:: 2.0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

500

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

501 :param echo: if set to `True`, the character read will also show up on

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

502 the terminal. The default is to not show it.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

503 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

504 f = _getchar

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

505 if f is None:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

506 from ._termui_impl import getchar as f

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

507 return f(echo)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

508

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

509

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

510 def pause(info='Press any key to continue ...', err=False):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

511 """This command stops execution and waits for the user to press any

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

512 key to continue. This is similar to the Windows batch "pause"

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

513 command. If the program is not run through a terminal, this command

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

514 will instead do nothing.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

515

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

516 .. versionadded:: 2.0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

517

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

518 .. versionadded:: 4.0

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

519 Added the `err` parameter.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

520

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

521 :param info: the info string to print before pausing.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

522 :param err: if set to message goes to ``stderr`` instead of

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

523 ``stdout``, the same as with echo.

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

524 """

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

525 if not isatty(sys.stdin) or not isatty(sys.stdout):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

526 return

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

527 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

528 if info:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

529 echo(info, nl=False, err=err)

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

530 try:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

531 getchar()

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

532 except (KeyboardInterrupt, EOFError):

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

533 pass

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

534 finally:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

535 if info:

d67268158946 planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b

bcclaywell

parents:

diff changeset

536 echo(err=err)

Mercurial > repos > bcclaywell > argo_navis

annotate venv/lib/python2.7/site-packages/click/termui.py @ 0:d67268158946 draft