:py:mod:`gmuse.cli.completions`
===============================

.. py:module:: gmuse.cli.completions

.. autodoc2-docstring:: gmuse.cli.completions
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`CompletionStatus <gmuse.cli.completions.CompletionStatus>`
     - .. autodoc2-docstring:: gmuse.cli.completions.CompletionStatus
          :summary:
   * - :py:obj:`CompletionRequest <gmuse.cli.completions.CompletionRequest>`
     - .. autodoc2-docstring:: gmuse.cli.completions.CompletionRequest
          :summary:
   * - :py:obj:`CompletionResponse <gmuse.cli.completions.CompletionResponse>`
     - .. autodoc2-docstring:: gmuse.cli.completions.CompletionResponse
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`_load_zsh_template <gmuse.cli.completions._load_zsh_template>`
     - .. autodoc2-docstring:: gmuse.cli.completions._load_zsh_template
          :summary:
   * - :py:obj:`completions_zsh <gmuse.cli.completions.completions_zsh>`
     - .. autodoc2-docstring:: gmuse.cli.completions.completions_zsh
          :summary:
   * - :py:obj:`completions_run_command <gmuse.cli.completions.completions_run_command>`
     - .. autodoc2-docstring:: gmuse.cli.completions.completions_run_command
          :summary:

Data
~~~~

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

   * - :py:obj:`logger <gmuse.cli.completions.logger>`
     - .. autodoc2-docstring:: gmuse.cli.completions.logger
          :summary:
   * - :py:obj:`completions_app <gmuse.cli.completions.completions_app>`
     - .. autodoc2-docstring:: gmuse.cli.completions.completions_app
          :summary:

API
~~~

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

   .. autodoc2-docstring:: gmuse.cli.completions.logger

.. py:data:: completions_app
   :canonical: gmuse.cli.completions.completions_app
   :value: 'Typer(...)'

   .. autodoc2-docstring:: gmuse.cli.completions.completions_app

.. py:class:: CompletionStatus()
   :canonical: gmuse.cli.completions.CompletionStatus

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

   .. autodoc2-docstring:: gmuse.cli.completions.CompletionStatus

   .. rubric:: Initialization

   .. autodoc2-docstring:: gmuse.cli.completions.CompletionStatus.__init__

   .. py:attribute:: OK
      :canonical: gmuse.cli.completions.CompletionStatus.OK
      :value: 'ok'

      .. autodoc2-docstring:: gmuse.cli.completions.CompletionStatus.OK

   .. py:attribute:: TIMEOUT
      :canonical: gmuse.cli.completions.CompletionStatus.TIMEOUT
      :value: 'timeout'

      .. autodoc2-docstring:: gmuse.cli.completions.CompletionStatus.TIMEOUT

   .. py:attribute:: OFFLINE
      :canonical: gmuse.cli.completions.CompletionStatus.OFFLINE
      :value: 'offline'

      .. autodoc2-docstring:: gmuse.cli.completions.CompletionStatus.OFFLINE

   .. py:attribute:: NO_STAGED_CHANGES
      :canonical: gmuse.cli.completions.CompletionStatus.NO_STAGED_CHANGES
      :value: 'no_staged_changes'

      .. autodoc2-docstring:: gmuse.cli.completions.CompletionStatus.NO_STAGED_CHANGES

   .. py:attribute:: ERROR
      :canonical: gmuse.cli.completions.CompletionStatus.ERROR
      :value: 'error'

      .. autodoc2-docstring:: gmuse.cli.completions.CompletionStatus.ERROR

.. py:class:: CompletionRequest
   :canonical: gmuse.cli.completions.CompletionRequest

   .. autodoc2-docstring:: gmuse.cli.completions.CompletionRequest

   .. py:attribute:: staged_diff
      :canonical: gmuse.cli.completions.CompletionRequest.staged_diff
      :type: str
      :value: None

      .. autodoc2-docstring:: gmuse.cli.completions.CompletionRequest.staged_diff

   .. py:attribute:: timeout
      :canonical: gmuse.cli.completions.CompletionRequest.timeout
      :type: float
      :value: 3.0

      .. autodoc2-docstring:: gmuse.cli.completions.CompletionRequest.timeout

.. py:class:: CompletionResponse
   :canonical: gmuse.cli.completions.CompletionResponse

   .. autodoc2-docstring:: gmuse.cli.completions.CompletionResponse

   .. py:attribute:: suggestion
      :canonical: gmuse.cli.completions.CompletionResponse.suggestion
      :type: str
      :value: None

      .. autodoc2-docstring:: gmuse.cli.completions.CompletionResponse.suggestion

   .. py:attribute:: status
      :canonical: gmuse.cli.completions.CompletionResponse.status
      :type: gmuse.cli.completions.CompletionStatus
      :value: None

      .. autodoc2-docstring:: gmuse.cli.completions.CompletionResponse.status

   .. py:attribute:: metadata
      :canonical: gmuse.cli.completions.CompletionResponse.metadata
      :type: dict[str, object]
      :value: None

      .. autodoc2-docstring:: gmuse.cli.completions.CompletionResponse.metadata

   .. py:method:: to_json() -> str
      :canonical: gmuse.cli.completions.CompletionResponse.to_json

      .. autodoc2-docstring:: gmuse.cli.completions.CompletionResponse.to_json

.. py:function:: _load_zsh_template() -> str
   :canonical: gmuse.cli.completions._load_zsh_template

   .. autodoc2-docstring:: gmuse.cli.completions._load_zsh_template

.. py:function:: completions_zsh() -> None
   :canonical: gmuse.cli.completions.completions_zsh

   .. autodoc2-docstring:: gmuse.cli.completions.completions_zsh

.. py:function:: completions_run_command(shell: str = typer.Option(..., '--shell', help='The target shell (e.g., zsh)'), for_command: str = typer.Option(..., '--for', help="The command being completed (e.g., 'git commit -m')"), timeout: float = typer.Option(3.0, '--timeout', help='Timeout in seconds')) -> None
   :canonical: gmuse.cli.completions.completions_run_command

   .. autodoc2-docstring:: gmuse.cli.completions.completions_run_command