click._compat._AtomicFile
- Undocumentedclick._compat._FixupStream
- The new io interface needs more from streams than streams traditionally implement. As such, this fix-up code is necessary in some circumstances.click._termui_impl.Editor
- Undocumentedclick._winconsole.ConsoleStream
- Undocumentedclick.core.BaseCommand
- The base command implements the minimal API contract of commands. Most code will never use this as it does not implement a lot of useful functionality but it can act as the direct subclass of alternative parsing methods that do not depend on the Click parser.click.core.Command
- Commands are the basic building block of command line interfaces in Click. A basic command handles command line parsing and might dispatch more parsing to commands nested below it.click.core.MultiCommand
- A multi command is the basic implementation of a command that dispatches to subcommands. The most common version is the :class:`Group`.click.core.CommandCollection
- A command collection is a multi command that merges multiple multi commands together into one. This is a straightforward implementation that accepts a list of different multi commands as sources and provides all the commands for each of them.click.core.Group
- A group allows a command to have subcommands attached. This is the most common way to implement nesting in Click.click.core.Context
- The context is a special internal object that holds state relevant for the script execution at every single level. It's normally invisible to commands unless they opt-in to getting access to it.click.core.Parameter
- A parameter to a command comes in two versions: they are either :class:`Option`\s or :class:`Argument`\s. Other subclasses are currently not supported by design as some of the internals for parsing are intentionally not finalized.click.core.Argument
- Arguments are positional parameters to a command. They generally provide fewer features than options but can have infinite ``nargs`` and are required by default.click.core.Option
- Options are usually optional values on the command line and have some extra features that arguments don't have.click.formatting.HelpFormatter
- This class helps with formatting text-based help pages. It's usually just needed for very special internal cases, but it's also exposed so that developers can write their own fancy outputs.click.parser.Argument
- Undocumentedclick.parser.Option
- Undocumentedclick.parser.OptionParser
- The option parser is an internal class that is ultimately used to parse options and arguments. It's modelled after optparse and brings a similar but vastly simplified API. It should generally not be used directly as the high level Click classes wrap it for you.click.parser.ParsingState
- Undocumentedclick.shell_completion.CompletionItem
- Represents a completion value and metadata about the value. The default metadata is ``type`` to indicate special shell handling, and ``help`` if a shell supports showing a help string next to the value.click.shell_completion.ShellComplete
- Base class for providing shell completion support. A subclass for a given shell will override attributes and methods to implement the completion instructions (``source`` and ``complete``).click.shell_completion.BashComplete
- Shell completion for Bash.click.shell_completion.FishComplete
- Shell completion for Fish.click.shell_completion.ZshComplete
- Shell completion for Zsh.click.testing.CliRunner
- The CLI runner provides functionality to invoke a Click command line script for unittesting purposes in a isolated environment. This only works in single-threaded systems without any concurrency as it changes the global interpreter state.click.testing.EchoingStdin
- Undocumentedclick.testing.Result
- Holds the captured result of an invoked CLI script.click.types.ParamType
- Represents the type of a parameter. Validates and converts values from the command line or Python into the correct type.click.types._NumberParamTypeBase
- Undocumentedclick.types._NumberRangeBase
- No class docstring; 0/5 instance variable, 2/6 methods documentedclick.types.FloatRange
- Restrict a :data:`click.FLOAT` value to a range of accepted values. See :ref:`ranges`.click.types.IntRange
- Restrict an :data:`click.INT` value to a range of accepted values. See :ref:`ranges`.click.types.FloatParamType
- Undocumentedclick.types.FloatRange
- Restrict a :data:`click.FLOAT` value to a range of accepted values. See :ref:`ranges`.click.types.IntParamType
- Undocumentedclick.types.IntRange
- Restrict an :data:`click.INT` value to a range of accepted values. See :ref:`ranges`.click.types.BoolParamType
- Undocumentedclick.types.Choice
- The choice type allows a value to be checked against a fixed set of supported values. All of these values have to be strings.click.types.CompositeParamType
- Undocumentedclick.types.Tuple
- The default behavior of Click is to apply a type on a value directly. This works well in most cases, except for when `nargs` is set to a fixed count and different types should be used for different items...click.types.DateTime
- The DateTime type converts date strings into `datetime` objects.click.types.File
- Declares a parameter to be a file for reading or writing. The file is automatically closed once the context tears down (after the command finished working).click.types.FuncParamType
- Undocumentedclick.types.Path
- The ``Path`` type is similar to the :class:`File` type, but returns the filename instead of an open file. Various checks can be enabled to validate the type of file and permissions.click.types.StringParamType
- Undocumentedclick.types.UnprocessedParamType
- Undocumentedclick.types.UUIDParameterType
- Undocumentedclick.utils.KeepOpenFile
- Undocumentedclick.utils.LazyFile
- A lazy file works like a regular file but it does not fully open the file but it does perform some basic checks early to see if the filename parameter does make sense. This is useful for safely opening files for writing.click.utils.PacifyFlushWrapper
- This wrapper is used to catch and suppress BrokenPipeErrors resulting from ``.flush()`` being called on broken pipe during the shutdown/final-GC of the Python interpreter. Notably ``.flush()`` is always called on ``sys...ctypes.Structure
click._winconsole.Py_buffer
- Undocumentedenum.Enum
click.core.ParameterSource
- This is an :class:`~enum.Enum` that indicates the source of a parameter's value.Exception
click.exceptions.ClickException
- An exception that Click can handle and show to the user.click.exceptions.FileError
- Raised if a file cannot be opened.click.exceptions.UsageError
- An internal exception that signals a usage error. This typically aborts any further handling.click.exceptions.BadArgumentUsage
- Raised if an argument is generally supplied but the use of the argument was incorrect. This is for instance raised if the number of values for an argument is not correct.click.exceptions.BadOptionUsage
- Raised if an option is generally supplied but the use of the option was incorrect. This is for instance raised if the number of arguments for an option is not correct.click.exceptions.BadParameter
- An exception that formats out a standardized error message for a bad parameter. This is useful when thrown from a callback or type as Click will attach contextual information to it (for instance, which parameter it is).click.exceptions.MissingParameter
- Raised if click required an option or argument but it was not provided when invoking the script.click.exceptions.NoSuchOption
- Raised if click attempted to handle an option that does not exist.io.RawIOBase
click._winconsole._WindowsConsoleRawIOBase
- Undocumentedclick._winconsole._WindowsConsoleReader
- Undocumentedclick._winconsole._WindowsConsoleWriter
- Undocumentedio.TextIOWrapper
click._compat._NonClosingTextIOWrapper
- Undocumentedclick.testing._NamedTextIOWrapper
- UndocumentedRuntimeError
click.exceptions.Abort
- An internal signalling exception that signals Click to abort.click.exceptions.Exit
- An exception that indicates that the application should exit with some status code.textwrap.TextWrapper
click._textwrap.TextWrapper
- Undocumentedtyping.Generic[V]
click._termui_impl.ProgressBar
- No class docstring; 0/3 property, 0/28 instance variable, 2/16 methods documented