yera.ui.updates.metadata

Release metadata validation and installed-version comparison.

Symbols

def available_update — Return metadata when it describes a newer Yera release.
class ReleaseMetadata — Validated metadata describing the latest stable Yera release.

available_update

available_update(
    metadata: ReleaseMetadata,
    installed_version: str,
) → ReleaseMetadata | None

Return metadata when it describes a newer Yera release.

Parameters

metadata
type: ReleaseMetadata

Validated stable release metadata.

installed_version
type: str

Version of the locally installed Yera package.

Returns

type: ReleaseMetadata | None

The supplied metadata when its version is newer, otherwise None.

Raises

InvalidVersion

If the installed version is not a valid package version.

ReleaseMetadata

Inherits: BaseModel

Validated metadata describing the latest stable Yera release.

Fields

schema_version
type: Literal[1] (required)
package
type: Literal['yera'] (required)
channel
type: Literal['stable'] (required)
latest_version
type: str (required)
release_url
type: pydantic.networks.HttpUrl (required)
documentation_url
type: pydantic.networks.HttpUrl (required)

Methods

validate_stable_version — Require a valid public stable Python package version.
validate_https_url — Require release links to use HTTPS.

ReleaseMetadata.validate_stable_version

validate_stable_version(
    value: str,
) → str

Require a valid public stable Python package version.

Parameters

value
type: str

Advertised Yera version.

Returns

type: str

The validated version string.

Raises

ValueError

If the value is not a valid stable public version.

ReleaseMetadata.validate_https_url

validate_https_url(
    value: HttpUrl,
) → HttpUrl

Require release links to use HTTPS.

Parameters

value
type: HttpUrl

Parsed release or documentation URL.

Returns

type: HttpUrl

The validated HTTPS URL.

Raises

ValueError

If the URL does not use HTTPS.