cornflakes.decorator.click_cli

cornflakes.decorator.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) –