dara-core 1.16.14__py3-none-any.whl → 1.16.16__py3-none-any.whl

dara/core/configuration.py

@@ -76,6 +76,7 @@ class Configuration(BaseModel):
     components: List[ComponentTypeAnnotation]
     context_components: List[ComponentInstance]
     enable_devtools: bool
+    module_dependencies: Dict[str, str]
     live_reload: bool
     powered_by_causalens: bool
     pages: Dict[str, Page]
@@ -118,6 +119,10 @@ class Configuration(BaseModel):
         for comp in self.auth_config.component_config.model_dump().values():
             packages[comp['py_module']] = comp['js_module']
 
+        # Include explicit modules
+        for py_module, js_module in self.module_dependencies.items():
+            packages[py_module] = js_module
+
         return packages
 
 
@@ -137,6 +142,7 @@ class ConfigurationBuilder:
     registry_lookup: CustomRegistryLookup
     _actions: List[ActionDef]
     _components: List[ComponentTypeAnnotation]
+    _module_dependencies: Dict[str, str]
     _errors: List[str]
     enable_devtools: bool
     live_reload: bool
@@ -164,6 +170,7 @@ class ConfigurationBuilder:
         self.registry_lookup = {}
         self._actions = []
         self._components = []
+        self._module_dependencies = {}
         self._errors = []
         self.enable_devtools = False
         self.live_reload = False
@@ -266,6 +273,21 @@ class ConfigurationBuilder:
 
         return component_def
 
+    def add_module_dependency(self, py_module: str, js_module: str):
+        """
+        Explicitly add a module to the application. This is useful to ensure that a given module's assets are included in the build even
+        if no components from it are used explicitly in the application.
+
+        For example, when building a plugin that registers custom JS (e.g. in the form of a context component) that relies on the JS side of `@darajs/components`,
+        you could explicitly add the module in your plugin:
+
+        ```python
+        def my_plugin(config: ConfigurationBuilder):
+            config.add_module('dara.components', '@darajs/components')
+        ```
+        """
+        self._module_dependencies[py_module] = js_module
+
     def add_configuration(self, config: EndpointConfiguration):
         """
         Register an EndpointConfiguration instance with the application.
@@ -543,6 +565,7 @@ class ConfigurationBuilder:
             context_components=self.context_components,
             endpoint_configurations=self._endpoint_configurations,
             enable_devtools=self.enable_devtools,
+            module_dependencies=self._module_dependencies,
             live_reload=self.live_reload,
             powered_by_causalens=self.powered_by_causalens,
             package_tag_processors=self._package_tags_processors,

dara/core/internal/import_discovery.py

@@ -20,6 +20,8 @@ import sys
 from types import ModuleType
 from typing import Any, List, Optional, Set, Tuple, Type, Union
 
+from typing_extensions import TypeGuard
+
 from dara.core.base_definitions import ActionDef, ActionImpl
 from dara.core.definitions import ComponentInstance, JsComponentDef, discover
 from dara.core.interactivity.any_variable import AnyVariable
@@ -31,6 +33,13 @@ def _is_component_subclass(obj: Any) -> bool:
     return inspect.isclass(obj) and issubclass(obj, ComponentInstance) and obj != ComponentInstance
 
 
+def _is_component_instance(obj: Any) -> TypeGuard[ComponentInstance]:
+    try:
+        return isinstance(obj, ComponentInstance)
+    except Exception:
+        return False
+
+
 def _is_action_subclass(obj: Any) -> bool:
     return inspect.isclass(obj) and issubclass(obj, ActionImpl) and obj != ActionImpl
 
@@ -101,6 +110,8 @@ def run_discovery(
         # Look for subclasses of ComponentInstance or ActionImpl
         if _is_component_subclass(v):
             components.add(v)
+        elif _is_component_instance(v):
+            components.add(v.__class__)
         elif _is_action_subclass(v):
             actions.add(v)
         elif inspect.isfunction(v):

dara/core/js_tooling/js_utils.py

@@ -15,6 +15,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 """
 
+import importlib
 import json
 import os
 import pathlib
@@ -419,6 +420,20 @@ def _py_version_to_js(package_name: str) -> str:
     return raw_version
 
 
+def _get_module_file(module: str) -> str:
+    """
+    Get the file containing the given module
+
+    :param module: module name, e.g. 'dara.core'
+    """
+    try:
+        return cast(str, sys.modules[module].__file__)
+    except KeyError:
+        # module wasn't imported, try to load it explicitly
+        imported_module = importlib.import_module(module)
+        return cast(str, imported_module.__file__)
+
+
 def rebuild_js(build_cache: BuildCache, build_diff: BuildCacheDiff = BuildCacheDiff.full_diff()):
     """
     Generic 'rebuild' function which bundles/prepares assets depending on the build mode chosen
@@ -576,7 +591,7 @@ def prepare_autojs_assets(build_cache: BuildCache):
     :param config: the main app configuration
     """
     # copy over dara.core js/css into static dir
-    core_path = os.path.dirname(cast(str, sys.modules['dara.core'].__file__))
+    core_path = os.path.dirname(_get_module_file('dara.core'))
     core_js_path = os.path.join(core_path, 'umd', 'dara.core.umd.js')
     core_css_path = os.path.join(core_path, 'umd', 'style.css')
     statics = os.path.join(pathlib.Path(__file__).parent.absolute(), 'statics')
@@ -599,7 +614,7 @@ def prepare_autojs_assets(build_cache: BuildCache):
     # Copy over js/css for all modules
     for module_name in py_modules:
         # Get path to the module
-        module_path = os.path.dirname(cast(str, sys.modules[module_name].__file__))
+        module_path = os.path.dirname(_get_module_file(module_name))
 
         # Build paths to the JS and CSS assets for the given module
         # Note: this assumes assets structure of module/umd folder with the module.umd.js and style.css file

dara/core/logging.py

@@ -254,13 +254,14 @@ class DaraDevFormatter(logging.Formatter):
         'INFO': (Back.GREEN, Fore.GREEN),
         'WARNING': (Back.YELLOW, Fore.YELLOW),
     }
+    default_color = (Back.GREEN, Fore.GREEN)
 
     def format(self, record: logging.LogRecord):
+        colors = self.level_to_color_map.get(record.levelname, self.default_color)
         if isinstance(record.msg, dict):
             payload = {**record.msg}
             fmt_time = self.formatTime(record, self.datefmt)
             spacer = ' ' * 4
-            colors = self.level_to_color_map[record.levelname]
             base_msg = self.base_message_template % (
                 fmt_time,
                 colors[0],
@@ -303,7 +304,6 @@ class DaraDevFormatter(logging.Formatter):
                     description = self.extra_template % (spacer, f'Description: {payload["description"]}')
                 return base_msg + '\r\n' + file_details + description + content + '\r\n' + self.message_end
 
-        colors = self.level_to_color_map[record.levelname]
         return self.base_message_template % (
             self.formatTime(record, self.datefmt),
             colors[0],