:py:mod:`wfexs_backend.pushers.cache_export`
============================================

.. py:module:: wfexs_backend.pushers.cache_export

.. autodoc2-docstring:: wfexs_backend.pushers.cache_export
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`CacheExportPlugin <wfexs_backend.pushers.cache_export.CacheExportPlugin>`
     - .. autodoc2-docstring:: wfexs_backend.pushers.cache_export.CacheExportPlugin
          :summary:

API
~~~

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

   Bases: :py:obj:`wfexs_backend.pushers.abstract_contexted_export.AbstractContextedExportPlugin`

   .. autodoc2-docstring:: wfexs_backend.pushers.cache_export.CacheExportPlugin

   .. rubric:: Initialization

   .. autodoc2-docstring:: wfexs_backend.pushers.cache_export.CacheExportPlugin.__init__

   .. py:attribute:: PLUGIN_NAME
      :canonical: wfexs_backend.pushers.cache_export.CacheExportPlugin.PLUGIN_NAME
      :value: 'cast(...)'

      .. autodoc2-docstring:: wfexs_backend.pushers.cache_export.CacheExportPlugin.PLUGIN_NAME

   .. py:attribute:: ENABLED
      :canonical: wfexs_backend.pushers.cache_export.CacheExportPlugin.ENABLED
      :type: ClassVar[bool]
      :value: True

      .. autodoc2-docstring:: wfexs_backend.pushers.cache_export.CacheExportPlugin.ENABLED

   .. py:method:: book_pid(preferred_id: Optional[str] = None, initially_required_metadata: Optional[Mapping[str, Any]] = None, initially_required_community_specific_metadata: Optional[Mapping[str, Any]] = None, title: Optional[str] = None, description: Optional[str] = None, licences: Sequence[LicenceDescription] = [], resolved_orcids: Sequence[ResolvedORCID] = []) -> Optional[DraftEntry]
      :canonical: wfexs_backend.pushers.cache_export.CacheExportPlugin.book_pid

   .. py:method:: discard_booked_pid(pid_or_draft: Union[str, DraftEntry]) -> bool
      :canonical: wfexs_backend.pushers.cache_export.CacheExportPlugin.discard_booked_pid

      .. autodoc2-docstring:: wfexs_backend.pushers.cache_export.CacheExportPlugin.discard_booked_pid

   .. py:method:: get_pid_metadata(pid: str) -> Optional[Mapping[str, Any]]
      :canonical: wfexs_backend.pushers.cache_export.CacheExportPlugin.get_pid_metadata

      .. autodoc2-docstring:: wfexs_backend.pushers.cache_export.CacheExportPlugin.get_pid_metadata

   .. py:method:: push(items: Sequence[AnyContent], preferred_id: Optional[str] = None, title: Optional[str] = None, description: Optional[str] = None, licences: Sequence[LicenceDescription] = [], resolved_orcids: Sequence[ResolvedORCID] = [], metadata: Optional[Mapping[str, Any]] = None, community_specific_metadata: Optional[Mapping[str, Any]] = None) -> Sequence[URIWithMetadata]
      :canonical: wfexs_backend.pushers.cache_export.CacheExportPlugin.push