Class CustomArgument

awscli/arguments.py:192–350

Represents a CLI argument that is configured from a dictionary. For example, the "top level" arguments used for the CLI (--region, --output) can use a CustomArgument argument, as these are described in the cli.json file as dictionaries. This class is also useful for plugins/cu

class CustomArgument(BaseCLIArgument):
    """
    Represents a CLI argument that is configured from a dictionary.

    For example, the "top level" arguments used for the CLI
    (--region, --output) can use a CustomArgument argument,
    as these are described in the cli.json file as dictionaries.

    This class is also useful for plugins/customizations that want to
    add additional args.

    """

    def __init__(
        self,
        name,
        help_text='',
        dest=None,
        default=None,
        action=None,
        required=None,
        choices=None,
        nargs=None,
        cli_type_name=None,
        group_name=None,
        positional_arg=False,
        no_paramfile=False,
        argument_model=None,
        synopsis='',
        const=None,
    ):
        self._name = name
        self._help = help_text
        self._dest = dest
        self._default = default
        self._action = action
        self._required = required
        self._nargs = nargs
        self._const = const
        self._cli_type_name = cli_type_name
        self._group_name = group_name
        self._positional_arg = positional_arg
        if choices is None:
            choices = []
        self._choices = choices
        self._synopsis = synopsis

        # These are public attributes that are ok to access from external
        # objects.
        self.no_paramfile = no_paramfile
        self.argument_model = None

        if argument_model is None:
            argument_model = self._create_scalar_argument_model()
        self.argument_model = argument_model

        # If the top level element is a list then set nargs to
        # accept multiple values seperated by a space.