cornflakes.decorator.click package

Subpackages

• cornflakes.decorator.click.commands package
  • Module contents
• cornflakes.decorator.click.helper package
  • Module contents
    • click_param_type_parser()
    • get_command_name()
• cornflakes.decorator.click.options package
  • Module contents
    • bg_process_option()
    • config_option()
    • global_option()
    • verbose_option()
    • verbose_option_all()
• cornflakes.decorator.click.rich package
  • Module contents
    • RichArg
    • RichCommand
      • RichCommand.allow_extra_args
      • RichCommand.allow_interspersed_args
      • RichCommand.callback()
      • RichCommand.config
      • RichCommand.context_settings
      • RichCommand.format_help()
      • RichCommand.ignore_unknown_options
      • RichCommand.main()
      • RichCommand.name
      • RichCommand.params
      • RichCommand.parent
      • RichCommand.standalone_mode
    • RichConfig
      • RichConfig.ABORTED_TEXT
      • RichConfig.ALIGN_COMMANDS_PANEL
      • RichConfig.ALIGN_ERRORS_PANEL
      • RichConfig.ALIGN_OPTIONS_PANEL
      • RichConfig.APPEND_METAVARS_HELP
      • RichConfig.APPEND_METAVARS_HELP_STRING
      • RichConfig.APPEND_METAVARS_REQUIRED
      • RichConfig.ARGUMENTS_PANEL_TITLE
      • RichConfig.BG_PROCESS_OPTION
      • RichConfig.CODE_THEME
      • RichConfig.COLOR_SYSTEM
      • RichConfig.COMMANDS_PANEL_TITLE
      • RichConfig.COMMAND_GROUPS
      • RichConfig.CONTEXT_SETTINGS
      • RichConfig.DEFAULT_STRING
      • RichConfig.DEPRECATED_STRING
      • RichConfig.ENVVAR_STRING
      • RichConfig.ERRORS_EPILOGUE
      • RichConfig.ERRORS_PANEL_TITLE
      • RichConfig.ERRORS_SUGGESTION
      • RichConfig.FOOTER_TEXT
      • RichConfig.FORCE_TERMINAL
      • RichConfig.GLOBAL_OPTIONS
      • RichConfig.GROUP_ARGUMENTS_OPTIONS
      • RichConfig.HEADER_LOGO
      • RichConfig.HEADER_TEXT
      • RichConfig.MAX_WIDTH
      • RichConfig.OPTIONS_PANEL_TITLE
      • RichConfig.OPTION_ENVVAR_FIRST
      • RichConfig.OPTION_GROUPS
      • RichConfig.RANGE_STRING
      • RichConfig.REQUIRED_LONG_STRING
      • RichConfig.REQUIRED_SHORT_STRING
      • RichConfig.SHOW_ARGUMENTS
      • RichConfig.SHOW_METAVARS_COLUMN
      • RichConfig.SHOW_RST_ERRORS
      • RichConfig.STYLE_ABORTED
      • RichConfig.STYLE_ARGUMENT
      • RichConfig.STYLE_COMMANDS_PANEL_BORDER
      • RichConfig.STYLE_COMMANDS_TABLE_BORDER_STYLE
      • RichConfig.STYLE_COMMANDS_TABLE_BOX
      • RichConfig.STYLE_COMMANDS_TABLE_LEADING
      • RichConfig.STYLE_COMMANDS_TABLE_PADDING
      • RichConfig.STYLE_COMMANDS_TABLE_PAD_EDGE
      • RichConfig.STYLE_COMMANDS_TABLE_ROW_STYLES
      • RichConfig.STYLE_COMMANDS_TABLE_SHOW_LINES
      • RichConfig.STYLE_DEPRECATED
      • RichConfig.STYLE_ERRORS_PANEL_BORDER
      • RichConfig.STYLE_ERRORS_SUGGESTION
      • RichConfig.STYLE_FOOTER_TEXT
      • RichConfig.STYLE_HEADER_TEXT
      • RichConfig.STYLE_HELPTEXT
      • RichConfig.STYLE_HELPTEXT_FIRST_LINE
      • RichConfig.STYLE_METAVAR
      • RichConfig.STYLE_METAVAR_APPEND
      • RichConfig.STYLE_METAVAR_SEPARATOR
      • RichConfig.STYLE_OPTION
      • RichConfig.STYLE_OPTIONS_PANEL_BORDER
      • RichConfig.STYLE_OPTIONS_TABLE_BORDER_STYLE
      • RichConfig.STYLE_OPTIONS_TABLE_BOX
      • RichConfig.STYLE_OPTIONS_TABLE_HEADER_STYLE
      • RichConfig.STYLE_OPTIONS_TABLE_LEADING
      • RichConfig.STYLE_OPTIONS_TABLE_PADDING
      • RichConfig.STYLE_OPTIONS_TABLE_PAD_EDGE
      • RichConfig.STYLE_OPTIONS_TABLE_ROW_STYLES
      • RichConfig.STYLE_OPTIONS_TABLE_SHOW_EDGE
      • RichConfig.STYLE_OPTIONS_TABLE_SHOW_LINES
      • RichConfig.STYLE_OPTION_DEFAULT
      • RichConfig.STYLE_OPTION_ENVVAR
      • RichConfig.STYLE_OPTION_HELP
      • RichConfig.STYLE_REQUIRED_LONG
      • RichConfig.STYLE_REQUIRED_SHORT
      • RichConfig.STYLE_SWITCH
      • RichConfig.STYLE_USAGE
      • RichConfig.STYLE_USAGE_COMMAND
      • RichConfig.USE_CLICK_SHORT_HELP
      • RichConfig.USE_MARKDOWN
      • RichConfig.USE_MARKDOWN_EMOJI
      • RichConfig.USE_RICH_MARKUP
      • RichConfig.USE_RST
      • RichConfig.VERBOSE_LOGGER
      • RichConfig.VERBOSE_OPTION
      • RichConfig.VERSION_INFO
      • RichConfig.check_kwargs()
      • RichConfig.from_dict()
      • RichConfig.from_file()
      • RichConfig.from_ini()
      • RichConfig.from_yaml()
      • RichConfig.keys()
      • RichConfig.to_dict()
      • RichConfig.to_ini()
      • RichConfig.to_tuple()
      • RichConfig.to_yaml()
      • RichConfig.update()
      • RichConfig.validate_kwargs()
    • RichGroup
      • RichGroup.add_command()
      • RichGroup.callback()
      • RichGroup.command()
      • RichGroup.command_class
      • RichGroup.commands
      • RichGroup.config
      • RichGroup.context_settings
      • RichGroup.format_help()
      • RichGroup.group()
      • RichGroup.group_class
      • RichGroup.main()
      • RichGroup.name
      • RichGroup.params
      • RichGroup.pass_context
    • argument()
    • command()
    • group()
    • group_command()
    • group_group()
    • option()

