:py:mod:`wfexs_backend.container_factories.abstract_docker_container`
=====================================================================

.. py:module:: wfexs_backend.container_factories.abstract_docker_container

.. autodoc2-docstring:: wfexs_backend.container_factories.abstract_docker_container
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`AbstractDockerContainerFactory <wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory>`
     -

Data
~~~~

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

   * - :py:obj:`DOCKER_PROTO <wfexs_backend.container_factories.abstract_docker_container.DOCKER_PROTO>`
     - .. autodoc2-docstring:: wfexs_backend.container_factories.abstract_docker_container.DOCKER_PROTO
          :summary:

API
~~~

.. py:data:: DOCKER_PROTO
   :canonical: wfexs_backend.container_factories.abstract_docker_container.DOCKER_PROTO
   :value: None

   .. autodoc2-docstring:: wfexs_backend.container_factories.abstract_docker_container.DOCKER_PROTO

.. py:class:: AbstractDockerContainerFactory(simpleFileNameMethod: wfexs_backend.container_factories.ContainerFileNamingMethod, containersCacheDir: Optional[pathlib.Path] = None, stagedContainersDir: Optional[pathlib.Path] = None, progs_mapping: Optional[ProgsMapping] = None, engine_name: str = 'unset', tempDir: Optional[pathlib.Path] = None)
   :canonical: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory

   Bases: :py:obj:`wfexs_backend.container_factories.ContainerFactory`

   .. py:attribute:: ACCEPTED_CONTAINER_TYPES
      :canonical: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory.ACCEPTED_CONTAINER_TYPES
      :value: 'set(...)'

      .. autodoc2-docstring:: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory.ACCEPTED_CONTAINER_TYPES

   .. py:method:: AcceptsContainerType(container_type: Union[common.ContainerType, Set[common.ContainerType]]) -> bool
      :canonical: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory.AcceptsContainerType
      :classmethod:

      .. autodoc2-docstring:: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory.AcceptsContainerType

   .. py:method:: trimmable_manifest_keys() -> Sequence[str]
      :canonical: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory.trimmable_manifest_keys
      :abstractmethod:
      :classmethod:

      .. autodoc2-docstring:: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory.trimmable_manifest_keys

   .. py:method:: _gen_trimmed_manifests_signature(manifests: Sequence[DockerLikeManifest]) -> wfexs_backend.common.Fingerprint
      :canonical: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory._gen_trimmed_manifests_signature

      .. autodoc2-docstring:: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory._gen_trimmed_manifests_signature

   .. py:method:: variant_name() -> str
      :canonical: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory.variant_name
      :abstractmethod:
      :classmethod:

      .. autodoc2-docstring:: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory.variant_name

   .. py:method:: _images(matEnv: Mapping[str, str]) -> Tuple[ExitVal, str, str]
      :canonical: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory._images

      .. autodoc2-docstring:: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory._images

   .. py:method:: _inspect(dockerTag: str, matEnv: Mapping[str, str]) -> Tuple[ExitVal, str, str]
      :canonical: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory._inspect

      .. autodoc2-docstring:: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory._inspect

   .. py:method:: _pull(dockerTag: str, matEnv: Mapping[str, str]) -> Tuple[ExitVal, str, str]
      :canonical: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory._pull

      .. autodoc2-docstring:: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory._pull

   .. py:method:: _tag(dockerPullTag: str, dockerTag: str, matEnv: Mapping[str, str]) -> Tuple[ExitVal, str, str]
      :canonical: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory._tag

      .. autodoc2-docstring:: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory._tag

   .. py:method:: _rmi(dockerTag: str, matEnv: Mapping[str, str]) -> Tuple[ExitVal, str, str]
      :canonical: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory._rmi

      .. autodoc2-docstring:: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory._rmi

   .. py:method:: _load(archivefile: pathlib.Path, dockerTag: str, matEnv: Mapping[str, str]) -> Tuple[ExitVal, str, str]
      :canonical: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory._load

      .. autodoc2-docstring:: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory._load

   .. py:method:: _save(dockerTag: str, destfile: pathlib.Path, matEnv: Mapping[str, str]) -> Tuple[ExitVal, str]
      :canonical: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory._save

      .. autodoc2-docstring:: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory._save

   .. py:method:: _version(matEnv: Mapping[str, str]) -> Tuple[ExitVal, str, str]
      :canonical: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory._version

      .. autodoc2-docstring:: wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory._version