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

planemo upload commit a3f181f5f126803c654b3a66dd4e83a48f7e203b
author bcclaywell
date Mon, 12 Oct 2015 17:43:33 -0400
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:d67268158946
1 # -*- coding: utf-8 -*-
2 """
3 click
4 ~~~~~
5
6 Click is a simple Python module that wraps the stdlib's optparse to make
7 writing command line scripts fun. Unlike other modules, it's based around
8 a simple API that does not come with too much magic and is composable.
9
10 In case optparse ever gets removed from the stdlib, it will be shipped by
11 this module.
12
13 :copyright: (c) 2014 by Armin Ronacher.
14 :license: BSD, see LICENSE for more details.
15 """
16
17 # Core classes
18 from .core import Context, BaseCommand, Command, MultiCommand, Group, \
19 CommandCollection, Parameter, Option, Argument
20
21 # Globals
22 from .globals import get_current_context
23
24 # Decorators
25 from .decorators import pass_context, pass_obj, make_pass_decorator, \
26 command, group, argument, option, confirmation_option, \
27 password_option, version_option, help_option
28
29 # Types
30 from .types import ParamType, File, Path, Choice, IntRange, Tuple, \
31 STRING, INT, FLOAT, BOOL, UUID, UNPROCESSED
32
33 # Utilities
34 from .utils import echo, get_binary_stream, get_text_stream, open_file, \
35 format_filename, get_app_dir
36
37 # Terminal functions
38 from .termui import prompt, confirm, get_terminal_size, echo_via_pager, \
39 progressbar, clear, style, unstyle, secho, edit, launch, getchar, \
40 pause
41
42 # Exceptions
43 from .exceptions import ClickException, UsageError, BadParameter, \
44 FileError, Abort, NoSuchOption, BadOptionUsage, MissingParameter
45
46 # Formatting
47 from .formatting import HelpFormatter, wrap_text
48
49 # Parsing
50 from .parser import OptionParser
51
52
53 __all__ = [
54 # Core classes
55 'Context', 'BaseCommand', 'Command', 'MultiCommand', 'Group',
56 'CommandCollection', 'Parameter', 'Option', 'Argument',
57
58 # Globals
59 'get_current_context',
60
61 # Decorators
62 'pass_context', 'pass_obj', 'make_pass_decorator', 'command', 'group',
63 'argument', 'option', 'confirmation_option', 'password_option',
64 'version_option', 'help_option',
65
66 # Types
67 'ParamType', 'File', 'Path', 'Choice', 'IntRange', 'Tuple', 'STRING',
68 'INT', 'FLOAT', 'BOOL', 'UUID', 'UNPROCESSED',
69
70 # Utilities
71 'echo', 'get_binary_stream', 'get_text_stream', 'open_file',
72 'format_filename', 'get_app_dir',
73
74 # Terminal functions
75 'prompt', 'confirm', 'get_terminal_size', 'echo_via_pager',
76 'progressbar', 'clear', 'style', 'unstyle', 'secho', 'edit', 'launch',
77 'getchar', 'pause',
78
79 # Exceptions
80 'ClickException', 'UsageError', 'BadParameter', 'FileError',
81 'Abort', 'NoSuchOption', 'BadOptionUsage', 'MissingParameter',
82
83 # Formatting
84 'HelpFormatter', 'wrap_text',
85
86 # Parsing
87 'OptionParser',
88 ]
89
90
91 # Controls if click should emit the warning about the use of unicode
92 # literals.
93 disable_unicode_literals_warning = False
94
95
96 __version__ = '5.1'