Class Directory

sdk/python/src/dagger/client/gen.py:4308–5209

A directory.

@typecheck
class Directory(Type):
    """A directory."""

    def as_git(self) -> "GitRepository":
        """Converts this directory to a local git repository"""
        _args: list[Arg] = []
        _ctx = self._select("asGit", _args)
        return GitRepository(_ctx)

    def as_module(
        self,
        *,
        source_root_path: str | None = ".",
    ) -> "Module":
        """Load the directory as a Dagger module source

        Parameters
        ----------
        source_root_path:
            An optional subpath of the directory which contains the module's
            configuration file.
            If not set, the module source code is loaded from the root of the
            directory.
        """
        _args = [
            Arg("sourceRootPath", source_root_path, "."),
        ]
        _ctx = self._select("asModule", _args)
        return Module(_ctx)

    def as_module_source(
        self,
        *,
        source_root_path: str | None = ".",
    ) -> "ModuleSource":
        """Load the directory as a Dagger module source

        Parameters
        ----------
        source_root_path:
            An optional subpath of the directory which contains the module's
            configuration file.
            If not set, the module source code is loaded from the root of the
            directory.
        """
        _args = [
            Arg("sourceRootPath", source_root_path, "."),
        ]
        _ctx = self._select("asModuleSource", _args)
        return ModuleSource(_ctx)

    def changes(self, from_: Self) -> Changeset:
        """Return the difference between this directory and another directory,
        typically an older snapshot.

        The difference is encoded as a changeset, which also tracks removed
        files, and can be applied to other directories.