egse.plugin

cgse-common

This code is part of the cgse-common package.

egse.plugin ¶

This module provides function to load plugins and settings from entry-points.

Functions:

Name	Description
`entry_points`	Returns a set with all entry-points for the given group name.
`get_file_infos`	Returns a dictionary with location and filename of all the entries found for
`load_plugins`	Returns a dictionary with plugins loaded. The keys are the names of the entry-points,

entry_points(group)

Returns a set with all entry-points for the given group name.

When the name is not known as an entry-point group, an empty set will be returned.

get_file_infos(entry_point)

Returns a dictionary with location and filename of all the entries found for the given entry-point name.

The entry-points are interpreted as follows: <name> = "<module>:<filename>" where

<name> is the name of the entry-point given in the pyproject.toml file
<module> is a valid module name that can be imported and from which the location can be determined.
<filename> is the name of the target file, e.g. a YAML file

As an example, for the cgse-common settings, the following entry in the pyproject.toml:

[project.entry-points."cgse.settings"]
cgse-common = "cgse_common:settings.yaml"

Note that the module name for this entry point has an underscore instead of a dash.

Return

A dictionary with the entry point name as the key and a tuple (location, filename) as the value.

load_plugins(entry_point)

Returns a dictionary with plugins loaded. The keys are the names of the entry-points, the values are the loaded modules or objects.

Note

When an entry point cannot be loaded, an error is logged and the value for that entry point in the returned dictionary will be None.