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

.. py:module:: mass_driver.models.patchdriver

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

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

Classes
~~~~~~~

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

   * - :py:obj:`PatchOutcome <mass_driver.models.patchdriver.PatchOutcome>`
     - .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchOutcome
          :parser: myst
          :summary:
   * - :py:obj:`PatchResult <mass_driver.models.patchdriver.PatchResult>`
     - .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchResult
          :parser: myst
          :summary:
   * - :py:obj:`PatchDriver <mass_driver.models.patchdriver.PatchDriver>`
     - .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchDriver
          :parser: myst
          :summary:

API
~~~

.. py:class:: PatchOutcome()
   :canonical: mass_driver.models.patchdriver.PatchOutcome

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

   .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchOutcome
      :parser: myst

   .. rubric:: Initialization

   .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchOutcome.__init__
      :parser: myst

   .. py:attribute:: PATCHED_OK
      :canonical: mass_driver.models.patchdriver.PatchOutcome.PATCHED_OK
      :value: 'PATCHED_OK'

      .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchOutcome.PATCHED_OK
         :parser: myst

   .. py:attribute:: ALREADY_PATCHED
      :canonical: mass_driver.models.patchdriver.PatchOutcome.ALREADY_PATCHED
      :value: 'ALREADY_PATCHED'

      .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchOutcome.ALREADY_PATCHED
         :parser: myst

   .. py:attribute:: PATCH_DOES_NOT_APPLY
      :canonical: mass_driver.models.patchdriver.PatchOutcome.PATCH_DOES_NOT_APPLY
      :value: 'PATCH_DOES_NOT_APPLY'

      .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchOutcome.PATCH_DOES_NOT_APPLY
         :parser: myst

   .. py:attribute:: PATCH_ERROR
      :canonical: mass_driver.models.patchdriver.PatchOutcome.PATCH_ERROR
      :value: 'PATCH_ERROR'

      .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchOutcome.PATCH_ERROR
         :parser: myst

.. py:class:: PatchResult
   :canonical: mass_driver.models.patchdriver.PatchResult

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

   .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchResult
      :parser: myst

   .. py:attribute:: outcome
      :canonical: mass_driver.models.patchdriver.PatchResult.outcome
      :type: mass_driver.models.patchdriver.PatchOutcome
      :value: None

      .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchResult.outcome
         :parser: myst

   .. py:attribute:: details
      :canonical: mass_driver.models.patchdriver.PatchResult.details
      :type: str | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchResult.details
         :parser: myst

.. py:class:: PatchDriver
   :canonical: mass_driver.models.patchdriver.PatchDriver

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

   .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchDriver
      :parser: myst

   .. py:attribute:: _logger
      :canonical: mass_driver.models.patchdriver.PatchDriver._logger
      :type: logging.Logger
      :value: None

      .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchDriver._logger
         :parser: myst

   .. py:method:: run(repo: mass_driver.models.repository.ClonedRepo) -> mass_driver.models.patchdriver.PatchResult
      :canonical: mass_driver.models.patchdriver.PatchDriver.run
      :abstractmethod:

      .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchDriver.run
         :parser: myst

   .. py:property:: logger
      :canonical: mass_driver.models.patchdriver.PatchDriver.logger

      .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchDriver.logger
         :parser: myst

   .. py:class:: Config
      :canonical: mass_driver.models.patchdriver.PatchDriver.Config

      .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchDriver.Config
         :parser: myst

      .. py:attribute:: underscore_attrs_are_private
         :canonical: mass_driver.models.patchdriver.PatchDriver.Config.underscore_attrs_are_private
         :value: True

         .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchDriver.Config.underscore_attrs_are_private
            :parser: myst

      .. py:attribute:: extra
         :canonical: mass_driver.models.patchdriver.PatchDriver.Config.extra
         :value: None

         .. autodoc2-docstring:: mass_driver.models.patchdriver.PatchDriver.Config.extra
            :parser: myst