deepmd.pt.utils.plugin#

Base of plugin systems.

Classes#

Plugin

A class to register and restore plugins.

PluginVariant

A class to remove type from input arguments.

VariantABCMeta

Metaclass for defining Abstract Base Classes (ABCs).

VariantMeta

Module Contents#

class deepmd.pt.utils.plugin.Plugin[source]#

A class to register and restore plugins.

Attributes:
pluginsdict[str, object]

plugins

Examples

>>> plugin = Plugin()
>>> @plugin.register("xx")
    def xxx():
        pass
>>> print(plugin.plugins["xx"])
plugins#
__add__(other) Plugin[source]#
register(key: str) Callable[[object], object][source]#

Register a plugin.

Parameters:
keystr

key of the plugin

Returns:
Callable[[object], object]

decorator

get_plugin(key) object[source]#

Visit a plugin by key.

Parameters:
keystr

key of the plugin

Returns:
object

the plugin

class deepmd.pt.utils.plugin.PluginVariant[source]#

A class to remove type from input arguments.

class deepmd.pt.utils.plugin.VariantABCMeta[source]#

Bases: VariantMeta, abc.ABCMeta

Metaclass for defining Abstract Base Classes (ABCs).

Use this metaclass to create an ABC. An ABC can be subclassed directly, and then acts as a mix-in class. You can also register unrelated concrete classes (even built-in classes) and unrelated ABCs as ‘virtual subclasses’ – these and their descendants will be considered subclasses of the registering ABC by the built-in issubclass() function, but the registering ABC won’t show up in their MRO (Method Resolution Order) nor will method implementations defined by the registering ABC be callable (not even via super()).

class deepmd.pt.utils.plugin.VariantMeta[source]#
__call__(*args, **kwargs)[source]#

Remove type and keys that starts with underline.