Submodules

cornflakes.decorator.click.types module

class cornflakes.decorator.click.types.GlobalOption(*args, **kwargs)

Bases: Protocol

GlobalOption Protocol which requires params.

params: List[Option]

Module contents

Click Extension for better CLI.

See referenced Code at https://github.com/ewels/rich-click.git

cornflakes.decorator.click.argument(*args, cls=<class 'cornflakes.decorator.click.rich._rich_argument.RichArg'>, **kwargs)

Command decorator function.

Defines the command() function so that it uses the RichCommand class by default.

Rückgabetyp:

Callable[[…], Argument | RichArg]

cornflakes.decorator.click.bg_process_option(self, background_process)

Default Option for running in background.

Parameter:

• self (RichCommand | RichGroup | Any) –

• background_process (bool) –

cornflakes.decorator.click.click_cli(STYLE_OPTION='bold cyan', STYLE_ARGUMENT='bold cyan', STYLE_SWITCH='bold green', STYLE_METAVAR='bold yellow', STYLE_METAVAR_APPEND='dim yellow', STYLE_METAVAR_SEPARATOR='dim', STYLE_HEADER_TEXT='', STYLE_FOOTER_TEXT='', STYLE_USAGE='yellow', STYLE_USAGE_COMMAND='bold', STYLE_DEPRECATED='red', STYLE_HELPTEXT_FIRST_LINE='', STYLE_HELPTEXT='dim', STYLE_OPTION_HELP='', STYLE_OPTION_DEFAULT='dim', STYLE_OPTION_ENVVAR='dim yellow', STYLE_REQUIRED_SHORT='red', STYLE_REQUIRED_LONG='dim red', STYLE_OPTIONS_PANEL_BORDER='dim', ALIGN_OPTIONS_PANEL='left', STYLE_OPTIONS_TABLE_SHOW_LINES=False, STYLE_OPTIONS_TABLE_LEADING=0, STYLE_OPTIONS_TABLE_PAD_EDGE=False, STYLE_OPTIONS_TABLE_PADDING=(0, 1), STYLE_OPTIONS_TABLE_SHOW_EDGE=True, STYLE_OPTIONS_TABLE_BOX='', STYLE_OPTIONS_TABLE_ROW_STYLES=None, STYLE_OPTIONS_TABLE_HEADER_STYLE='table.header', STYLE_OPTIONS_TABLE_BORDER_STYLE=None, STYLE_COMMANDS_PANEL_BORDER='dim', ALIGN_COMMANDS_PANEL='left', STYLE_COMMANDS_TABLE_SHOW_LINES=False, STYLE_COMMANDS_TABLE_LEADING=0, STYLE_COMMANDS_TABLE_PAD_EDGE=False, STYLE_COMMANDS_TABLE_PADDING=(0, 1), STYLE_COMMANDS_TABLE_BOX='', STYLE_COMMANDS_TABLE_ROW_STYLES=None, STYLE_COMMANDS_TABLE_BORDER_STYLE=None, STYLE_ERRORS_PANEL_BORDER='red', ALIGN_ERRORS_PANEL='left', STYLE_ERRORS_SUGGESTION='dim', STYLE_ABORTED='red', MAX_WIDTH=None, COLOR_SYSTEM='auto', FORCE_TERMINAL=None, HEADER_TEXT=None, HEADER_LOGO=None, FOOTER_TEXT=None, DEPRECATED_STRING='(Deprecated) ', DEFAULT_STRING='[default: {}]', ENVVAR_STRING='[env var: {}]', REQUIRED_SHORT_STRING='*', REQUIRED_LONG_STRING='[required]', RANGE_STRING=' [{}]', APPEND_METAVARS_HELP_STRING='({})', ARGUMENTS_PANEL_TITLE='Arguments', OPTIONS_PANEL_TITLE='Options', COMMANDS_PANEL_TITLE='Commands', ERRORS_PANEL_TITLE='Error', ERRORS_SUGGESTION=None, ERRORS_EPILOGUE=None, ABORTED_TEXT='Aborted.', SHOW_ARGUMENTS=True, SHOW_METAVARS_COLUMN=True, APPEND_METAVARS_HELP=False, APPEND_METAVARS_REQUIRED=False, GROUP_ARGUMENTS_OPTIONS=False, OPTION_ENVVAR_FIRST=False, USE_RST=False, SHOW_RST_ERRORS=False, USE_MARKDOWN=False, USE_MARKDOWN_EMOJI=True, USE_RICH_MARKUP=False, CODE_THEME='monokai', USE_CLICK_SHORT_HELP=False, VERSION_INFO=False, VERBOSE_OPTION=False, BG_PROCESS_OPTION=False, files=None, sections=None, eval_env=None, allow_empty=False, init_from_default_cache=False, callback=None, config=None, loader=<Loader.DICT: 'from_dict'>, default_log_level=20, as_command=False, *args, **kwargs)

