pystac.extensions.hooks#

class pystac.extensions.hooks.ExtensionHooks[source]#

get_deprecation_message(obj: STACObject) → str | None[source]#

Return a warning message if obj is deprecated per this extension.

Emitted as a pystac.DeprecatedWarning when loading an object from a dict. The base implementation returns None (not deprecated).

get_object_links(obj: STACObject) → list[str | pystac.RelType] | None[source]#

migrate(obj: dict[str, Any], version: STACVersionID, info: STACJSONDescription) → None[source]#: Migrate a STAC Object in dict format from a previous version. The base implementation will update the stac_extensions to the latest schema ID. This method will only be called for STAC objects that have been identified as a previous version of STAC. Implementations should directly manipulate the obj dict. Remember to call super() in order to change out the old ‘stac_extension’ entry with the latest schema URI.

abstract property prev_extension_ids: set[str]#: A set of previous extension IDs (schema URIs or old short ids) that should be migrated to the latest schema URI in the ‘stac_extensions’ property. Override with a class attribute so that the set of previous IDs is only created once.

abstract property schema_uri: str#: The schema_uri for the current version of this extension

abstract property stac_object_types: set[STACObjectType]#: A set of STACObjectType for which migration logic will be applied.

class pystac.extensions.hooks.RegisteredExtensionHooks(hooks: Iterable[ExtensionHooks] = ())[source]#

get_extended_object_links(obj: STACObject) → list[str | pystac.RelType][source]#

migrate(obj: dict[str, Any], version: STACVersionID, info: STACJSONDescription) → None[source]#