Skip to content

ReEDSUpgrader

Source

Upgrader class for ReEDS files.

>>> from r2x_reeds import ReEDSUpgrader
>>> assert ReEDSUpgrader is not None

Bases: . Inherited contracts remain defined by the base classes.

These fields are declared on this class. Required/default behavior is shown directly from source. Base-class fields also apply.

steps: ClassVar[list[UpgradeStep]] = list(UPGRADE_STEPS)
version_reader: ClassVar[VersionReader] = ReEDSVersionDetector()
version_strategy: ClassVar[VersionStrategy] = SemanticVersioningStrategy()

Source

upgrade(self, *, current_version: str | None=None, target_version: str | None=None, strategy: VersionStrategy | None=None, upgrader_context: dict[str, object] | None=None, upgrade_type: UpgradeType=UpgradeType.FILE) -> Result[Path, str]

Run ReEDS upgrade steps for the configured folder.

Continue with the Python API overview and transform contracts.