Method get_arguments

invoke/tasks.py:239–286

Return a list of Argument objects representing this task's signature. :param bool ignore_unknown_help: Controls whether unknown help flags cause errors. See the config option by the same name for details. .. versionadded:: 1.0 .. versionchan

(
        self, ignore_unknown_help: Optional[bool] = None
    )

        return opts

    def get_arguments(
        self, ignore_unknown_help: Optional[bool] = None
    ) -> List[Argument]:
        """
        Return a list of Argument objects representing this task's signature.

        :param bool ignore_unknown_help:
            Controls whether unknown help flags cause errors. See the config
            option by the same name for details.

        .. versionadded:: 1.0
        .. versionchanged:: 1.7
            Added the ``ignore_unknown_help`` kwarg.
        """
        # Core argspec
        sig = self.argspec(self.body)
        # Prime the list of all already-taken names (mostly for help in
        # choosing auto shortflags)
        taken_names = set(sig.parameters.keys())
        # Build arg list (arg_opts will take care of setting up shortnames,
        # etc)
        args = []
        for param in sig.parameters.values():
            new_arg = Argument(
                **self.arg_opts(param.name, param.default, taken_names)
            )
            args.append(new_arg)
            # Update taken_names list with new argument's full name list
            # (which may include new shortflags) so subsequent Argument
            # creation knows what's taken.
            taken_names.update(set(new_arg.names))
        # If any values were leftover after consuming a 'help' dict, it implies
        # the user messed up & had a typo or similar. Let's explode.
        if self.help and not ignore_unknown_help:
            raise ValueError(
                "Help field was set for param(s) that don't exist: {}".format(
                    list(self.help.keys())
                )
            )
        # Now we need to ensure positionals end up in the front of the list, in
        # order given in self.positionals, so that when Context consumes them,
        # this order is preserved.
        for posarg in reversed(list(self.positional)):
            for i, arg in enumerate(args):
                if arg.name == posarg:
                    args.insert(0, args.pop(i))
                    break
        return args


def task(*args: Any, **kwargs: Any) -> Callable: