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

.. py:module:: mass_driver.models.migration

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

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

Classes
~~~~~~~

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

   * - :py:obj:`MigrationFile <mass_driver.models.migration.MigrationFile>`
     - .. autodoc2-docstring:: mass_driver.models.migration.MigrationFile
          :parser: myst
          :summary:
   * - :py:obj:`MigrationLoaded <mass_driver.models.migration.MigrationLoaded>`
     - .. autodoc2-docstring:: mass_driver.models.migration.MigrationLoaded
          :parser: myst
          :summary:
   * - :py:obj:`ForgeFile <mass_driver.models.migration.ForgeFile>`
     - .. autodoc2-docstring:: mass_driver.models.migration.ForgeFile
          :parser: myst
          :summary:
   * - :py:obj:`ForgeLoaded <mass_driver.models.migration.ForgeLoaded>`
     - .. autodoc2-docstring:: mass_driver.models.migration.ForgeLoaded
          :parser: myst
          :summary:
   * - :py:obj:`SourceConfigFile <mass_driver.models.migration.SourceConfigFile>`
     - .. autodoc2-docstring:: mass_driver.models.migration.SourceConfigFile
          :parser: myst
          :summary:
   * - :py:obj:`SourceConfigLoaded <mass_driver.models.migration.SourceConfigLoaded>`
     - .. autodoc2-docstring:: mass_driver.models.migration.SourceConfigLoaded
          :parser: myst
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`load_migration <mass_driver.models.migration.load_migration>`
     - .. autodoc2-docstring:: mass_driver.models.migration.load_migration
          :parser: myst
          :summary:
   * - :py:obj:`driver_from_config <mass_driver.models.migration.driver_from_config>`
     - .. autodoc2-docstring:: mass_driver.models.migration.driver_from_config
          :parser: myst
          :summary:
   * - :py:obj:`load_driver <mass_driver.models.migration.load_driver>`
     - .. autodoc2-docstring:: mass_driver.models.migration.load_driver
          :parser: myst
          :summary:
   * - :py:obj:`load_forge_toml <mass_driver.models.migration.load_forge_toml>`
     - .. autodoc2-docstring:: mass_driver.models.migration.load_forge_toml
          :parser: myst
          :summary:
   * - :py:obj:`forge_from_config <mass_driver.models.migration.forge_from_config>`
     - .. autodoc2-docstring:: mass_driver.models.migration.forge_from_config
          :parser: myst
          :summary:
   * - :py:obj:`load_forge <mass_driver.models.migration.load_forge>`
     - .. autodoc2-docstring:: mass_driver.models.migration.load_forge
          :parser: myst
          :summary:
   * - :py:obj:`load_sourceconfig <mass_driver.models.migration.load_sourceconfig>`
     - .. autodoc2-docstring:: mass_driver.models.migration.load_sourceconfig
          :parser: myst
          :summary:
   * - :py:obj:`source_from_config <mass_driver.models.migration.source_from_config>`
     - .. autodoc2-docstring:: mass_driver.models.migration.source_from_config
          :parser: myst
          :summary:
   * - :py:obj:`load_source <mass_driver.models.migration.load_source>`
     - .. autodoc2-docstring:: mass_driver.models.migration.load_source
          :parser: myst
          :summary:

Data
~~~~

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

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

API
~~~

.. py:data:: TOML_PROJECTKEY
   :canonical: mass_driver.models.migration.TOML_PROJECTKEY
   :value: 'mass-driver'

   .. autodoc2-docstring:: mass_driver.models.migration.TOML_PROJECTKEY
      :parser: myst

