recline.arg_types package

Submodules

• recline.arg_types.choices module
  • Choices
    • Choices.define()
• recline.arg_types.flag module
  • Flag
    • Flag.action
• recline.arg_types.positional module
  • Positional
    • Positional.define()
• recline.arg_types.ranged_int module
  • RangedInt
    • RangedInt.define()
• recline.arg_types.recline_type module
  • ReclineType
    • ReclineType.action
    • ReclineType.choices()
    • ReclineType.completer()
    • ReclineType.metavar
    • ReclineType.nargs()
    • ReclineType.validate()
  • UniqueParam
• recline.arg_types.recline_type_error module
  • ReclineTypeError
• recline.arg_types.remainder module
  • Remainder
    • Remainder.define()
    • Remainder.nargs()

Module contents

Original © NetApp 2024

This package contains the various custom type definitions for CLI command parameters. If you are defining a CLI command function that takes input with restrictions, you may want to use a type annotation to allow recline to do the checking for you before your function ever gets invoked. For example:

from recline.arg_types import Choices

@recline.command def commit(branch: Choices.define([‘dev’, ‘beta’, ‘stable’])) -> None:

# the function can now assume that branch has already been validated to be # one of the options above before we got here