Class SingleStageFile

dvc/dvcfile.py:172–220

class SingleStageFile(FileMixin):
    from dvc.schema import COMPILED_SINGLE_STAGE_SCHEMA as SCHEMA
    from dvc.stage.loader import SingleStageLoader as LOADER  # noqa: N814

    datasets: ClassVar[list[dict[str, Any]]] = []
    datasets_lock: ClassVar[list[dict[str, Any]]] = []
    metrics: ClassVar[list[str]] = []
    plots: ClassVar[Any] = {}
    params: ClassVar[list[str]] = []
    artifacts: ClassVar[dict[str, Optional[dict[str, Any]]]] = {}

    @property
    def stage(self) -> "Stage":
        data, raw = self._load()
        return self.LOADER.load_stage(self, data, raw)

    @property
    def stages(self) -> LOADER:
        data, raw = self._load()
        return self.LOADER(self, data, raw)

    def dump(self, stage, **kwargs) -> None:
        """Dumps given stage appropriately in the dvcfile."""
        from dvc.stage import PipelineStage

        assert not isinstance(stage, PipelineStage)
        if self.verify:
            check_dvcfile_path(self.repo, self.path)
        logger.debug("Saving information to '%s'.", relpath(self.path))
        dump_yaml(self.path, serialize.to_single_stage_file(stage, **kwargs))
        self.repo.scm_context.track_file(self.relpath)

    def dump_stages(self, stages, **kwargs) -> None:
        if not stages:
            return None

        assert len(stages) == 1, "SingleStageFile can only dump one stage."
        return self.dump(stages[0], **kwargs)

    def remove_stage(self, stage):  # noqa: ARG002
        self.remove()

    def merge(self, ancestor, other, allowed=None):
        assert isinstance(ancestor, SingleStageFile)
        assert isinstance(other, SingleStageFile)

        stage = self.stage
        stage.merge(ancestor.stage, other.stage, allowed=allowed)
        self.dump(stage)


class ProjectFile(FileMixin):