Function that creates generic click CLI Object.

Parameter:

• STYLE_OPTION (str) –

• STYLE_ARGUMENT (str) –

• STYLE_SWITCH (str) –

• STYLE_METAVAR (str) –

• STYLE_METAVAR_APPEND (str) –

• STYLE_METAVAR_SEPARATOR (str) –

• STYLE_HEADER_TEXT (str) –

• STYLE_FOOTER_TEXT (str) –

• STYLE_USAGE (str) –

• STYLE_USAGE_COMMAND (str) –

• STYLE_DEPRECATED (str) –

• STYLE_HELPTEXT_FIRST_LINE (str) –

• STYLE_HELPTEXT (str) –

• STYLE_OPTION_HELP (str) –

• STYLE_OPTION_DEFAULT (str) –

• STYLE_OPTION_ENVVAR (str) –

• STYLE_REQUIRED_SHORT (str) –

• STYLE_REQUIRED_LONG (str) –

• STYLE_OPTIONS_PANEL_BORDER (str) –

• ALIGN_OPTIONS_PANEL (str) –

• STYLE_OPTIONS_TABLE_SHOW_LINES (bool) –

• STYLE_OPTIONS_TABLE_LEADING (int) –

• STYLE_OPTIONS_TABLE_PAD_EDGE (bool) –

• STYLE_OPTIONS_TABLE_PADDING (Tuple[int, int]) –

• STYLE_OPTIONS_TABLE_SHOW_EDGE (bool) –

• STYLE_OPTIONS_TABLE_BOX (str) –

• STYLE_OPTIONS_TABLE_ROW_STYLES (List[str] | None) –

• STYLE_OPTIONS_TABLE_HEADER_STYLE (str) –

• STYLE_OPTIONS_TABLE_BORDER_STYLE (str | None) –

• STYLE_COMMANDS_PANEL_BORDER (str) –

