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

.. py:module:: mass_driver.models.activity

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

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

Classes
~~~~~~~

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

   * - :py:obj:`ActivityFile <mass_driver.models.activity.ActivityFile>`
     - .. autodoc2-docstring:: mass_driver.models.activity.ActivityFile
          :parser: myst
          :summary:
   * - :py:obj:`ActivityLoaded <mass_driver.models.activity.ActivityLoaded>`
     - .. autodoc2-docstring:: mass_driver.models.activity.ActivityLoaded
          :parser: myst
          :summary:
   * - :py:obj:`ActivityOutcome <mass_driver.models.activity.ActivityOutcome>`
     - .. autodoc2-docstring:: mass_driver.models.activity.ActivityOutcome
          :parser: myst
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`load_activity_toml <mass_driver.models.activity.load_activity_toml>`
     - .. autodoc2-docstring:: mass_driver.models.activity.load_activity_toml
          :parser: myst
          :summary:
   * - :py:obj:`load_activity <mass_driver.models.activity.load_activity>`
     - .. autodoc2-docstring:: mass_driver.models.activity.load_activity
          :parser: myst
          :summary:
   * - :py:obj:`load_scan <mass_driver.models.activity.load_scan>`
     - .. autodoc2-docstring:: mass_driver.models.activity.load_scan
          :parser: myst
          :summary:

Data
~~~~

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

   * - :py:obj:`IndexedPatchResult <mass_driver.models.activity.IndexedPatchResult>`
     - .. autodoc2-docstring:: mass_driver.models.activity.IndexedPatchResult
          :parser: myst
          :summary:
   * - :py:obj:`IndexedPRResult <mass_driver.models.activity.IndexedPRResult>`
     - .. autodoc2-docstring:: mass_driver.models.activity.IndexedPRResult
          :parser: myst
          :summary:
   * - :py:obj:`ScanResult <mass_driver.models.activity.ScanResult>`
     - .. autodoc2-docstring:: mass_driver.models.activity.ScanResult
          :parser: myst
          :summary:
   * - :py:obj:`IndexedScanResult <mass_driver.models.activity.IndexedScanResult>`
     - .. autodoc2-docstring:: mass_driver.models.activity.IndexedScanResult
          :parser: myst
          :summary:

API
~~~

.. py:data:: IndexedPatchResult
   :canonical: mass_driver.models.activity.IndexedPatchResult
   :value: None

   .. autodoc2-docstring:: mass_driver.models.activity.IndexedPatchResult
      :parser: myst

.. py:data:: IndexedPRResult
   :canonical: mass_driver.models.activity.IndexedPRResult
   :value: None

   .. autodoc2-docstring:: mass_driver.models.activity.IndexedPRResult
      :parser: myst

.. py:data:: ScanResult
   :canonical: mass_driver.models.activity.ScanResult
   :value: None

   .. autodoc2-docstring:: mass_driver.models.activity.ScanResult
      :parser: myst

.. py:data:: IndexedScanResult
   :canonical: mass_driver.models.activity.IndexedScanResult
   :value: None

   .. autodoc2-docstring:: mass_driver.models.activity.IndexedScanResult
      :parser: myst

.. py:class:: ActivityFile
   :canonical: mass_driver.models.activity.ActivityFile

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

   .. autodoc2-docstring:: mass_driver.models.activity.ActivityFile
      :parser: myst

   .. py:attribute:: source
      :canonical: mass_driver.models.activity.ActivityFile.source
      :type: mass_driver.models.migration.SourceConfigFile | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.activity.ActivityFile.source
         :parser: myst

   .. py:attribute:: scan
      :canonical: mass_driver.models.activity.ActivityFile.scan
      :type: mass_driver.models.scan.ScanFile | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.activity.ActivityFile.scan
         :parser: myst

   .. py:attribute:: migration
      :canonical: mass_driver.models.activity.ActivityFile.migration
      :type: mass_driver.models.migration.MigrationFile | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.activity.ActivityFile.migration
         :parser: myst

   .. py:attribute:: forge
      :canonical: mass_driver.models.activity.ActivityFile.forge
      :type: mass_driver.models.migration.ForgeFile | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.activity.ActivityFile.forge
         :parser: myst