.. py:class:: MigrationFile
   :canonical: mass_driver.models.migration.MigrationFile

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

   .. autodoc2-docstring:: mass_driver.models.migration.MigrationFile
      :parser: myst

   .. py:attribute:: commit_message
      :canonical: mass_driver.models.migration.MigrationFile.commit_message
      :type: str
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.MigrationFile.commit_message
         :parser: myst

   .. py:attribute:: commit_author_name
      :canonical: mass_driver.models.migration.MigrationFile.commit_author_name
      :type: str | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.MigrationFile.commit_author_name
         :parser: myst

   .. py:attribute:: commit_author_email
      :canonical: mass_driver.models.migration.MigrationFile.commit_author_email
      :type: str | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.MigrationFile.commit_author_email
         :parser: myst

   .. py:attribute:: branch_name
      :canonical: mass_driver.models.migration.MigrationFile.branch_name
      :type: str | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.MigrationFile.branch_name
         :parser: myst

   .. py:attribute:: driver_name
      :canonical: mass_driver.models.migration.MigrationFile.driver_name
      :type: str
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.MigrationFile.driver_name
         :parser: myst

   .. py:attribute:: driver_config
      :canonical: mass_driver.models.migration.MigrationFile.driver_config
      :type: dict
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.MigrationFile.driver_config
         :parser: myst

.. py:class:: MigrationLoaded
   :canonical: mass_driver.models.migration.MigrationLoaded

   Bases: :py:obj:`mass_driver.models.migration.MigrationFile`

   .. autodoc2-docstring:: mass_driver.models.migration.MigrationLoaded
      :parser: myst

   .. py:attribute:: driver
      :canonical: mass_driver.models.migration.MigrationLoaded.driver
      :type: mass_driver.models.patchdriver.PatchDriver
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.MigrationLoaded.driver
         :parser: myst

   .. py:method:: from_config(config_toml: str)
      :canonical: mass_driver.models.migration.MigrationLoaded.from_config
      :classmethod:

      .. autodoc2-docstring:: mass_driver.models.migration.MigrationLoaded.from_config
         :parser: myst

.. py:function:: load_migration(migration_config: str) -> mass_driver.models.migration.MigrationFile
   :canonical: mass_driver.models.migration.load_migration

   .. autodoc2-docstring:: mass_driver.models.migration.load_migration
      :parser: myst

.. py:function:: driver_from_config(config: mass_driver.models.migration.MigrationFile) -> mass_driver.models.patchdriver.PatchDriver
   :canonical: mass_driver.models.migration.driver_from_config

   .. autodoc2-docstring:: mass_driver.models.migration.driver_from_config
      :parser: myst

.. py:function:: load_driver(config: mass_driver.models.migration.MigrationFile) -> mass_driver.models.migration.MigrationLoaded
   :canonical: mass_driver.models.migration.load_driver

   .. autodoc2-docstring:: mass_driver.models.migration.load_driver
      :parser: myst

.. py:class:: ForgeFile
   :canonical: mass_driver.models.migration.ForgeFile

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

   .. autodoc2-docstring:: mass_driver.models.migration.ForgeFile
      :parser: myst

   .. py:attribute:: base_branch
      :canonical: mass_driver.models.migration.ForgeFile.base_branch
      :type: mass_driver.models.forge.BranchName | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.ForgeFile.base_branch
         :parser: myst

   .. py:attribute:: head_branch
      :canonical: mass_driver.models.migration.ForgeFile.head_branch
      :type: mass_driver.models.forge.BranchName
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.ForgeFile.head_branch
         :parser: myst

   .. py:attribute:: git_push_first
      :canonical: mass_driver.models.migration.ForgeFile.git_push_first
      :type: bool
      :value: True

      .. autodoc2-docstring:: mass_driver.models.migration.ForgeFile.git_push_first
         :parser: myst

   .. py:attribute:: interactive_pause_every
      :canonical: mass_driver.models.migration.ForgeFile.interactive_pause_every
      :type: int | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.ForgeFile.interactive_pause_every
         :parser: myst

   .. py:attribute:: draft_pr
      :canonical: mass_driver.models.migration.ForgeFile.draft_pr
      :type: bool
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.ForgeFile.draft_pr
         :parser: myst

   .. py:attribute:: pr_title
      :canonical: mass_driver.models.migration.ForgeFile.pr_title
      :type: str
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.ForgeFile.pr_title
         :parser: myst

   .. py:attribute:: pr_body
      :canonical: mass_driver.models.migration.ForgeFile.pr_body
      :type: str
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.ForgeFile.pr_body
         :parser: myst

   .. py:attribute:: forge_name
      :canonical: mass_driver.models.migration.ForgeFile.forge_name
      :type: str
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.ForgeFile.forge_name
         :parser: myst

   .. py:attribute:: forge_config
      :canonical: mass_driver.models.migration.ForgeFile.forge_config
      :type: dict
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.ForgeFile.forge_config
         :parser: myst

