buildenv.backends.factory
=========================

.. py:module:: buildenv.backends.factory


Classes
-------

.. autoapisummary::

   buildenv.backends.factory.EnvBackendFactory


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

.. py:class:: EnvBackendFactory

   .. py:attribute:: KNOWN_BACKENDS

      List of known environment backends



   .. py:method:: is_supported(name: str) -> bool
      :staticmethod:


      Check if backend name is supported

      :param name: backend name
      :return: True if supported, False otherwise



   .. py:method:: create(name: str, project_path: pathlib.Path, verbose_subprocess: bool = True, shell_name: str = 'bash') -> buildenv.backends.backend.EnvBackend
      :staticmethod:


      Create backend instance from name

      :param name: backend name
      :param project_path: project path
      :param verbose_subprocess: if True (default), subprocess calls output is streamed to console
      :param shell_name: name of the shell to use
      :return: created backend implementation instance



   .. py:method:: detect(project_path: pathlib.Path | None = None, verbose_subprocess: bool = True, shell_name: str = 'bash') -> buildenv.backends.backend.EnvBackend
      :staticmethod:


      Detect backend from running python instance, and return corresponding implementation

      :param project_path: project path
      :param verbose_subprocess: if True (default), subprocess calls output is streamed to console
      :param shell_name: name of the shell to use
      :return: detected backend implementation instance