sierra.core.plugin_manager

Simple plugin managers to make SIERRA OPEN/CLOSED.

• module_exists(): Check if a module exists before trying to import it.

• module_load(): Import the specified module.

• bc_load(): Load the specified Batch Criteria.

• module_load_tiered(): Attempt to load the specified python module with tiered precedence.

sierra.core.plugin_manager.module_exists(name: str) → bool

Check if a module exists before trying to import it.

sierra.core.plugin_manager.module_load(name: str) → module

Import the specified module.

sierra.core.plugin_manager.bc_load(cmdopts: Dict[str, Any], category: str)

Load the specified Batch Criteria.

sierra.core.plugin_manager.module_load_tiered(path: str, project: Optional[str] = None, platform: Optional[str] = None) → module

Attempt to load the specified python module with tiered precedence.

Generally, the precedence is project -> project submodule -> platform module -> SIERRA core module, to allow users to override SIERRA core functionality with ease. Specifically:

1. Check if the requested module is a project. If it is, return it.

2. Check if the requested module is a part of a project (i.e., <project>.<path> exists). If it does, return it. This requires that SIERRA_PLUGIN_PATH to be set properly.

3. Check if the requested module is provided by the platform plugin (i.e., sierra.platform.<platform>.<path> exists). If it does, return it.

4. Check if the requested module is part of the SIERRA core (i.e., sierra.core.<path> exists). If it does, return it.

If no match was found using any of these, throw an error.

• BasePluginManager: Base class for common functionality.

• FilePluginManager: Plugins are .py files within a root plugin directory.

• DirectoryPluginManager: Plugins are directories found in a root plugin directory.

• ProjectPluginManager: Plugins are directories found in a root plugin directory.

• CompositePluginManager: Base class for common functionality.

class sierra.core.plugin_manager.BasePluginManager

Base class for common functionality.

Inheritance

__dict__ = mappingproxy({'__module__': 'sierra.core.plugin_manager', '__doc__': '\n    Base class for common functionality.\n    ', '__init__': <function BasePluginManager.__init__>, 'available_plugins': <function BasePluginManager.available_plugins>, 'load_plugin': <function BasePluginManager.load_plugin>, 'get_plugin': <function BasePluginManager.get_plugin>, 'get_plugin_module': <function BasePluginManager.get_plugin_module>, 'has_plugin': <function BasePluginManager.has_plugin>, '__dict__': <attribute '__dict__' of 'BasePluginManager' objects>, '__weakref__': <attribute '__weakref__' of 'BasePluginManager' objects>, '__annotations__': {'loaded': 'tp.Dict[str, tp.Dict]'}})

__doc__ = '\n    Base class for common functionality.\n    '

__init__() → None

__module__ = 'sierra.core.plugin_manager'

__weakref__

list of weak references to the object (if defined)

available_plugins()

get_plugin(name: str) → dict

get_plugin_module(name: str) → module

has_plugin(name: str) → bool

load_plugin(name: str) → None

Load a plugin module.

class sierra.core.plugin_manager.FilePluginManager

Plugins are .py files within a root plugin directory.

Intended for use with models.

Inheritance

__doc__ = 'Plugins are ``.py`` files within a root plugin directory.\n\n    Intended for use with :term:`models <Model>`.\n\n    '

__init__() → None

__module__ = 'sierra.core.plugin_manager'

available_plugins() → Dict[str, Dict]

Get the available plugins in the configured plugin root.

initialize(project: str, search_root: Path) → None

loaded: Dict[str, Dict]

class sierra.core.plugin_manager.DirectoryPluginManager(search_root: Path)

Plugins are directories found in a root plugin directory.

Intended for use with Pipeline plugins.

Inheritance

__doc__ = 'Plugins are `directories` found in a root plugin directory.\n\n    Intended for use with :term:`Pipeline plugins <plugin>`.\n\n    '

__init__(search_root: Path) → None

__module__ = 'sierra.core.plugin_manager'

available_plugins()

Find all pipeline plugins in all directories within the search root.

initialize(project: str) → None

loaded: Dict[str, Dict]

class sierra.core.plugin_manager.ProjectPluginManager(search_root: Path, project: str)

Plugins are directories found in a root plugin directory.

Intended for use with Project plugins.

Inheritance

__doc__ = 'Plugins are `directories` found in a root plugin directory.\n\n    Intended for use with :term:`Project plugins <plugin>`.\n\n    '

__init__(search_root: Path, project: str) → None

__module__ = 'sierra.core.plugin_manager'

available_plugins()

Find all pipeline plugins in all directories within the search root.

initialize(project: str) → None

loaded: Dict[str, Dict]

class sierra.core.plugin_manager.CompositePluginManager

Inheritance

__doc__ = None

__init__() → None

__module__ = 'sierra.core.plugin_manager'

available_plugins()

initialize(project: str, search_path: List[Path]) → None

loaded: Dict[str, Dict]