• ALIGN_COMMANDS_PANEL (str) –

• STYLE_COMMANDS_TABLE_SHOW_LINES (bool) –

• STYLE_COMMANDS_TABLE_LEADING (int) –

• STYLE_COMMANDS_TABLE_PAD_EDGE (bool) –

• STYLE_COMMANDS_TABLE_PADDING (Tuple[int, int]) –

• STYLE_COMMANDS_TABLE_BOX (str) –

• STYLE_COMMANDS_TABLE_ROW_STYLES (List[str] | None) –

• STYLE_COMMANDS_TABLE_BORDER_STYLE (List[str] | None) –

• STYLE_ERRORS_PANEL_BORDER (str) –

• ALIGN_ERRORS_PANEL (str) –

• STYLE_ERRORS_SUGGESTION (str) –

• STYLE_ABORTED (str) –

• MAX_WIDTH (int | None) –

• COLOR_SYSTEM (Literal['auto', 'standard', '256', 'truecolor', 'windows'] | None) –

• FORCE_TERMINAL (bool | None) –

• HEADER_TEXT (str | None) –

• HEADER_LOGO (str | None) –

• FOOTER_TEXT (str | None) –

• DEPRECATED_STRING (str) –

• DEFAULT_STRING (str) –

• ENVVAR_STRING (str) –

• REQUIRED_SHORT_STRING (str) –

• REQUIRED_LONG_STRING (str) –

• RANGE_STRING (str) –

• APPEND_METAVARS_HELP_STRING (str) –

• ARGUMENTS_PANEL_TITLE (str) –

• OPTIONS_PANEL_TITLE (str) –

• COMMANDS_PANEL_TITLE (str) –

• ERRORS_PANEL_TITLE (str) –

• ERRORS_SUGGESTION (str | None) –

• ERRORS_EPILOGUE (str | None) –

• ABORTED_TEXT (str) –

• SHOW_ARGUMENTS (bool) –

• SHOW_METAVARS_COLUMN (bool) –

• APPEND_METAVARS_HELP (bool) –

• APPEND_METAVARS_REQUIRED (bool) –

• GROUP_ARGUMENTS_OPTIONS (bool) –

• OPTION_ENVVAR_FIRST (bool) –

• USE_RST (bool) –

• SHOW_RST_ERRORS (bool) –

• USE_MARKDOWN (bool) –

• USE_MARKDOWN_EMOJI (bool) –

• USE_RICH_MARKUP (bool) –

• CODE_THEME (str) –

• USE_CLICK_SHORT_HELP (bool) –

• VERSION_INFO (bool) –

• VERBOSE_OPTION (bool) –

• BG_PROCESS_OPTION (bool) –

• files (List[str] | str | None) –

• sections (List[str] | str | None) –

• eval_env (bool | None) –

• allow_empty (bool | None) –

• init_from_default_cache (bool) –

• callback (Any | None) –

• config (RichConfig | None) –

• loader (Loader) –

• default_log_level (int) –

• as_command (bool) –

