Skip to content

runtime.context

Context

Bases: collections.UserDict[str, t.Any]

Context is a dict-like object that serves as the shared execution state for all arc component

Source code in /home/runner/work/arc/arc/arc/runtime/context.py 
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
class Context(collections.UserDict[str, t.Any]):
    """Context is a dict-like object that serves as
    the shared execution state for all `arc` component
    """

    @property
    def root(self) -> Command:
        """The root command object. Alias for `ctx["arc.root"]`"""
        return self["arc.root"]

    @property
    def command(self) -> Command:
        """The command object being executed. Alias for `ctx["arc.command"]`"""
        return self["arc.command"]

    @property
    def state(self) -> dict[str, t.Any]:
        """The state object passed in. Alias for `ctx["arc.state"]`"""
        return self["arc.state"]

    @property
    def logger(self) -> Logger:
        """The arc logger. Alias for `ctx["arc.logger"]`"""
        return self["arc.logger"]

    @property
    def app(self) -> App:
        """The arc app. Alias for `ctx["arc.app"]`"""
        return self["arc.app"]

    @property
    def config(self) -> Config:
        """The configuration for this app. Alias for `ctx["arc.config"]`"""
        return self["arc.config"]

    @property
    def prompt(self) -> Prompt:
        """The prompt object congigured. Alias for `ctx["arc.config"].prompt`"""
        return self.config.prompt

    def execute(self, command: Command, **kwargs: t.Any) -> t.Any:
        """Execute a command within the context of another command
        ```py
        import arc

        @arc.command
        def command(ctx: arc.Context):
            ctx.execute(sub, val=2)

        @command.subcommand
        def sub(val: int):
            print(sub)
        ```

        """
        return self.app.execute(command, **kwargs)

    def set_origin(self, param_name: str, origin: str) -> None:
        """Sets the origin of a parameter"""
        origins = self.setdefault("arc.args.origins", {})
        origins[param_name] = origin

    @t.overload
    def get_origin(self, param_name: str) -> str | None:
        ...

    @t.overload
    def get_origin(self, param_name: str, default: T) -> str | T:
        ...

    def get_origin(self, param_name: str, default: T | None = None) -> str | T | None:
        """Gets the origin of a paramter"""
        origins: dict[str, str] | None = self.get("arc.args.origins")

        if not origins:
            return default

        return origins.get(param_name, default)

    @classmethod
    def __depends__(cls, ctx: Context) -> Context:
        """Makes the context a dependency"""
        return ctx

app: App property

The arc app. Alias for ctx["arc.app"]

command: Command property

The command object being executed. Alias for ctx["arc.command"]

config: Config property

The configuration for this app. Alias for ctx["arc.config"]

logger: Logger property

The arc logger. Alias for ctx["arc.logger"]

prompt: Prompt property

The prompt object congigured. Alias for ctx["arc.config"].prompt

root: Command property

The root command object. Alias for ctx["arc.root"]

state: dict[str, t.Any] property

The state object passed in. Alias for ctx["arc.state"]

__depends__(ctx) classmethod

Makes the context a dependency

Source code in /home/runner/work/arc/arc/arc/runtime/context.py 
 99
100
101
102
@classmethod
def __depends__(cls, ctx: Context) -> Context:
    """Makes the context a dependency"""
    return ctx

execute(command, **kwargs)

Execute a command within the context of another command 

import arc

@arc.command
def command(ctx: arc.Context):
    ctx.execute(sub, val=2)

@command.subcommand
def sub(val: int):
    print(sub)

Source code in /home/runner/work/arc/arc/arc/runtime/context.py 
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
def execute(self, command: Command, **kwargs: t.Any) -> t.Any:
    """Execute a command within the context of another command
    ```py
    import arc

    @arc.command
    def command(ctx: arc.Context):
        ctx.execute(sub, val=2)

    @command.subcommand
    def sub(val: int):
        print(sub)
    ```

    """
    return self.app.execute(command, **kwargs)

get_origin(param_name, default=None)

Gets the origin of a paramter

Source code in /home/runner/work/arc/arc/arc/runtime/context.py 
90
91
92
93
94
95
96
97
def get_origin(self, param_name: str, default: T | None = None) -> str | T | None:
    """Gets the origin of a paramter"""
    origins: dict[str, str] | None = self.get("arc.args.origins")

    if not origins:
        return default

    return origins.get(param_name, default)

set_origin(param_name, origin)

Sets the origin of a parameter

Source code in /home/runner/work/arc/arc/arc/runtime/context.py 
77
78
79
80
def set_origin(self, param_name: str, origin: str) -> None:
    """Sets the origin of a parameter"""
    origins = self.setdefault("arc.args.origins", {})
    origins[param_name] = origin