httk.core.docs.semver

Strict, deliberately small Semantic Versioning helpers for documentation tags.

Exceptions

VersionError

Raised when text is not an exact X.Y.Z documentation version.

Classes

Version

One non-negative three-component documentation release version.

Functions

parse_version(→ Version)	Parse exactly X.Y.Z without prerelease or build metadata.
parse_tag(→ Version)	Parse exactly the release tag vX.Y.Z.
highest_version(→ Version | None)	Return the greatest version in versions, or None when empty.
is_release_dir_name(→ bool)	Return whether name is a valid release directory such as v2.1.0.

Module Contents

exception httk.core.docs.semver.VersionError

Bases: ValueError

Raised when text is not an exact X.Y.Z documentation version.

class httk.core.docs.semver.Version

One non-negative three-component documentation release version.

major: int

minor: int

patch: int

property tag: str

Return the canonical Git tag spelling, vX.Y.Z.

httk.core.docs.semver.parse_version(text: str) → Version

Parse exactly X.Y.Z without prerelease or build metadata.

httk.core.docs.semver.parse_tag(text: str) → Version

Parse exactly the release tag vX.Y.Z.

httk.core.docs.semver.highest_version(versions: collections.abc.Iterable[Version]) → Version | None

Return the greatest version in versions, or None when empty.

httk.core.docs.semver.is_release_dir_name(name: str) → bool

Return whether name is a valid release directory such as v2.1.0.