cornflakes.decorator.click.command(name, config=None, context_settings=None, callback=None, params=None, help=None, epilog=None, short_help=None, options_metavar='[OPTIONS]', add_help_option=True, no_args_is_help=False, hidden=False, deprecated=False, STYLE_OPTION='bold cyan', STYLE_ARGUMENT='bold cyan', STYLE_SWITCH='bold green', STYLE_METAVAR='bold yellow', STYLE_METAVAR_APPEND='dim yellow', STYLE_METAVAR_SEPARATOR='dim', STYLE_HEADER_TEXT='', STYLE_FOOTER_TEXT='', STYLE_USAGE='yellow', STYLE_USAGE_COMMAND='bold', STYLE_DEPRECATED='red', STYLE_HELPTEXT_FIRST_LINE='', STYLE_HELPTEXT='dim', STYLE_OPTION_HELP='', STYLE_OPTION_DEFAULT='dim', STYLE_OPTION_ENVVAR='dim yellow', STYLE_REQUIRED_SHORT='red', STYLE_REQUIRED_LONG='dim red', STYLE_OPTIONS_PANEL_BORDER='dim', ALIGN_OPTIONS_PANEL='left', STYLE_OPTIONS_TABLE_SHOW_LINES=False, STYLE_OPTIONS_TABLE_LEADING=0, STYLE_OPTIONS_TABLE_PAD_EDGE=False, STYLE_OPTIONS_TABLE_PADDING=(0, 1), STYLE_OPTIONS_TABLE_SHOW_EDGE=True, STYLE_OPTIONS_TABLE_BOX='', STYLE_OPTIONS_TABLE_ROW_STYLES=None, STYLE_OPTIONS_TABLE_HEADER_STYLE='table.header', STYLE_OPTIONS_TABLE_BORDER_STYLE=None, STYLE_COMMANDS_PANEL_BORDER='dim', ALIGN_COMMANDS_PANEL='left', STYLE_COMMANDS_TABLE_SHOW_LINES=False, STYLE_COMMANDS_TABLE_LEADING=0, STYLE_COMMANDS_TABLE_PAD_EDGE=False, STYLE_COMMANDS_TABLE_PADDING=(0, 1), STYLE_COMMANDS_TABLE_BOX='', STYLE_COMMANDS_TABLE_ROW_STYLES=None, STYLE_COMMANDS_TABLE_BORDER_STYLE=None, STYLE_ERRORS_PANEL_BORDER='red', ALIGN_ERRORS_PANEL='left', STYLE_ERRORS_SUGGESTION='dim', STYLE_ABORTED='red', MAX_WIDTH=None, COLOR_SYSTEM='auto', FORCE_TERMINAL=None, HEADER_TEXT=None, HEADER_LOGO=None, FOOTER_TEXT=None, DEPRECATED_STRING='(Deprecated) ', DEFAULT_STRING='[default: {}]', ENVVAR_STRING='[env var: {}]', REQUIRED_SHORT_STRING='*', REQUIRED_LONG_STRING='[required]', RANGE_STRING=' [{}]', APPEND_METAVARS_HELP_STRING='({})', ARGUMENTS_PANEL_TITLE='Arguments', OPTIONS_PANEL_TITLE='Options', COMMANDS_PANEL_TITLE='Commands', ERRORS_PANEL_TITLE='Error', ERRORS_SUGGESTION=None, ERRORS_EPILOGUE=None, ABORTED_TEXT='Aborted.', SHOW_ARGUMENTS=True, SHOW_METAVARS_COLUMN=True, APPEND_METAVARS_HELP=False, APPEND_METAVARS_REQUIRED=False, GROUP_ARGUMENTS_OPTIONS=False, OPTION_ENVVAR_FIRST=False, USE_RST=False, SHOW_RST_ERRORS=False, USE_MARKDOWN=False, USE_MARKDOWN_EMOJI=True, USE_RICH_MARKUP=False, CODE_THEME='monokai', USE_CLICK_SHORT_HELP=False, VERSION_INFO=False, VERBOSE_OPTION=False, BG_PROCESS_OPTION=False, files=None, sections=None, eval_env=None, allow_empty=False, init_from_default_cache=False, loader=<Loader.DICT: 'from_dict'>, default_log_level=20, *args, **kwargs)

Command decorator function.

Defines the command() function so that it uses the RichCommand class by default

Parameter:

• name (str | None) –

• config (RichConfig | None) –

• context_settings (MutableMapping[str, Any] | None) –

• callback (Callable[[...], Any] | None) –

• params (List[Parameter] | None) –

• help (str | None) –

• epilog (str | None) –

• short_help (str | None) –

• options_metavar (str | None) –

• add_help_option (bool) –

• no_args_is_help (bool) –

• hidden (bool) –

• deprecated (bool) –

• STYLE_OPTION (str) –

• STYLE_ARGUMENT (str) –

• STYLE_SWITCH (str) –

• STYLE_METAVAR (str) –

• STYLE_METAVAR_APPEND (str) –

• STYLE_METAVAR_SEPARATOR (str) –

• STYLE_HEADER_TEXT (str) –

• STYLE_FOOTER_TEXT (str) –

• STYLE_USAGE (str) –

• STYLE_USAGE_COMMAND (str) –

• STYLE_DEPRECATED (str) –

• STYLE_HELPTEXT_FIRST_LINE (str) –

• STYLE_HELPTEXT (str) –

• STYLE_OPTION_HELP (str) –

• STYLE_OPTION_DEFAULT (str) –

• STYLE_OPTION_ENVVAR (str) –

• STYLE_REQUIRED_SHORT (str) –

• STYLE_REQUIRED_LONG (str) –

• STYLE_OPTIONS_PANEL_BORDER (str) –

• ALIGN_OPTIONS_PANEL (str) –

• STYLE_OPTIONS_TABLE_SHOW_LINES (bool) –

• STYLE_OPTIONS_TABLE_LEADING (int) –

• STYLE_OPTIONS_TABLE_PAD_EDGE (bool) –

• STYLE_OPTIONS_TABLE_PADDING (Tuple[int, int]) –

