Classes and functions to load and interact with plugin classes accessible through defined entry points.
aiida.plugins.
BaseFactory
Return the plugin class registered under a given entry point group and name.
group – entry point group
name – entry point name
the plugin class
aiida.common.MissingEntryPointError – entry point was not registered
aiida.common.MultipleEntryPointError – entry point could not be uniquely resolved
aiida.common.LoadingEntryPointError – entry point could not be loaded
CalculationFactory
Return the CalcJob sub class registered under the given entry point.
entry_point_name – the entry point name
sub class of CalcJob
CalcJob
aiida.common.InvalidEntryPointTypeError – if the type of the loaded entry point is invalid.
DataFactory
Return the Data sub class registered under the given entry point.
sub class of Data
Data
DbImporterFactory
Return the DbImporter sub class registered under the given entry point.
sub class of DbImporter
DbImporter
GroupFactory
Return the Group sub class registered under the given entry point.
sub class of Group
Group
OrbitalFactory
Return the Orbital sub class registered under the given entry point.
sub class of Orbital
Orbital
ParserFactory
Return the Parser sub class registered under the given entry point.
sub class of Parser
Parser
SchedulerFactory
Return the Scheduler sub class registered under the given entry point.
sub class of Scheduler
Scheduler
TransportFactory
Return the Transport sub class registered under the given entry point.
sub class of Transport
Transport
WorkflowFactory
Return the WorkChain sub class registered under the given entry point.
sub class of WorkChain or a workfunction
WorkChain
load_entry_point
Load the class registered under the entry point for a given name and group
group – the entry point group
name – the name of the entry point
class registered at the given entry point
TypeError – if the entry_point_string is not a string type
ValueError – if the entry_point_string cannot be split into two parts on the entry point string separator
load_entry_point_from_string
Load the class registered for a given entry point string that determines group and name
entry_point_string – the entry point string
Module to manage loading entrypoints.
aiida.plugins.entry_point.
Definition of factories to load classes from the various plugin groups.
aiida.plugins.factories.
Utilities dealing with plugins and entry points.
aiida.plugins.utils.
PluginVersionProvider
Bases: object
object
Utility class that determines version information about a given plugin resource.
__dict__
__init__
Initialize self. See help(type(self)) for accurate signature.
__module__
__weakref__
list of weak references to the object (if defined)
get_version_info
Get the version information for a given plugin.
Note
This container will keep a cache, so if this function was already called for the given plugin before for this instance, the result computer at last invocation will be returned.
plugin
plugin – a class or function
dictionary with the version.core and optionally version.plugin if it could be determined.
logger