Byĭefault Click will remove color if the output does not look likeĬhanged in version 3.0: Added the color flag. Enabled by default.Ĭolor ( Optional ) – Force showing or hiding colors and other styles. Nl ( bool) – Print a newline after the message. Defaults to stdout.Įrr ( bool) – Write to stderr instead of stdout. Other objects areįile ( Optional ]) – The file to write to.
Message ( Optional ) – The string or bytes to output. Removes ANSI color and style codes if the output does not look Supports writing to binary outputs, and supports writing bytes Used instead of print() because it provides better supportįor different data, files, and environments.Ĭompared to print(), this does the following:Įnsures that the output encoding is not misconfigured on Linux. Print a message and newline to stdout or a file. echo ( message = None, file = None, nl = True, err = False, color = None ) ¶ This generates a decorator that works roughly like this: Similar to pass_obj() but instead of passing the object of theĬurrent context, it will find the innermost context of type Given an object type this creates a decorator that will work make_pass_decorator ( object_type, ensure = False ) ¶ Similar to pass_context(), but only pass the object on theĬontext onwards ( Context.obj). Marks a callback as wanting to receive the current contextĬ click. This is usually unnecessary, as the -help option is added toĮach command automatically unless add_help_option=False isĬallable, ] click. help_option ( * param_decls, ** kwargs ) ¶Īdd a -help option which immediately prints the help page Package name, or be passed with package_name=. The Python package name must match the installed Version is detected based on the package name, not the entry Return typeĬallable, ] ChangelogĬhanged in version 8.0: Use tadata instead of pkg_resources. RuntimeError – version could not be detected. %(package)s, and %(version)s are available. Message ( Optional ) – The message to show. Provided, it will be detected from the command. Prog_name ( Optional ) – The name of the CLI to show in the message. Not provided, Click will try to detect it. Package_name ( Optional ) – The package name to detect the version from. Version ( Optional ) – The version number to show. Version, so it must match the name of the installed package. If package_name is not provided, Click will try to detect it by If version is not provided, Click will try to detect it using version_option ( version = None, * param_decls, package_name = None, prog_name = None, message = None, ** kwargs ) ¶Īdd a -version option which immediately prints the version If the prompt is declined, the program will exit. confirmation_option ( * param_decls, ** kwargs ) ¶Īdd a -yes option which shows a prompt before continuing if Kwargs ( Any) – Extra arguments are passed to option().Ĭallable, ] click. Param_decls ( str) – One or more option names. Input and asking to enter the value again for confirmation. password_option ( * param_decls, ** kwargs ) ¶Īdd a -password option which prompts for a password, hiding This is equivalent to creating an Option instance manuallyĬls – the option class to instantiate. Passed as parameter declarations to Option all keyword option ( * param_decls, ** attrs ) ¶Īttaches an option to the command. ParametersĬls – the argument class to instantiate. This is equivalent to creating an Argument instance manuallyĪnd attaching it to the Command.params list. Passed as parameter declarations to Argument all keywordĪrguments are forwarded unchanged (except cls).
argument ( * param_decls, ** attrs ) ¶Īttaches an argument to the command. This defaults toĬhanged in version 8.1: This decorator can be applied without parentheses. Name with underscores replaced by dashes.Ĭls – the command class to instantiate. That can be invoked as a command line utility or be attached to a Once decorated the function turns into a Command instance Pass the intended name as the first argument.Īll keyword arguments are forwarded to the underlying command class.įor the params argument, any decorated params are appended to The name of the command defaults to the name of the function with Option()s and argument()s as parameters to the command. This will also automatically attach all decorated command ( name : Optional = None, cls : Type = None, ** attrs : Any ) → Callable, ]Ĭreates a new Command and uses the decorated function asĬallback. command ( name : Optional = None, ** attrs : Any ) → Callable, ] click. command ( _func : Callable, Any ] ) → ¶ click.
This part of the documentation lists the full API reference of all publicĬlasses and functions.
0 kommentar(er)