.. py:class:: ForgeLoaded
   :canonical: mass_driver.models.migration.ForgeLoaded

   Bases: :py:obj:`mass_driver.models.migration.ForgeFile`

   .. autodoc2-docstring:: mass_driver.models.migration.ForgeLoaded
      :parser: myst

   .. py:attribute:: forge
      :canonical: mass_driver.models.migration.ForgeLoaded.forge
      :type: mass_driver.models.forge.Forge
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.ForgeLoaded.forge
         :parser: myst

   .. py:method:: from_config(config_toml: str)
      :canonical: mass_driver.models.migration.ForgeLoaded.from_config
      :classmethod:

      .. autodoc2-docstring:: mass_driver.models.migration.ForgeLoaded.from_config
         :parser: myst

.. py:function:: load_forge_toml(forge_config: str) -> mass_driver.models.migration.ForgeFile
   :canonical: mass_driver.models.migration.load_forge_toml

   .. autodoc2-docstring:: mass_driver.models.migration.load_forge_toml
      :parser: myst

.. py:function:: forge_from_config(config: mass_driver.models.migration.ForgeFile) -> mass_driver.models.migration.ForgeLoaded
   :canonical: mass_driver.models.migration.forge_from_config

   .. autodoc2-docstring:: mass_driver.models.migration.forge_from_config
      :parser: myst

.. py:function:: load_forge(config: str) -> mass_driver.models.migration.ForgeLoaded
   :canonical: mass_driver.models.migration.load_forge

   .. autodoc2-docstring:: mass_driver.models.migration.load_forge
      :parser: myst

.. py:class:: SourceConfigFile
   :canonical: mass_driver.models.migration.SourceConfigFile

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

   .. autodoc2-docstring:: mass_driver.models.migration.SourceConfigFile
      :parser: myst

   .. py:attribute:: source_name
      :canonical: mass_driver.models.migration.SourceConfigFile.source_name
      :type: str
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.SourceConfigFile.source_name
         :parser: myst

   .. py:attribute:: source_config
      :canonical: mass_driver.models.migration.SourceConfigFile.source_config
      :type: dict
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.SourceConfigFile.source_config
         :parser: myst

.. py:class:: SourceConfigLoaded
   :canonical: mass_driver.models.migration.SourceConfigLoaded

   Bases: :py:obj:`mass_driver.models.migration.SourceConfigFile`

   .. autodoc2-docstring:: mass_driver.models.migration.SourceConfigLoaded
      :parser: myst

   .. py:attribute:: source
      :canonical: mass_driver.models.migration.SourceConfigLoaded.source
      :type: mass_driver.models.repository.Source
      :value: None

      .. autodoc2-docstring:: mass_driver.models.migration.SourceConfigLoaded.source
         :parser: myst

   .. py:method:: from_config(config_toml: str)
      :canonical: mass_driver.models.migration.SourceConfigLoaded.from_config
      :classmethod:

      .. autodoc2-docstring:: mass_driver.models.migration.SourceConfigLoaded.from_config
         :parser: myst

.. py:function:: load_sourceconfig(source_config: str) -> mass_driver.models.migration.SourceConfigFile
   :canonical: mass_driver.models.migration.load_sourceconfig

   .. autodoc2-docstring:: mass_driver.models.migration.load_sourceconfig
      :parser: myst

.. py:function:: source_from_config(config: mass_driver.models.migration.SourceConfigFile) -> mass_driver.models.repository.Source
   :canonical: mass_driver.models.migration.source_from_config

   .. autodoc2-docstring:: mass_driver.models.migration.source_from_config
      :parser: myst

.. py:function:: load_source(config: mass_driver.models.migration.SourceConfigFile) -> mass_driver.models.migration.SourceConfigLoaded
   :canonical: mass_driver.models.migration.load_source

   .. autodoc2-docstring:: mass_driver.models.migration.load_source
      :parser: myst