Class Host

sdk/python/src/dagger/client/gen.py:10005–10218

Information about the host environment.

@typecheck
class Host(Type):
    """Information about the host environment."""

    def container_image(self, name: str) -> Container:
        """Accesses a container image on the host.

        Parameters
        ----------
        name:
            Name of the image to access.
        """
        _args = [
            Arg("name", name),
        ]
        _ctx = self._select("containerImage", _args)
        return Container(_ctx)

    def directory(
        self,
        path: str,
        *,
        exclude: list[str] | None = None,
        include: list[str] | None = None,
        no_cache: bool | None = False,
        gitignore: bool | None = False,
    ) -> Directory:
        """Accesses a directory on the host.

        Parameters
        ----------
        path:
            Location of the directory to access (e.g., ".").
        exclude:
            Exclude artifacts that match the given pattern (e.g.,
            ["node_modules/", ".git*"]).
        include:
            Include only artifacts that match the given pattern (e.g.,
            ["app/", "package.*"]).
        no_cache:
            If true, the directory will always be reloaded from the host.
        gitignore:
            Apply .gitignore filter rules inside the directory
        """
        _args = [
            Arg("path", path),
            Arg("exclude", [] if exclude is None else exclude, []),
            Arg("include", [] if include is None else include, []),
            Arg("noCache", no_cache, False),
            Arg("gitignore", gitignore, False),
        ]
        _ctx = self._select("directory", _args)
        return Directory(_ctx)

    def file(
        self,
        path: str,
        *,
        no_cache: bool | None = False,