:py:mod:`gmuse.commit`
======================

.. py:module:: gmuse.commit

.. autodoc2-docstring:: gmuse.commit
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`GenerationContext <gmuse.commit.GenerationContext>`
     - .. autodoc2-docstring:: gmuse.commit.GenerationContext
          :summary:
   * - :py:obj:`GenerationResult <gmuse.commit.GenerationResult>`
     - .. autodoc2-docstring:: gmuse.commit.GenerationResult
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`gather_context <gmuse.commit.gather_context>`
     - .. autodoc2-docstring:: gmuse.commit.gather_context
          :summary:
   * - :py:obj:`generate_message <gmuse.commit.generate_message>`
     - .. autodoc2-docstring:: gmuse.commit.generate_message
          :summary:

Data
~~~~

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

   * - :py:obj:`logger <gmuse.commit.logger>`
     - .. autodoc2-docstring:: gmuse.commit.logger
          :summary:
   * - :py:obj:`DEFAULT_MAX_DIFF_BYTES <gmuse.commit.DEFAULT_MAX_DIFF_BYTES>`
     - .. autodoc2-docstring:: gmuse.commit.DEFAULT_MAX_DIFF_BYTES
          :summary:

API
~~~

.. py:data:: logger
   :canonical: gmuse.commit.logger
   :value: 'get_logger(...)'

   .. autodoc2-docstring:: gmuse.commit.logger

.. py:data:: DEFAULT_MAX_DIFF_BYTES
   :canonical: gmuse.commit.DEFAULT_MAX_DIFF_BYTES
   :type: typing.Final[int]
   :value: 20000

   .. autodoc2-docstring:: gmuse.commit.DEFAULT_MAX_DIFF_BYTES

.. py:class:: GenerationContext
   :canonical: gmuse.commit.GenerationContext

   .. autodoc2-docstring:: gmuse.commit.GenerationContext

   .. py:attribute:: diff
      :canonical: gmuse.commit.GenerationContext.diff
      :type: gmuse.git.StagedDiff
      :value: None

      .. autodoc2-docstring:: gmuse.commit.GenerationContext.diff

   .. py:attribute:: history
      :canonical: gmuse.commit.GenerationContext.history
      :type: typing.Optional[gmuse.git.CommitHistory]
      :value: None

      .. autodoc2-docstring:: gmuse.commit.GenerationContext.history

   .. py:attribute:: repo_instructions
      :canonical: gmuse.commit.GenerationContext.repo_instructions
      :type: typing.Optional[gmuse.git.RepositoryInstructions]
      :value: None

      .. autodoc2-docstring:: gmuse.commit.GenerationContext.repo_instructions

   .. py:attribute:: branch_info
      :canonical: gmuse.commit.GenerationContext.branch_info
      :type: typing.Optional[gmuse.git.BranchInfo]
      :value: None

      .. autodoc2-docstring:: gmuse.commit.GenerationContext.branch_info

   .. py:attribute:: diff_was_truncated
      :canonical: gmuse.commit.GenerationContext.diff_was_truncated
      :type: bool
      :value: False

      .. autodoc2-docstring:: gmuse.commit.GenerationContext.diff_was_truncated

.. py:class:: GenerationResult
   :canonical: gmuse.commit.GenerationResult

   .. autodoc2-docstring:: gmuse.commit.GenerationResult

   .. py:attribute:: message
      :canonical: gmuse.commit.GenerationResult.message
      :type: str
      :value: None

      .. autodoc2-docstring:: gmuse.commit.GenerationResult.message

   .. py:attribute:: context
      :canonical: gmuse.commit.GenerationResult.context
      :type: gmuse.commit.GenerationContext
      :value: None

      .. autodoc2-docstring:: gmuse.commit.GenerationResult.context

.. py:function:: gather_context(history_depth: int = 5, max_diff_bytes: int = DEFAULT_MAX_DIFF_BYTES, include_branch: bool = False, branch_max_length: int = 60) -> gmuse.commit.GenerationContext
   :canonical: gmuse.commit.gather_context

   .. autodoc2-docstring:: gmuse.commit.gather_context

.. py:function:: generate_message(config: gmuse.config.ConfigDict, hint: typing.Optional[str] = None, context: typing.Optional[gmuse.commit.GenerationContext] = None) -> gmuse.commit.GenerationResult
   :canonical: gmuse.commit.generate_message

   .. autodoc2-docstring:: gmuse.commit.generate_message