kedro.inspection.models¶

Read-only snapshot of an entire Kedro project.

Attributes:

• metadata (ProjectMetadataSnapshot) –

  Snapshot of the project's metadata (name, package, Kedro version).

• pipelines (list[PipelineSnapshot]) –

  Ordered list of snapshots for every registered pipeline.

• datasets (dict[str, DatasetSnapshot]) –

  Mapping from dataset name to its snapshot, including entries resolved from factory patterns.

• parameters (list[str]) –

  Sorted list of parameter key strings (values are not stored).

Read-only snapshot of project metadata derived from pyproject.toml.

Attributes:

• project_name (str) –

  Human-readable project name.

• package_name (str) –

  Python package name for the project.

• kedro_version (str) –

  Kedro package version from project metadata (pyproject.toml).

Read-only snapshot of a registered pipeline.

Attributes:

• name (str) –

  Pipeline registry key (e.g. "__default__", "data_science").

• nodes (list[NodeSnapshot]) –

  Ordered list of node snapshots in topological execution order.

• inputs (list[str]) –

  Sorted list of free pipeline inputs.

• outputs (list[str]) –

  Sorted list of final pipeline outputs.

Read-only snapshot of a single pipeline node.

Attributes:

• name (str) –

  Fully-qualified node name (includes namespace prefix if present).

• namespace (str | None) –

  Node namespace, or None if the node has no namespace.

• tags (list[str]) –

  Sorted list of tags assigned to the node.

• inputs (list[str]) –

  Ordered list of input dataset names.

• outputs (list[str]) –

  Ordered list of output dataset names.

Read-only snapshot of a catalog dataset entry.

Attributes:

• name (str) –

  Dataset name as it appears in the catalog.

• type (str) –

  Dataset type string (e.g. "pandas.CSVDataset").

• filepath (str | None) –

  File path if present in config, or None.

from_config(name, config)

41
42
43
44
45
46
47
48
49
50
51

@classmethod
def from_config(cls, name: str, config: dict) -> DatasetSnapshot:
    """Construct a ``DatasetSnapshot`` from a raw catalog config entry."""
    filepath = config.get("filepath")
    if filepath:
        filepath = _CREDENTIAL_RE.sub(r"\1<redacted>\2", filepath)
    return cls(
        name=name,
        type=config.get("type", ""),
        filepath=filepath,
    )