Skip to content
ocx
install

AboutInfo, Advisory

AboutInfoclassdataclass#

Re-exported from ocx_sdk._resultsView source

from_jsonmethodclassmethod#

def from_json(raw: str) -> AboutInfo

Parse ocx --format json about output.

Advisoryclassdataclass#

Re-exported from ocx_sdk._resultsView source
class Advisory(kind: str, package: str, message: str, key: str | None = None)

Something ocx wants the caller to know about a composed environment.

Attributes

NameTypeDescription
kindstrThe machine discriminator to branch on, never message.
packagestrThe package the advisory is about.
messagestrThe human rendering of the same fact.
keystr | NoneThe environment variable named, or None for an advisory that names none. Absent-when-unused (D7): env.rs:175 skips the key, and the undeclared-binaries variant (env.rs:189) emits no key at all, so reading it as required crashes env() outright.

keyattributeclass attributeinstance attribute#

key: str | None = None

kindattributeinstance attribute#

kind: str

messageattributeinstance attribute#

message: str

packageattributeinstance attribute#

package: str

refproperty#

ref: PackageRef

The package the advisory is about, as a PackageRef.

from_dictmethodclassmethod#

def from_dict(data: Mapping[str, Any]) -> Advisory

Build from one decoded advisories entry.