invoke.tasks.Call

class documentation

class Call: (source)

View In Hierarchy

Represents a call/execution of a `.Task` with given (kw)args. Similar to `~functools.partial` with some added functionality (such as the delegation to the inner task, and optional tracking of the name it's being called by.) .. versionadded:: 1.0

Method __deepcopy__ Undocumented
Method __eq__ Undocumented
Method __getattr__ Undocumented
Method __init__ Create a new `.Call` object.
Method __repr__ Undocumented
Method clone Return a standalone copy of this Call.
Method clone_data Return keyword args suitable for cloning this call into another.
Method make_context Generate a `.Context` appropriate for this call, with given config.
Instance Variable args Undocumented
Instance Variable called_as Undocumented
Instance Variable kwargs Undocumented
Instance Variable task Undocumented
def __deepcopy__(self, memo): (source)

Undocumented

def __eq__(self, other): (source)

Undocumented

def __getattr__(self, name): (source)

Undocumented

def __init__(self, task, called_as=None, args=None, kwargs=None): (source)

Create a new `.Call` object. :param task: The `.Task` object to be executed. :param str called_as: The name the task is being called as, e.g. if it was called by an alias or other rebinding. Defaults to ``None``, aka, the task was referred to by its default name. :param tuple args: Positional arguments to call with, if any. Default: ``None``. :param dict kwargs: Keyword arguments to call with, if any. Default: ``None``.

def __repr__(self): (source)

Undocumented

def clone(self, into=None, with_=None): (source)

Return a standalone copy of this Call. Useful when parameterizing task executions. :param into: A subclass to generate instead of the current class. Optional. :param dict with_: A dict of additional keyword arguments to use when creating the new clone; typically used when cloning ``into`` a subclass that has extra args on top of the base class. Optional. .. note:: This dict is used to ``.update()`` the original object's data (the return value from its `clone_data`), so in the event of a conflict, values in ``with_`` will win out. .. versionadded:: 1.0 .. versionchanged:: 1.1 Added the ``with_`` kwarg.

def clone_data(self): (source)

Return keyword args suitable for cloning this call into another. .. versionadded:: 1.1

def make_context(self, config): (source)

Generate a `.Context` appropriate for this call, with given config. .. versionadded:: 1.0

args = (source)

Undocumented

called_as = (source)

Undocumented

kwargs = (source)

Undocumented

task = (source)

Undocumented