gitws.gitwsmanifestformat module

Our Own Manifest Format.

class gitws.gitwsmanifestformat.GitWSManifestFormat[source]

Bases: ManifestFormat

Our Manifest Format.

dump(spec: ManifestSpec, path: Optional[Path] = None) → str[source]

Return ManifestSpec As String.

Parameters:: spec – Manifest Spec
Keyword Arguments:: path – Path To Possibly Existing Document.

is_compatible(path: Path) → bool[source]: Check If File At path Is Compatible.

load(path: Path) → ManifestSpec[source]

Load Manifest From path.

Raises:

ManifestNotFoundError – if file is not found
ManifestError – On Syntax Or Data Scheme Errors.

prio: int = -1: Manifest Format Priority In Case Of Multiple Matching Formats.

upgrade(path: Path)[source]: Upgrade ManifestSpec at path To Latest Version Including Documentation.

gitws.gitwsmanifestformat.dump(spec: ManifestSpec, path: Optional[Path] = None) → str

Return ManifestSpec As String.

Parameters:: spec – Manifest Spec
Keyword Arguments:: path – Path To Possibly Existing Document.

gitws.gitwsmanifestformat.load(path: Path) → ManifestSpec

Load Manifest From path.

Raises:

ManifestNotFoundError – if file is not found
ManifestError – On Syntax Or Data Scheme Errors.

gitws.gitwsmanifestformat.upgrade(path: Path): Upgrade ManifestSpec at path To Latest Version Including Documentation.