• STYLE_OPTIONS_TABLE_SHOW_EDGE (bool) –

• STYLE_OPTIONS_TABLE_BOX (str) –

• STYLE_OPTIONS_TABLE_ROW_STYLES (List[str] | None) –

• STYLE_OPTIONS_TABLE_HEADER_STYLE (str) –

• STYLE_OPTIONS_TABLE_BORDER_STYLE (str | None) –

• STYLE_COMMANDS_PANEL_BORDER (str) –

• ALIGN_COMMANDS_PANEL (str) –

• STYLE_COMMANDS_TABLE_SHOW_LINES (bool) –

• STYLE_COMMANDS_TABLE_LEADING (int) –

• STYLE_COMMANDS_TABLE_PAD_EDGE (bool) –

• STYLE_COMMANDS_TABLE_PADDING (Tuple[int, int]) –

• STYLE_COMMANDS_TABLE_BOX (str) –

• STYLE_COMMANDS_TABLE_ROW_STYLES (List[str] | None) –

• STYLE_COMMANDS_TABLE_BORDER_STYLE (List[str] | None) –

• STYLE_ERRORS_PANEL_BORDER (str) –

• ALIGN_ERRORS_PANEL (str) –

• STYLE_ERRORS_SUGGESTION (str) –

• STYLE_ABORTED (str) –

• MAX_WIDTH (int | None) –

• COLOR_SYSTEM (Literal['auto', 'standard', '256', 'truecolor', 'windows'] | None) –

• FORCE_TERMINAL (bool | None) –

• HEADER_TEXT (str | None) –

• HEADER_LOGO (str | None) –

• FOOTER_TEXT (str | None) –

• DEPRECATED_STRING (str) –

• DEFAULT_STRING (str) –

• ENVVAR_STRING (str) –

• REQUIRED_SHORT_STRING (str) –

• REQUIRED_LONG_STRING (str) –

• RANGE_STRING (str) –

• APPEND_METAVARS_HELP_STRING (str) –

• ARGUMENTS_PANEL_TITLE (str) –

• OPTIONS_PANEL_TITLE (str) –

• COMMANDS_PANEL_TITLE (str) –

• ERRORS_PANEL_TITLE (str) –

• ERRORS_SUGGESTION (str | None) –

• ERRORS_EPILOGUE (str | None) –

• ABORTED_TEXT (str) –

• SHOW_ARGUMENTS (bool) –

• SHOW_METAVARS_COLUMN (bool) –

• APPEND_METAVARS_HELP (bool) –

• APPEND_METAVARS_REQUIRED (bool) –

• GROUP_ARGUMENTS_OPTIONS (bool) –

• OPTION_ENVVAR_FIRST (bool) –

• USE_RST (bool) –

• SHOW_RST_ERRORS (bool) –

• USE_MARKDOWN (bool) –

• USE_MARKDOWN_EMOJI (bool) –

• USE_RICH_MARKUP (bool) –

• CODE_THEME (str) –

• USE_CLICK_SHORT_HELP (bool) –

• VERSION_INFO (bool) –

• VERBOSE_OPTION (bool) –

• BG_PROCESS_OPTION (bool) –

• files (List[str] | str | None) –

• sections (List[str] | str | None) –

• eval_env (bool | None) –

• allow_empty (bool | None) –

• init_from_default_cache (bool) –

• loader (Loader) –

• default_log_level (int) –

cornflakes.decorator.click.config_option(config, add_config_file_option=False, files=None, sections=None, passing_key=None, **options)

Click Option Decorator to define a global option for cli decorator.

Parameter:

• config (Type[_T] | Type[CornflakesDataclass] | Type[Config] | Type[ConfigGroup]) –

• add_config_file_option (bool) –

• files (List[str] | str | None) –

• sections (List[str] | str | None) –

Rückgabetyp:

Callable[[Command | Group | Type[_T] | Callable[[…], Any]], Command | Group | Type[_T] | Callable[[…], Any]]

cornflakes.decorator.click.global_option(*option_args, **option_kwargs)

Click Option Decorator to define a global option for cli decorator.

Rückgabetyp:

Callable[[…], GlobalOption] | GlobalOption

