3pp-mirror/Meshroom
1
0
Fork 0
mirror of https://github.com/alicevision/Meshroom.git synced 2025-07-16 00:05:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

[core] plugins: Add new methods to the manager to manipulate plugins

Browse source
This commit is contained in:
Candice Bentéjac 2025-05-26 15:27:38 +01:00
parent 0adb3754f3
commit b3ee2ad329
1 changed files with 48 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

53
meshroom/core/plugins.py
View file

@ -102,6 +102,14 @@ class Plugin(BaseObject):
""" Return the absolute path of the plugin. """ """ Return the absolute path of the plugin. """
return self._path return self._path
@property
def nodes(self):
"""
Return the dictionary containing the NodePlugin objects associated to
the plugin.
"""
return self._nodePlugins
@property @property
def templates(self): def templates(self):
""" Return the list of templates associated to the plugin. """ """ Return the list of templates associated to the plugin. """
@ -278,15 +286,36 @@ class NodePluginManager(BaseObject):
return self._plugins[name] return self._plugins[name]
return None return None
def addPlugin(self, plugin: Plugin): def addPlugin(self, plugin: Plugin, registerNodePlugins: bool = True):
""" """
Load a Plugin object. Load a Plugin object.
Args: Args:
plugin: the Plugin to load and add to the list of loaded plugins. plugin: the Plugin to load and add to the list of loaded plugins.
registerNodePlugins: True if all the NodePlugins from the plugin should be registered
at the same time the plugin is being loaded. Otherwise, the
NodePlugins will have to be registered at a later occasion.
""" """
if not self.getPlugin(plugin.name): if not self.getPlugin(plugin.name):
self._plugins[plugin.name] = plugin self._plugins[plugin.name] = plugin
if registerNodePlugins:
self.registerPlugin(plugin.name)
def removePlugin(self, plugin: Plugin, unregisterNodePlugins: bool = True):
"""
Remove a loaded Plugin object.
Args:
plugin: the Plugin to remove from the list of loaded plugins.
unregisterNodePlugins: True if all the nodes from the plugin should be unregistered (if they
are registered) at the same time as the plugin is unloaded. Otherwise,
the registered NodePlugins will remain while the Plugin itself will
be unloaded.
"""
if self.getPlugin(plugin.name):
if unregisterNodePlugins:
self.unregisterPlugin(plugin.name)
del self._plugins[plugin.name]
def getRegisteredNodePlugins(self) -> dict[str: NodePlugin]: def getRegisteredNodePlugins(self) -> dict[str: NodePlugin]:
""" """
@ -314,15 +343,28 @@ class NodePluginManager(BaseObject):
Register all the NodePlugins contained in the Plugin loaded as "name". Register all the NodePlugins contained in the Plugin loaded as "name".
Args: Args:
name: the name of the Plugin whose NodePlugins will be registered. name: the name of the Plugin whose NodePlugins will be registered.
""" """
plugin = self.getPlugin(name) plugin = self.getPlugin(name)
if plugin: if plugin:
for node in plugin._nodePlugins: for node in plugin.nodes:
self.registerNode(plugin._nodePlugins[node]) self.registerNode(plugin.nodes[node])
else: else:
logging.error(f"No loaded Plugin named {name}.") logging.error(f"No loaded Plugin named {name}.")
def unregisterPlugin(self, name: str):
"""
Unregister all the NodePlugins contained in the Plugin loaded as "name"
that are currently registered.
Args:
name: the name of the Plugin whose NodePlugins will be unregistered.
"""
plugin = self.getPlugin(name)
if plugin:
for node in plugin.nodes.values():
self.unregisterNode(node)
def registerNode(self, nodePlugin: NodePlugin): def registerNode(self, nodePlugin: NodePlugin):
""" """
Register a node plugin. A registered node plugin will become instantiable. Register a node plugin. A registered node plugin will become instantiable.
@ -353,5 +395,6 @@ class NodePluginManager(BaseObject):
if self.isRegistered(name): if self.isRegistered(name):
if nodePlugin.status != NodePluginStatus.LOADED: if nodePlugin.status != NodePluginStatus.LOADED:
logging.warning(f"NodePlugin {name} is registered but is not correctly loaded.") logging.warning(f"NodePlugin {name} is registered but is not correctly loaded.")
else:
nodePlugin.status = NodePluginStatus.NOT_LOADED
del self._nodePlugins[name] del self._nodePlugins[name]
nodePlugin.status = NodePluginStatus.NOT_LOADED