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

.. py:module:: wfexs_backend.container_factories.docker_container

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

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

Classes
~~~~~~~

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

   * - :py:obj:`DockerContainerFactory <wfexs_backend.container_factories.docker_container.DockerContainerFactory>`
     -

API
~~~

.. py:class:: DockerContainerFactory(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.docker_container.DockerContainerFactory

   Bases: :py:obj:`wfexs_backend.container_factories.abstract_docker_container.AbstractDockerContainerFactory`

   .. py:attribute:: TRIMMABLE_MANIFEST_KEYS
      :canonical: wfexs_backend.container_factories.docker_container.DockerContainerFactory.TRIMMABLE_MANIFEST_KEYS
      :type: Final[Sequence[str]]
      :value: ['RepoDigests']

      .. autodoc2-docstring:: wfexs_backend.container_factories.docker_container.DockerContainerFactory.TRIMMABLE_MANIFEST_KEYS

   .. py:method:: trimmable_manifest_keys() -> Sequence[str]
      :canonical: wfexs_backend.container_factories.docker_container.DockerContainerFactory.trimmable_manifest_keys
      :classmethod:

      .. autodoc2-docstring:: wfexs_backend.container_factories.docker_container.DockerContainerFactory.trimmable_manifest_keys

   .. py:method:: ContainerType() -> wfexs_backend.common.ContainerType
      :canonical: wfexs_backend.container_factories.docker_container.DockerContainerFactory.ContainerType
      :classmethod:

      .. autodoc2-docstring:: wfexs_backend.container_factories.docker_container.DockerContainerFactory.ContainerType

   .. py:method:: variant_name() -> str
      :canonical: wfexs_backend.container_factories.docker_container.DockerContainerFactory.variant_name
      :classmethod:

      .. autodoc2-docstring:: wfexs_backend.container_factories.docker_container.DockerContainerFactory.variant_name

   .. py:property:: architecture
      :canonical: wfexs_backend.container_factories.docker_container.DockerContainerFactory.architecture
      :type: Tuple[ContainerOperatingSystem, ProcessorArchitecture]

      .. autodoc2-docstring:: wfexs_backend.container_factories.docker_container.DockerContainerFactory.architecture

   .. py:method:: _genDockerTag(tag: wfexs_backend.common.ContainerTaggedName) -> Tuple[URIType, str]
      :canonical: wfexs_backend.container_factories.docker_container.DockerContainerFactory._genDockerTag

      .. autodoc2-docstring:: wfexs_backend.container_factories.docker_container.DockerContainerFactory._genDockerTag

   .. py:method:: _enrichFingerprint(fingerprint: str, tag: wfexs_backend.common.ContainerTaggedName) -> wfexs_backend.common.Fingerprint
      :canonical: wfexs_backend.container_factories.docker_container.DockerContainerFactory._enrichFingerprint

      .. autodoc2-docstring:: wfexs_backend.container_factories.docker_container.DockerContainerFactory._enrichFingerprint

   .. py:method:: materializeSingleContainer(tag: wfexs_backend.common.ContainerTaggedName, containers_dir: Optional[pathlib.Path] = None, offline: bool = False, force: bool = False) -> Optional[Container]
      :canonical: wfexs_backend.container_factories.docker_container.DockerContainerFactory.materializeSingleContainer

      .. autodoc2-docstring:: wfexs_backend.container_factories.docker_container.DockerContainerFactory.materializeSingleContainer

   .. py:method:: deploySingleContainer(container: wfexs_backend.common.ContainerTaggedName, containers_dir: Optional[pathlib.Path] = None, force: bool = False) -> Tuple[Container, bool]
      :canonical: wfexs_backend.container_factories.docker_container.DockerContainerFactory.deploySingleContainer

   .. py:method:: generateCanonicalTag(container: wfexs_backend.common.ContainerTaggedName) -> str
      :canonical: wfexs_backend.container_factories.docker_container.DockerContainerFactory.generateCanonicalTag

      .. autodoc2-docstring:: wfexs_backend.container_factories.docker_container.DockerContainerFactory.generateCanonicalTag