cornflakes.decorator.click.group(pass_context=None, config=None, name=None, invoke_without_command=False, no_args_is_help=None, subcommand_metavar=None, chain=False, result_callback=None, STYLE_OPTION='bold cyan', STYLE_ARGUMENT='bold cyan', STYLE_SWITCH='bold green', STYLE_METAVAR='bold yellow', STYLE_METAVAR_APPEND='dim yellow', STYLE_METAVAR_SEPARATOR='dim', STYLE_HEADER_TEXT='', STYLE_FOOTER_TEXT='', STYLE_USAGE='yellow', STYLE_USAGE_COMMAND='bold', STYLE_DEPRECATED='red', STYLE_HELPTEXT_FIRST_LINE='', STYLE_HELPTEXT='dim', STYLE_OPTION_HELP='', STYLE_OPTION_DEFAULT='dim', STYLE_OPTION_ENVVAR='dim yellow', STYLE_REQUIRED_SHORT='red', STYLE_REQUIRED_LONG='dim red', STYLE_OPTIONS_PANEL_BORDER='dim', ALIGN_OPTIONS_PANEL='left', STYLE_OPTIONS_TABLE_SHOW_LINES=False, STYLE_OPTIONS_TABLE_LEADING=0, STYLE_OPTIONS_TABLE_PAD_EDGE=False, STYLE_OPTIONS_TABLE_PADDING=(0, 1), STYLE_OPTIONS_TABLE_SHOW_EDGE=True, STYLE_OPTIONS_TABLE_BOX='', STYLE_OPTIONS_TABLE_ROW_STYLES=None, STYLE_OPTIONS_TABLE_HEADER_STYLE='table.header', STYLE_OPTIONS_TABLE_BORDER_STYLE=None, STYLE_COMMANDS_PANEL_BORDER='dim', ALIGN_COMMANDS_PANEL='left', STYLE_COMMANDS_TABLE_SHOW_LINES=False, STYLE_COMMANDS_TABLE_LEADING=0, STYLE_COMMANDS_TABLE_PAD_EDGE=False, STYLE_COMMANDS_TABLE_PADDING=(0, 1), STYLE_COMMANDS_TABLE_BOX='', STYLE_COMMANDS_TABLE_ROW_STYLES=None, STYLE_COMMANDS_TABLE_BORDER_STYLE=None, STYLE_ERRORS_PANEL_BORDER='red', ALIGN_ERRORS_PANEL='left', STYLE_ERRORS_SUGGESTION='dim', STYLE_ABORTED='red', MAX_WIDTH=None, COLOR_SYSTEM='auto', FORCE_TERMINAL=None, HEADER_TEXT=None, HEADER_LOGO=None, FOOTER_TEXT=None, DEPRECATED_STRING='(Deprecated) ', DEFAULT_STRING='[default: {}]', ENVVAR_STRING='[env var: {}]', REQUIRED_SHORT_STRING='*', REQUIRED_LONG_STRING='[required]', RANGE_STRING=' [{}]', APPEND_METAVARS_HELP_STRING='({})', ARGUMENTS_PANEL_TITLE='Arguments', OPTIONS_PANEL_TITLE='Options', COMMANDS_PANEL_TITLE='Commands', ERRORS_PANEL_TITLE='Error', ERRORS_SUGGESTION=None, ERRORS_EPILOGUE=None, ABORTED_TEXT='Aborted.', SHOW_ARGUMENTS=True, SHOW_METAVARS_COLUMN=True, APPEND_METAVARS_HELP=False, APPEND_METAVARS_REQUIRED=False, GROUP_ARGUMENTS_OPTIONS=False, OPTION_ENVVAR_FIRST=False, USE_RST=False, SHOW_RST_ERRORS=False, USE_MARKDOWN=False, USE_MARKDOWN_EMOJI=True, USE_RICH_MARKUP=False, CODE_THEME='monokai', USE_CLICK_SHORT_HELP=False, VERSION_INFO=False, VERBOSE_OPTION=False, BG_PROCESS_OPTION=False, files=None, sections=None, eval_env=None, allow_empty=False, init_from_default_cache=False, callback=None, loader=<Loader.DICT: 'from_dict'>, default_log_level=20, as_command=False, *args, **kwargs)

Group decorator function.

Defines the group() function so that it uses the RichGroup class by default.

Parameter:

• pass_context (bool | None) –

• config (RichConfig | None) –

• name (str | None) –

• invoke_without_command (bool) –

• no_args_is_help (bool | None) –

• subcommand_metavar (str | None) –

• chain (bool) –

• result_callback (Callable[[...], Any] | None) –

• STYLE_OPTION (str) –

• STYLE_ARGUMENT (str) –

• STYLE_SWITCH (str) –

• STYLE_METAVAR (str) –

• STYLE_METAVAR_APPEND (str) –

• STYLE_METAVAR_SEPARATOR (str) –

• STYLE_HEADER_TEXT (str) –

