:py:mod:`mass_driver.models.forge`
==================================

.. py:module:: mass_driver.models.forge

.. autodoc2-docstring:: mass_driver.models.forge
   :parser: myst
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`Forge <mass_driver.models.forge.Forge>`
     - .. autodoc2-docstring:: mass_driver.models.forge.Forge
          :parser: myst
          :summary:
   * - :py:obj:`PROutcome <mass_driver.models.forge.PROutcome>`
     - .. autodoc2-docstring:: mass_driver.models.forge.PROutcome
          :parser: myst
          :summary:
   * - :py:obj:`PRResult <mass_driver.models.forge.PRResult>`
     - .. autodoc2-docstring:: mass_driver.models.forge.PRResult
          :parser: myst
          :summary:

Data
~~~~

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

   * - :py:obj:`PRStatus <mass_driver.models.forge.PRStatus>`
     - .. autodoc2-docstring:: mass_driver.models.forge.PRStatus
          :parser: myst
          :summary:

API
~~~

.. py:data:: PRStatus
   :canonical: mass_driver.models.forge.PRStatus
   :value: None

   .. autodoc2-docstring:: mass_driver.models.forge.PRStatus
      :parser: myst

.. py:class:: Forge
   :canonical: mass_driver.models.forge.Forge

   Bases: :py:obj:`pydantic.BaseSettings`

   .. autodoc2-docstring:: mass_driver.models.forge.Forge
      :parser: myst

   .. py:method:: create_pr(forge_repo_url: str, base_branch: mass_driver.models.repository.BranchName, head_branch: mass_driver.models.repository.BranchName, pr_title: str, pr_body: str, draft: bool) -> str
      :canonical: mass_driver.models.forge.Forge.create_pr
      :abstractmethod:

      .. autodoc2-docstring:: mass_driver.models.forge.Forge.create_pr
         :parser: myst

   .. py:method:: get_pr_status(pr: str) -> str
      :canonical: mass_driver.models.forge.Forge.get_pr_status
      :abstractmethod:

      .. autodoc2-docstring:: mass_driver.models.forge.Forge.get_pr_status
         :parser: myst

   .. py:property:: pr_statuses
      :canonical: mass_driver.models.forge.Forge.pr_statuses
      :abstractmethod:
      :type: list[str]

      .. autodoc2-docstring:: mass_driver.models.forge.Forge.pr_statuses
         :parser: myst

   .. py:class:: Config
      :canonical: mass_driver.models.forge.Forge.Config

      .. autodoc2-docstring:: mass_driver.models.forge.Forge.Config
         :parser: myst

      .. py:attribute:: underscore_attrs_are_private
         :canonical: mass_driver.models.forge.Forge.Config.underscore_attrs_are_private
         :value: True

         .. autodoc2-docstring:: mass_driver.models.forge.Forge.Config.underscore_attrs_are_private
            :parser: myst

      .. py:attribute:: env_prefix
         :canonical: mass_driver.models.forge.Forge.Config.env_prefix
         :value: 'FORGE_'

         .. autodoc2-docstring:: mass_driver.models.forge.Forge.Config.env_prefix
            :parser: myst

.. py:class:: PROutcome()
   :canonical: mass_driver.models.forge.PROutcome

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`

   .. autodoc2-docstring:: mass_driver.models.forge.PROutcome
      :parser: myst

   .. rubric:: Initialization

   .. autodoc2-docstring:: mass_driver.models.forge.PROutcome.__init__
      :parser: myst

   .. py:attribute:: PR_CREATED
      :canonical: mass_driver.models.forge.PROutcome.PR_CREATED
      :value: 'PR_CREATED'

      .. autodoc2-docstring:: mass_driver.models.forge.PROutcome.PR_CREATED
         :parser: myst

   .. py:attribute:: PR_FAILED
      :canonical: mass_driver.models.forge.PROutcome.PR_FAILED
      :value: 'PR_FAILED'

      .. autodoc2-docstring:: mass_driver.models.forge.PROutcome.PR_FAILED
         :parser: myst

.. py:class:: PRResult
   :canonical: mass_driver.models.forge.PRResult

   Bases: :py:obj:`pydantic.BaseModel`

   .. autodoc2-docstring:: mass_driver.models.forge.PRResult
      :parser: myst

   .. py:attribute:: outcome
      :canonical: mass_driver.models.forge.PRResult.outcome
      :type: mass_driver.models.forge.PROutcome
      :value: None

      .. autodoc2-docstring:: mass_driver.models.forge.PRResult.outcome
         :parser: myst

   .. py:attribute:: pr_html_url
      :canonical: mass_driver.models.forge.PRResult.pr_html_url
      :type: str | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.forge.PRResult.pr_html_url
         :parser: myst

   .. py:attribute:: details
      :canonical: mass_driver.models.forge.PRResult.details
      :type: str | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.forge.PRResult.details
         :parser: myst