executor

class fabric.executor.Executor(collection: Collection, config: Optional[Config] = None, core: Optional[ParseResult] = None)

Executor subclass which understands Fabric concepts.

Designed to work in tandem with Fabric’s @task/Task, and is capable of acting on information stored on the resulting objects – such as default host lists.

This class is written to be backwards compatible with vanilla Invoke-level tasks, which it simply delegates to its superclass.

Please see the parent class’ documentation for details on most public API members and object lifecycle.

normalize_hosts(hosts)

Normalize mixed host-strings-or-kwarg-dicts into kwarg dicts only.

In other words, transforms data taken from the CLI (–hosts, always strings) or decorator arguments (may be strings or kwarg dicts) into kwargs suitable for creating Connection instances.

Subclasses may wish to override or extend this to perform, for example, database or custom config file lookups (vs this default behavior, which is to simply assume that strings are ‘host’ kwargs).

Parameters

hosts – Potentially heterogenous list of host connection values, as per the hosts param to task.

Returns

Homogenous list of Connection init kwarg dicts.

parameterize(call, connection_init_kwargs)

Parameterize a Call with its Context set to a per-host Connection.

Parameters
  • call – The generic Call being parameterized.

  • connection_init_kwargs – The dict of Connection init params/kwargs to attach to the resulting ConnectionCall.

Returns

ConnectionCall.