wfexs_backend.pushers.cache_export#

Module Contents#

Classes#

CacheExportPlugin

Class to model exporting results to WfExS-backend cache

API#

class wfexs_backend.pushers.cache_export.CacheExportPlugin(refdir: pathlib.Path, setup_block: SecurityContextConfig | None = None, default_licences: Sequence[LicenceDescription] = [], default_orcids: Sequence[ResolvedORCID] = [], default_preferred_id: str | None = None)#

Bases: wfexs_backend.pushers.abstract_contexted_export.AbstractContextedExportPlugin

Class to model exporting results to WfExS-backend cache

Initialization

PLUGIN_NAME = 'cast(...)'#
ENABLED: ClassVar[bool] = True#
book_pid(preferred_id: str | None = None, initially_required_metadata: Mapping[str, Any] | None = None, initially_required_community_specific_metadata: Mapping[str, Any] | None = None, title: str | None = None, description: str | None = None, licences: Sequence[LicenceDescription] = [], resolved_orcids: Sequence[ResolvedORCID] = []) DraftEntry | None#
discard_booked_pid(pid_or_draft: str | DraftEntry) bool#

This method is used to release a previously booked PID, which has not been published.

When it returns False, it means that the provided id did exist, but it was not a draft

get_pid_metadata(pid: str) Mapping[str, Any] | None#

This method is used to obtained the metadata associated to a PID, in case the destination allows it.

push(items: Sequence[AnyContent], preferred_id: str | None = None, title: str | None = None, description: str | None = None, licences: Sequence[LicenceDescription] = [], resolved_orcids: Sequence[ResolvedORCID] = [], metadata: Mapping[str, Any] | None = None, community_specific_metadata: Mapping[str, Any] | None = None) Sequence[URIWithMetadata]#