buildenv.extension
==================

.. py:module:: buildenv.extension


Classes
-------

.. autoapisummary::

   buildenv.extension.BuildEnvExtension


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

.. py:class:: BuildEnvExtension(manager)

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


   Base class for **buildenv** extensions, to be contributed through "buildenv_init" entry point

   :param manager: BuildEnvManager instance
   :type manager: BuildEnvManager


   .. py:attribute:: manager


   .. py:method:: init(force: bool)
      :abstractmethod:


      Method called by manager when delegating its own "init" method to extensions.

      Extensions are supposed:

      * to perform some build logic initialization (once for all)
      * to contribute to activation scripts (loaded each time the buildenv is activated)

      The self.manager attribute can be used to access to the manager instance.

      :param force: Tells the extension if the **--force** argument was used on the **buildenv init** command line.



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


      Method called by manager to know extension version.

      This version is used by manager to be compared to version used last time the init was done.
      If it differs, previous activation scripts are deleted, and init method is called again.

      :return: Extension version string