Method add_task

invoke/collection.py:238–283

Add `.Task` ``task`` to this collection. :param task: The `.Task` object to add to this collection. :param name: Optional string name to bind to (overrides the task's own self-defined ``name`` attribute and/or any Python identifier (i.e.

(
        self,
        task: "Task",
        name: Optional[str] = None,
        aliases: Optional[Tuple[str, ...]] = None,
        default: Optional[bool] = None,
    )

        return collection

    def add_task(
        self,
        task: "Task",
        name: Optional[str] = None,
        aliases: Optional[Tuple[str, ...]] = None,
        default: Optional[bool] = None,
    ) -> None:
        """
        Add `.Task` ``task`` to this collection.

        :param task: The `.Task` object to add to this collection.

        :param name:
            Optional string name to bind to (overrides the task's own
            self-defined ``name`` attribute and/or any Python identifier (i.e.
            ``.func_name``.)

        :param aliases:
            Optional iterable of additional names to bind the task as, on top
            of the primary name. These will be used in addition to any aliases
            the task itself declares internally.

        :param default: Whether this task should be the collection default.

        .. versionadded:: 1.0
        """
        if name is None:
            if task.name:
                name = task.name
            # XXX https://github.com/python/mypy/issues/1424
            elif hasattr(task.body, "func_name"):
                name = task.body.func_name  # type: ignore
            elif hasattr(task.body, "__name__"):
                name = task.__name__
            else:
                raise ValueError("Could not obtain a name for this task!")
        name = self.transform(name)
        if name in self.collections:
            err = "Name conflict: this collection has a sub-collection named {!r} already"  # noqa
            raise ValueError(err.format(name))
        self.tasks[name] = task
        for alias in list(task.aliases) + list(aliases or []):
            self.tasks.alias(self.transform(alias), to=name)
        if default is True or (default is None and task.is_default):
            self._check_default_collision(name)
            self.default = name

    def add_collection(
        self,