buildenv.extension

Classes

BuildEnvExtension

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

Module Contents

class buildenv.extension.BuildEnvExtension(manager)

Bases: abc.ABC

Base class for buildenv extensions, to be contributed through “buildenv_init” entry point

Parameters:

manager (BuildEnvManager) – BuildEnvManager instance

manager

abstract init(force: bool)

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.

Parameters:

force – Tells the extension if the –force argument was used on the buildenv init command line.

abstract get_version() → str

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.

Returns:

Extension version string