buildenv.completion
===================

.. py:module:: buildenv.completion


Classes
-------

.. autoapisummary::

   buildenv.completion.CompletionCommand
   buildenv.completion.EvalCompletionCommand
   buildenv.completion.ArgCompleteCompletionCommand


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

.. py:class:: CompletionCommand

   Bases: :py:obj:`abc.ABC`


   Class representing a command for shell autocompletion.


   .. py:method:: get_command() -> str
      :abstractmethod:


      Get the command string for autocompletion, to be added to generated completion script.

      :return: Command string for autocompletion



.. py:class:: EvalCompletionCommand(command: str)

   Bases: :py:obj:`CompletionCommand`


   Class representing a command for shell autocompletion.
   The provided command is supposed to return a bash script snippet to be evaluated with the "eval" command.

   :param command: The command to be evaluated


   .. py:method:: get_command() -> str

      Get the command string for autocompletion, to be added to generated completion script.

      :return: Command string for autocompletion



.. py:class:: ArgCompleteCompletionCommand(command: str)

   Bases: :py:obj:`EvalCompletionCommand`


   Class representing a command for shell autocompletion.
   The provided command is supposed to be an entry-point using *argcomplete*

   :param command: Single command name using argcomplete lib