ConstVar, DistSource

ConstVarclassdataclass#

Re-exported from ocx_sdk._typesView source

class ConstVar(value: str)

An [env] value that replaces whatever the parent env had.

valueattributeinstance attribute#

View source

value: str

DistSourceclassdataclass#

Re-exported from ocx_sdk._distView source

class DistSource(manifest_url: str | None = None, manifest_path: Path | None = None, manifest_data: bytes | None = None, sha256: str | None = None, auth: Auth | None = None, headers: Mapping[str, str] = _NO_HEADERS)

Where a dist manifest comes from, and how its body is trusted.

Build one with url(), path(), or data() rather than the constructor. A source with no location at all is the canonical default: it resolves to OCX_INSTALL_DIST_URL when the environment sets one, and to DEFAULT_DIST_URL otherwise. A source built with an explicit URL never consults the environment.

Attributes

Name	Type	Description
manifest_url	str | None	Explicit manifest URL, or None for the default source.
manifest_path	Path | None	Local manifest file.
manifest_data	bytes | None	Manifest bytes the caller already holds.
sha256	str | None	Expected digest of the manifest body. Auto-derived from a dist/<sha256>.json URL, and required for any URL source that is off-canonical or paired with a mirror.
auth	Auth | None	Credentials for the manifest host, bound to its origin.
headers	Mapping[str, str]	Extra request headers, bound to the same origin.

Example

DistSource.url().manifest_url is None True

manifest_dataattributeclass attributeinstance attribute#

View source

manifest_data: bytes | None = field(default=None, repr=False)

manifest_pathattributeclass attributeinstance attribute#

View source

manifest_path: Path | None = None

manifest_urlattributeclass attributeinstance attribute#

View source

manifest_url: str | None = None

sha256attributeclass attributeinstance attribute#

View source

sha256: str | None = None