• STYLE_FOOTER_TEXT (str) –

• STYLE_USAGE (str) –

• STYLE_USAGE_COMMAND (str) –

• STYLE_DEPRECATED (str) –

• STYLE_HELPTEXT_FIRST_LINE (str) –

• STYLE_HELPTEXT (str) –

• STYLE_OPTION_HELP (str) –

• STYLE_OPTION_DEFAULT (str) –

• STYLE_OPTION_ENVVAR (str) –

• STYLE_REQUIRED_SHORT (str) –

• STYLE_REQUIRED_LONG (str) –

• STYLE_OPTIONS_PANEL_BORDER (str) –

• ALIGN_OPTIONS_PANEL (str) –

• STYLE_OPTIONS_TABLE_SHOW_LINES (bool) –

• STYLE_OPTIONS_TABLE_LEADING (int) –

• STYLE_OPTIONS_TABLE_PAD_EDGE (bool) –

• STYLE_OPTIONS_TABLE_PADDING (Tuple[int, int]) –

• STYLE_OPTIONS_TABLE_SHOW_EDGE (bool) –

• STYLE_OPTIONS_TABLE_BOX (str) –

• STYLE_OPTIONS_TABLE_ROW_STYLES (List[str] | None) –

• STYLE_OPTIONS_TABLE_HEADER_STYLE (str) –

• STYLE_OPTIONS_TABLE_BORDER_STYLE (str | None) –

• STYLE_COMMANDS_PANEL_BORDER (str) –

• ALIGN_COMMANDS_PANEL (str) –

• STYLE_COMMANDS_TABLE_SHOW_LINES (bool) –

• STYLE_COMMANDS_TABLE_LEADING (int) –

• STYLE_COMMANDS_TABLE_PAD_EDGE (bool) –

• STYLE_COMMANDS_TABLE_PADDING (Tuple[int, int]) –

• STYLE_COMMANDS_TABLE_BOX (str) –

• STYLE_COMMANDS_TABLE_ROW_STYLES (List[str] | None) –

• STYLE_COMMANDS_TABLE_BORDER_STYLE (List[str] | None) –

• STYLE_ERRORS_PANEL_BORDER (str) –

• ALIGN_ERRORS_PANEL (str) –

• STYLE_ERRORS_SUGGESTION (str) –

• STYLE_ABORTED (str) –

• MAX_WIDTH (int | None) –

• COLOR_SYSTEM (Literal['auto', 'standard', '256', 'truecolor', 'windows'] | None) –

• FORCE_TERMINAL (bool | None) –

• HEADER_TEXT (str | None) –

• HEADER_LOGO (str | None) –

• FOOTER_TEXT (str | None) –

• DEPRECATED_STRING (str) –

• DEFAULT_STRING (str) –

• ENVVAR_STRING (str) –

• REQUIRED_SHORT_STRING (str) –

• REQUIRED_LONG_STRING (str) –

• RANGE_STRING (str) –

• APPEND_METAVARS_HELP_STRING (str) –

• ARGUMENTS_PANEL_TITLE (str) –

• OPTIONS_PANEL_TITLE (str) –

• COMMANDS_PANEL_TITLE (str) –

• ERRORS_PANEL_TITLE (str) –

• ERRORS_SUGGESTION (str | None) –

• ERRORS_EPILOGUE (str | None) –

• ABORTED_TEXT (str) –

• SHOW_ARGUMENTS (bool) –

• SHOW_METAVARS_COLUMN (bool) –

• APPEND_METAVARS_HELP (bool) –

• APPEND_METAVARS_REQUIRED (bool) –

• GROUP_ARGUMENTS_OPTIONS (bool) –

• OPTION_ENVVAR_FIRST (bool) –

• USE_RST (bool) –

• SHOW_RST_ERRORS (bool) –

• USE_MARKDOWN (bool) –

• USE_MARKDOWN_EMOJI (bool) –

• USE_RICH_MARKUP (bool) –

• CODE_THEME (str) –

• USE_CLICK_SHORT_HELP (bool) –

• VERSION_INFO (bool) –

• VERBOSE_OPTION (bool) –

• BG_PROCESS_OPTION (bool) –

• files (List[str] | str | None) –

• sections (List[str] | str | None) –

• eval_env (bool | None) –

• allow_empty (bool | None) –

• init_from_default_cache (bool) –

• callback (Any | None) –

• loader (Loader) –

• default_log_level (int) –

• as_command (bool) –

cornflakes.decorator.click.verbose_option(verbose, self)

Default Option for verbose logging.