Class Context

invoke/context.py:22–411

Context-aware API wrapper & state-passing object. `.Context` objects are created during command-line parsing (or, if desired, by hand) and used to share parser and configuration state with executed tasks (see :ref:`why-context`). Specifically, the class offers wrappers for cor

class Context(DataProxy):
    """
    Context-aware API wrapper & state-passing object.

    `.Context` objects are created during command-line parsing (or, if desired,
    by hand) and used to share parser and configuration state with executed
    tasks (see :ref:`why-context`).

    Specifically, the class offers wrappers for core API calls (such as `.run`)
    which take into account CLI parser flags, configuration files, and/or
    changes made at runtime. It also acts as a proxy for its `~.Context.config`
    attribute - see that attribute's documentation for details.

    Instances of `.Context` may be shared between tasks when executing
    sub-tasks - either the same context the caller was given, or an altered
    copy thereof (or, theoretically, a brand new one).

    .. versionadded:: 1.0
    """

    # NOTE: sometime after Sphinx 1.7, autodoc stopped being able to see
    # doc-comments inside __init__ (or something equivalent, anyway). Moving
    # the type definitions up here seems to work better and /shouldn't/ mess up
    # the DataProxy magic going on...

    #: A list of commands to run (via "&&") before the main argument to any
    #: `run` or `sudo` calls. Note that the primary API for manipulating
    #: this list is `prefix`; see its docs for details.
    command_prefixes: List[str]
    #: A list of directories to 'cd' into before running commands with
    #: `run` or `sudo`; intended for management via `cd`, please see its
    #: docs for details.
    command_cwds: List[str]
    #: The CLI parser's 'remainder' value (text given after a standalone
    #: ``--`` in the command line), or the empty string if not given.
    remainder: str

    def __init__(
        self,
        config: Optional[Config] = None,
        remainder: str = "",
    ) -> None:
        """
        :param config:
            `.Config` object to use as the base configuration.

            Defaults to an anonymous/default `.Config` instance.

        :param remainder:
            The invoking program&#x27;s :ref:`parser remainder <remainder>` value,
            if any was obtained.
        """
        config = config if config is not None else Config()
        self._set(
            _config=config,
            command_prefixes=[],
            command_cwds=[],
            remainder=remainder,