Merge pull request #565 from mmikita95/feat-ungenerated-ui-warning

chore: fail gracefully when ui.py was not generated

src/writer/__init__.py

@@ -1,4 +1,6 @@
 import importlib.metadata
+import logging
+import textwrap
 from types import ModuleType
 from typing import Any, Dict, List, Optional, Type, TypeVar, Union, cast
 
@@ -20,7 +22,24 @@
 from writer.core import (
     writerproperty as property,
 )
-from writer.ui import WriterUIManager
+
+try:
+    from writer.ui import WriterUIManager
+    PROPER_UI_INIT = True
+except ModuleNotFoundError:
+    logging.error(
+            textwrap.dedent(
+                """\
+                \x1b[31;20mError: Failed to import `writer.ui` module.
+                This indicates that the Writer Framework was not built properly.
+                Please refer to CONTRIBUTING.md for instructions to resolve this issue.\x1b[0m"""
+            )
+        )
+    PROPER_UI_INIT = False
+
+def _get_ui_runtime_error_message() -> str:
+    return "UI module is unavailable – Writer Framework is not properly built. " + \
+            "Please refer to CONTRIBUTING.md for instructions to resolve this issue."
 
 VERSION = importlib.metadata.version("writer")
 
@@ -72,7 +91,10 @@ def init_ui() -> WriterUIManager:
     >>>     with ui.Page({"key": "hello"}):
     >>>         ui.Text({"text": "Hello pigeons"})
     """
-    return WriterUIManager()
+    if PROPER_UI_INIT:
+        return WriterUIManager()
+    else:
+        raise RuntimeError(_get_ui_runtime_error_message())
 
 
 def init_state(raw_state: Dict[str, Any], schema: Optional[Type[S]] = None) -> Union[S, WriterState]:

src/writer/core.py

@@ -2529,8 +2529,12 @@ def _event_handler_session_info() -> Dict[str, Any]:
     return session_info
 
 def _event_handler_ui_manager():
-    from writer.ui import WriterUIManager
-    return WriterUIManager()
+    from writer import PROPER_UI_INIT, _get_ui_runtime_error_message
+    if PROPER_UI_INIT:
+        from writer.ui import WriterUIManager
+        return WriterUIManager()
+    else:
+        raise RuntimeError(_get_ui_runtime_error_message())
 
 
 def _split_record_as_pandas_record_and_index(param: dict, index_columns: list) -> Tuple[dict, tuple]: