:py:mod:`wfexs_backend.utils.contents`
======================================

.. py:module:: wfexs_backend.utils.contents

.. autodoc2-docstring:: wfexs_backend.utils.contents
   :allowtitles:

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

Functions
~~~~~~~~~

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

   * - :py:obj:`GetGeneratedDirectoryContent <wfexs_backend.utils.contents.GetGeneratedDirectoryContent>`
     - .. autodoc2-docstring:: wfexs_backend.utils.contents.GetGeneratedDirectoryContent
          :summary:
   * - :py:obj:`GetGeneratedDirectoryContentFromList <wfexs_backend.utils.contents.GetGeneratedDirectoryContentFromList>`
     - .. autodoc2-docstring:: wfexs_backend.utils.contents.GetGeneratedDirectoryContentFromList
          :summary:
   * - :py:obj:`MaterializedContent2AbstractGeneratedContent <wfexs_backend.utils.contents.MaterializedContent2AbstractGeneratedContent>`
     - .. autodoc2-docstring:: wfexs_backend.utils.contents.MaterializedContent2AbstractGeneratedContent
          :summary:
   * - :py:obj:`Path2AbstractGeneratedContent <wfexs_backend.utils.contents.Path2AbstractGeneratedContent>`
     - .. autodoc2-docstring:: wfexs_backend.utils.contents.Path2AbstractGeneratedContent
          :summary:
   * - :py:obj:`CWLDesc2Content <wfexs_backend.utils.contents.CWLDesc2Content>`
     - .. autodoc2-docstring:: wfexs_backend.utils.contents.CWLDesc2Content
          :summary:
   * - :py:obj:`copy2_nofollow <wfexs_backend.utils.contents.copy2_nofollow>`
     - .. autodoc2-docstring:: wfexs_backend.utils.contents.copy2_nofollow
          :summary:
   * - :py:obj:`copy_nofollow <wfexs_backend.utils.contents.copy_nofollow>`
     - .. autodoc2-docstring:: wfexs_backend.utils.contents.copy_nofollow
          :summary:
   * - :py:obj:`link_or_copy <wfexs_backend.utils.contents.link_or_copy>`
     - .. autodoc2-docstring:: wfexs_backend.utils.contents.link_or_copy
          :summary:
   * - :py:obj:`link_or_copy_pathlib <wfexs_backend.utils.contents.link_or_copy_pathlib>`
     - .. autodoc2-docstring:: wfexs_backend.utils.contents.link_or_copy_pathlib
          :summary:
   * - :py:obj:`link_or_symlink_pathlib <wfexs_backend.utils.contents.link_or_symlink_pathlib>`
     - .. autodoc2-docstring:: wfexs_backend.utils.contents.link_or_symlink_pathlib
          :summary:
   * - :py:obj:`real_unlink_if_exists <wfexs_backend.utils.contents.real_unlink_if_exists>`
     - .. autodoc2-docstring:: wfexs_backend.utils.contents.real_unlink_if_exists
          :summary:
   * - :py:obj:`bin2dataurl <wfexs_backend.utils.contents.bin2dataurl>`
     - .. autodoc2-docstring:: wfexs_backend.utils.contents.bin2dataurl
          :summary:

Data
~~~~

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

   * - :py:obj:`CWLClass2WfExS <wfexs_backend.utils.contents.CWLClass2WfExS>`
     - .. autodoc2-docstring:: wfexs_backend.utils.contents.CWLClass2WfExS
          :summary:

API
~~~

.. py:function:: GetGeneratedDirectoryContent(thePath: wfexs_backend.common.PathLikePath, uri: Optional[LicensedURI] = None, preferredFilename: Optional[RelPath] = None, signatureMethod: Optional[FingerprintMethod] = None) -> wfexs_backend.common.GeneratedDirectoryContent
   :canonical: wfexs_backend.utils.contents.GetGeneratedDirectoryContent

   .. autodoc2-docstring:: wfexs_backend.utils.contents.GetGeneratedDirectoryContent

