MigrationReport

Note

This page is a reference documentation. It only explains the class signature, and not how to use it. Please refer to the Habitat Guide and Python API guide (v2.0) for usage.

class MigrationReport(source: Path, destination: Path | None, workflow: str, document: Dict[str, Any], diff: str, warnings: Tuple[str, ...] = ())[source]

Bases: object

Outcome of one migrate_yaml call.

source

The v0 file read.

Type:: pathlib.Path

destination

The v1 file written; None for a dry run.

Type:: pathlib.Path | None

workflow

Workflow alias detected or supplied.

Type:: str

document

The translated v1 document payload.

Type:: Dict[str, Any]

diff

Unified diff between the source text and the v1 text.

Type:: str

warnings

Translation warnings, see LegacyTranslation.

Type:: Tuple[str, …]

__init__(source: Path, destination: Path | None, workflow: str, document: Dict[str, Any], diff: str, warnings: Tuple[str, ...] = ()) → None