CLI

class markdown_checker.cli.ListOfStrings(param_decls=None, show_default=None, prompt=False, confirmation_prompt=False, prompt_required=True, hide_input=False, is_flag=None, flag_value=UNSET, multiple=False, count=False, allow_from_autoenv=True, type=None, help=None, hidden=False, show_choices=True, show_envvar=False, deprecated=False, **attrs)

Bases: Option

Helper class to parse a comma-separated list of strings from the command line.

Ref: https://stackoverflow.com/questions/47631914/how-to-pass-several-list-of-arguments-to-click-option

Parameters:

  • param_decls (cabc.Sequence[str] | None)

  • show_default (bool | str | None)

  • prompt (bool | str)

  • confirmation_prompt (bool | str)

  • prompt_required (bool)

  • hide_input (bool)

  • is_flag (bool | None)

  • flag_value (t.Any)

  • multiple (bool)

  • count (bool)

  • allow_from_autoenv (bool)

  • type (types.ParamType[t.Any] | t.Any | None)

  • help (str | None)

  • hidden (bool)

  • show_choices (bool)

  • show_envvar (bool)

  • deprecated (bool | str)

  • attrs (t.Any)

type_cast_value(ctx, value)

Convert and validate a value against the parameter’s type, multiple, and nargs.

Return type:

list[str]