bec_widgets.utils.bec_plugin_helper
===================================

.. py:module:: bec_widgets.utils.bec_plugin_helper


Attributes
----------

.. autoapisummary::

   bec_widgets.utils.bec_plugin_helper.client


Functions
---------

.. autoapisummary::

   bec_widgets.utils.bec_plugin_helper._all_widgets_from_all_submods
   bec_widgets.utils.bec_plugin_helper._get_widgets_from_module
   bec_widgets.utils.bec_plugin_helper._loaded_submodules_from_specs
   bec_widgets.utils.bec_plugin_helper._submodule_by_name
   bec_widgets.utils.bec_plugin_helper._submodule_specs
   bec_widgets.utils.bec_plugin_helper.get_all_plugin_widgets
   bec_widgets.utils.bec_plugin_helper.get_plugin_client_module
   bec_widgets.utils.bec_plugin_helper.user_widget_plugin


Module Contents
---------------

.. py:function:: _all_widgets_from_all_submods(module) -> bec_widgets.utils.plugin_utils.BECClassContainer

   Recursively load submodules, find any BECWidgets, and return them all as a flat dict.


.. py:function:: _get_widgets_from_module(module: types.ModuleType) -> bec_widgets.utils.plugin_utils.BECClassContainer

   Find any BECWidget subclasses in the given module and return them with their info.


.. py:function:: _loaded_submodules_from_specs(submodule_specs: tuple[importlib.machinery.ModuleSpec | None, Ellipsis]) -> Generator[types.ModuleType, None, None]

   Load all submodules from the given specs.


.. py:function:: _submodule_by_name(module: types.ModuleType, name: str)

.. py:function:: _submodule_specs(module: types.ModuleType) -> tuple[importlib.machinery.ModuleSpec | None, Ellipsis]

   Return specs for all submodules of the given module.


.. py:function:: get_all_plugin_widgets() -> bec_widgets.utils.plugin_utils.BECClassContainer

   If there is a plugin repository installed, load all widgets from it.


.. py:function:: get_plugin_client_module() -> types.ModuleType | None

   If there is a plugin repository installed, return the client module.


.. py:function:: user_widget_plugin() -> types.ModuleType | None

.. py:data:: client