EnvReport (1 of 2)

EnvReportclassdataclass#

Re-exported from ocx_sdk._resultsView source

class EnvReport(entries: tuple[EnvEntry, ...] = (), binaries: tuple[PackageBinding, ...] = (), entrypoints: tuple[PackageBinding, ...] = (), integrations: tuple[Integration, ...] = (), advisories: tuple[Advisory, ...] = (), _base: Mapping[str, str] = _EMPTY)

ocx env and ocx package env — the same five-array envelope, both tiers.

Iterating the report iterates entries: composing an environment is what it is for, and the other four arrays are description.

Attributes

Name	Type	Description
entries	tuple[EnvEntry, ...]	The [env] contributions, in declaration order.
binaries	tuple[PackageBinding, ...]	Executables the packages put on PATH. Pre-1.0, may break.
entrypoints	tuple[PackageBinding, ...]	Named entrypoints the packages declare. Pre-1.0, may break.
integrations	tuple[Integration, ...]	Tool integrations, payloads untyped. Pre-1.0, may break.
advisories	tuple[Advisory, ...]	Warnings about the composition. Pre-1.0, may break.

The four non-entry arrays carry ocx’s package which-style caveat: they are not on ocx’s durable-anchor list, so their shape may change in a minor release. entries is the part the SDK depends on.

Example

>>> wire = '{"entries": [{"key": "TOOL", "type": "constant", "value": "1"}],'
>>> wire += ' "binaries": [], "entrypoints": [], "integrations": [], "advisories": []}'
>>> [entry.key for entry in EnvReport.from_json(wire)]
['TOOL']

advisoriesattributeclass attributeinstance attribute#

View source

advisories: tuple[Advisory, ...] = ()

binariesattributeclass attributeinstance attribute#

View source

binaries: tuple[PackageBinding, ...] = ()

entriesattributeclass attributeinstance attribute#

View source

entries: tuple[EnvEntry, ...] = ()

entrypointsattributeclass attributeinstance attribute#

View source

entrypoints: tuple[PackageBinding, ...] = ()

integrationsattributeclass attributeinstance attribute#

View source

integrations: tuple[Integration, ...] = ()