Skip to content
ocx
install

PackageRef, PathVar, Resolve

Resolveattribute#

Re-exported from ocx_sdk._clientView source
Resolve

Which $OCX_HOME symlink a package-tier call resolves through.

'candidate' is the installed version’s own link, 'current' the selected one. Omitting it leaves the choice to ocx, which is the usual answer.

PackageRefclassdataclass#

Re-exported from ocx_sdk._typesView source
class PackageRef(identifier: str, metadata: Mapping[str, object] = _NO_METADATA)

A package identifier carried verbatim from ocx, never parsed.

ocx owns the identifier grammar. The SDK stores the string it was given and hands it back unchanged, so a ref that came out of one result flows into the next call’s argv byte-for-byte.

Identity is the identifier alone. metadata is decoration carried along from whichever JSON row produced the ref, so two refs to the same package from different commands must not compare unequal. The mapping is copied and made read-only at construction (and is therefore not picklable).

identifierattributeinstance attribute#

View source
identifier: str

metadataattributeclass attributeinstance attribute#

View source
metadata: Mapping[str, object] = _NO_METADATA

PathVarclassdataclass#

Re-exported from ocx_sdk._typesView source
class PathVar(value: str)

An [env] value prepended to a PATH-like variable, deduplicated.

valueattributeinstance attribute#

View source
value: str