.. py:function:: GetGeneratedDirectoryContentFromList(thePath: wfexs_backend.common.PathLikePath, theValues: Sequence[AbstractGeneratedContent], uri: Optional[LicensedURI] = None, preferredFilename: Optional[RelPath] = None, secondaryFiles: Optional[Sequence[AbstractGeneratedContent]] = None, signatureMethod: Optional[FingerprintMethod] = None) -> wfexs_backend.common.GeneratedDirectoryContent
   :canonical: wfexs_backend.utils.contents.GetGeneratedDirectoryContentFromList

   .. autodoc2-docstring:: wfexs_backend.utils.contents.GetGeneratedDirectoryContentFromList

.. py:function:: MaterializedContent2AbstractGeneratedContent(mat_content: wfexs_backend.common.MaterializedContent, preferredFilename: Optional[RelPath] = None, signatureMethod: Optional[FingerprintMethod] = nihDigester) -> wfexs_backend.common.AbstractGeneratedContent
   :canonical: wfexs_backend.utils.contents.MaterializedContent2AbstractGeneratedContent

   .. autodoc2-docstring:: wfexs_backend.utils.contents.MaterializedContent2AbstractGeneratedContent

.. py:function:: Path2AbstractGeneratedContent(content: pathlib.Path, preferredFilename: Optional[RelPath] = None, signatureMethod: Optional[FingerprintMethod] = nihDigester) -> wfexs_backend.common.AbstractGeneratedContent
   :canonical: wfexs_backend.utils.contents.Path2AbstractGeneratedContent

   .. autodoc2-docstring:: wfexs_backend.utils.contents.Path2AbstractGeneratedContent

.. py:data:: CWLClass2WfExS
   :canonical: wfexs_backend.utils.contents.CWLClass2WfExS
   :value: None

   .. autodoc2-docstring:: wfexs_backend.utils.contents.CWLClass2WfExS

.. py:function:: CWLDesc2Content(cwlDescs: Union[Mapping[str, Any], Sequence[Mapping[str, Any]]], logger: logging.Logger, expectedOutput: Optional[ExpectedOutput] = None, doGenerateSignatures: bool = False) -> Sequence[AbstractGeneratedContent]
   :canonical: wfexs_backend.utils.contents.CWLDesc2Content

   .. autodoc2-docstring:: wfexs_backend.utils.contents.CWLDesc2Content

.. py:function:: copy2_nofollow(src: wfexs_backend.common.PathLikePath, dest: wfexs_backend.common.PathLikePath) -> None
   :canonical: wfexs_backend.utils.contents.copy2_nofollow

   .. autodoc2-docstring:: wfexs_backend.utils.contents.copy2_nofollow

.. py:function:: copy_nofollow(src: wfexs_backend.common.PathLikePath, dest: wfexs_backend.common.PathLikePath) -> None
   :canonical: wfexs_backend.utils.contents.copy_nofollow

   .. autodoc2-docstring:: wfexs_backend.utils.contents.copy_nofollow

.. py:function:: link_or_copy(src: wfexs_backend.common.PathLikePath, dest: wfexs_backend.common.PathLikePath, force_copy: bool = False, preserve_attrs: bool = True) -> None
   :canonical: wfexs_backend.utils.contents.link_or_copy

   .. autodoc2-docstring:: wfexs_backend.utils.contents.link_or_copy

.. py:function:: link_or_copy_pathlib(src: pathlib.Path, dest: pathlib.Path, force_copy: bool = False, preserve_attrs: bool = True) -> None
   :canonical: wfexs_backend.utils.contents.link_or_copy_pathlib

   .. autodoc2-docstring:: wfexs_backend.utils.contents.link_or_copy_pathlib

.. py:function:: link_or_symlink_pathlib(src: pathlib.Path, dest: pathlib.Path, force_symlink: bool = False) -> None
   :canonical: wfexs_backend.utils.contents.link_or_symlink_pathlib

   .. autodoc2-docstring:: wfexs_backend.utils.contents.link_or_symlink_pathlib

.. py:function:: real_unlink_if_exists(the_path: wfexs_backend.common.PathLikePath, fail_ok: bool = False) -> None
   :canonical: wfexs_backend.utils.contents.real_unlink_if_exists

   .. autodoc2-docstring:: wfexs_backend.utils.contents.real_unlink_if_exists

.. py:function:: bin2dataurl(content: bytes) -> wfexs_backend.common.URIType
   :canonical: wfexs_backend.utils.contents.bin2dataurl

   .. autodoc2-docstring:: wfexs_backend.utils.contents.bin2dataurl