.. py:class:: ActivityLoaded
   :canonical: mass_driver.models.activity.ActivityLoaded

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

   .. autodoc2-docstring:: mass_driver.models.activity.ActivityLoaded
      :parser: myst

   .. py:attribute:: source
      :canonical: mass_driver.models.activity.ActivityLoaded.source
      :type: mass_driver.models.migration.SourceConfigLoaded | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.activity.ActivityLoaded.source
         :parser: myst

   .. py:attribute:: scan
      :canonical: mass_driver.models.activity.ActivityLoaded.scan
      :type: mass_driver.models.scan.ScanLoaded | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.activity.ActivityLoaded.scan
         :parser: myst

   .. py:attribute:: migration
      :canonical: mass_driver.models.activity.ActivityLoaded.migration
      :type: mass_driver.models.migration.MigrationLoaded | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.activity.ActivityLoaded.migration
         :parser: myst

   .. py:attribute:: forge
      :canonical: mass_driver.models.activity.ActivityLoaded.forge
      :type: mass_driver.models.migration.ForgeLoaded | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.activity.ActivityLoaded.forge
         :parser: myst

   .. py:method:: from_config(config_toml: str)
      :canonical: mass_driver.models.activity.ActivityLoaded.from_config
      :classmethod:

      .. autodoc2-docstring:: mass_driver.models.activity.ActivityLoaded.from_config
         :parser: myst

.. py:class:: ActivityOutcome
   :canonical: mass_driver.models.activity.ActivityOutcome

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

   .. autodoc2-docstring:: mass_driver.models.activity.ActivityOutcome
      :parser: myst

   .. py:attribute:: repos_sourced
      :canonical: mass_driver.models.activity.ActivityOutcome.repos_sourced
      :type: mass_driver.models.repository.IndexedRepos
      :value: None

      .. autodoc2-docstring:: mass_driver.models.activity.ActivityOutcome.repos_sourced
         :parser: myst

   .. py:attribute:: repos_cloned
      :canonical: mass_driver.models.activity.ActivityOutcome.repos_cloned
      :type: mass_driver.models.repository.IndexedClonedRepos
      :value: None

      .. autodoc2-docstring:: mass_driver.models.activity.ActivityOutcome.repos_cloned
         :parser: myst

   .. py:attribute:: scan_result
      :canonical: mass_driver.models.activity.ActivityOutcome.scan_result
      :type: mass_driver.models.activity.IndexedScanResult | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.activity.ActivityOutcome.scan_result
         :parser: myst

   .. py:attribute:: migration_result
      :canonical: mass_driver.models.activity.ActivityOutcome.migration_result
      :type: mass_driver.models.activity.IndexedPatchResult | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.activity.ActivityOutcome.migration_result
         :parser: myst

   .. py:attribute:: forge_result
      :canonical: mass_driver.models.activity.ActivityOutcome.forge_result
      :type: mass_driver.models.activity.IndexedPRResult | None
      :value: None

      .. autodoc2-docstring:: mass_driver.models.activity.ActivityOutcome.forge_result
         :parser: myst

.. py:function:: load_activity_toml(activity_config: str) -> mass_driver.models.activity.ActivityFile
   :canonical: mass_driver.models.activity.load_activity_toml

   .. autodoc2-docstring:: mass_driver.models.activity.load_activity_toml
      :parser: myst

.. py:function:: load_activity(activity: mass_driver.models.activity.ActivityFile) -> mass_driver.models.activity.ActivityLoaded
   :canonical: mass_driver.models.activity.load_activity

   .. autodoc2-docstring:: mass_driver.models.activity.load_activity
      :parser: myst

.. py:function:: load_scan(s: mass_driver.models.scan.ScanFile)
   :canonical: mass_driver.models.activity.load_scan

   .. autodoc2-docstring:: mass_driver.models.activity.load_scan
      :parser: myst