Skip to content
ocx
install

PackageDescription

PackageDescriptionclassdataclass#

Re-exported from ocx_sdk._resultsView source
class PackageDescription(title: str | None, description: str | None, keywords: str | None)

One package’s description metadata, from package description pull (C-021, D4).

api/data/package_description.rs’s Inner — every field is optional upstream, but carries no skip_serializing_if, so all three keys are always present and null when unset — not absent-when-empty. D7 therefore wants str | None with no Python default, parsed via _need, not data.get(). An all-None instance is still a real, valid value either way: it is distinct from the None entry InfoResult uses when the registry holds no description at all.

Attributes

NameTypeDescription
titlestr | NoneThe package’s display title.
descriptionstr | NoneIts prose description.
keywordsstr | NoneA single delimited string upstream, not a list — do not split it into a collection here.

descriptionattributeinstance attribute#

description: str | None

keywordsattributeinstance attribute#

keywords: str | None

titleattributeinstance attribute#

title: str | None

from_dictmethodclassmethod#

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

Build from one non-null value of package description pull’s keyed object.