PackagePlugin
Base class for Forge package plugins.
Forge packages should provide a concrete implementation of this class and register it via the forge.packages entry point group. The plugin acts as the main interface between the foundation framework and the package, providing access to package-specific functionality.
All methods have default implementations that return None, making the plugin system highly extensible. Subclasses only need to override the methods they actually use.
Member Functions:
get_config_units
get_config_units()Return a mapping of configurable unit names to their data model classes.
This method provides access to the main configurable units offered by the package. Configurable units are typically facade classes that provide high-level APIs for working with package-specific functionality.
The default implementation returns None. Subclasses should override this method to provide their package-specific components.
- Returns
-
dict[str, type[ConfigUnitDataModel]] | None