Class ExplainFile

misc/python/materialize/mzexplore/common.py:217–263

@dataclass(frozen=True)
class ExplainFile:
    database: str
    schema: str
    name: str
    suffix: str | None
    item_type: ItemType
    explainee_type: ExplaineeType
    stage: ExplainStage
    ext: str

    def file_name(self) -> str:
        return ".".join(
            str(part)
            for part in [
                self.name,
                self.explainee_type,
                self.stage.name.lower(),
                self.suffix,
                "json" if self.stage == ExplainStage.OPTIMIZER_TRACE else self.ext,
            ]
            if part
        )

    def folder(self) -> Path:
        return Path(self.item_type.value, self.database, self.schema)

    def path(self) -> Path:
        return self.folder() / self.file_name()

    def __str__(self) -> str:
        return str(self.path())

    def skip(self) -> bool:
        # Skip items with database, schema, or item names that contain a `/`
        # (not a valid UNIX folder character).
        if "/" in self.database:
            warn(f"Skip processing of item with bad database name: `{self.database}`")
            return True
        elif "/" in self.schema:
            warn(f"Skip processing of item with bad schema name: `{self.schema}`")
            return True
        elif "/" in self.name:
            warn(f"Skip processing of item with bad item name: `{self.name}`")
            return True
        # All good!
        else:
            return False


def explain_file(path: Path) -> ExplainFile | None: