instaui 0.1.3__py3-none-any.whl → 0.1.4__py3-none-any.whl

instaui/systems/module_system.py

@@ -0,0 +1,30 @@
+from importlib import import_module
+from types import ModuleType
+from typing import Any, List
+
+
+class LazyModule(ModuleType):
+    def __init__(self, name: str, member: str):
+        super().__init__(name)
+        self._name = name
+        self._mod = None
+        self._member_obj = None
+        self._member = member
+
+    def __getattr__(self, attr: str) -> Any:
+        self.__try_import()
+        return getattr(self._member_obj, attr)
+
+    def __call__(self, *args: Any, **kwds: Any) -> Any:
+        self.__try_import()
+        return self._member_obj(*args, **kwds)  # type: ignore
+
+    def __dir__(self) -> List[str]:
+        if self._mod is None:
+            self._mod = import_module(self._name)
+        return dir(self._mod)
+
+    def __try_import(self):
+        if self._mod is None:
+            self._mod = import_module(self._name)
+            self._member_obj = getattr(self._mod, self._member)

instaui/template/zero_template.py

@@ -52,51 +52,52 @@ class ZeroTemplateModel:
         return dumps(data)
 
     def normalize_path_with_self(self):
-        self.vue_js_code = self._normalize_path_to_dataurl(self.vue_js_code, _JS_PREFIX)
-        self.instaui_js_code = self._normalize_path_to_dataurl(
+        self.vue_js_code = _normalize_path_to_dataurl(self.vue_js_code, _JS_PREFIX)
+        self.instaui_js_code = _normalize_path_to_dataurl(
             self.instaui_js_code, _JS_PREFIX
         )
 
         self.css_links = [
-            self._normalize_path_to_dataurl(link, _CSS_PREFIX)
+            _normalize_path_to_dataurl(link, _CSS_PREFIX)
             for link in self.css_links
+            if isinstance(link, str) or (isinstance(link, Path) and link.is_file())
         ]
 
         self.js_links = [
             JsLink(
-                link=self._normalize_path_to_dataurl(link.link, _JS_PREFIX),
+                link=_normalize_path_to_dataurl(link.link, _JS_PREFIX),
                 attrs=link.attrs,
             )
             for link in self.js_links
         ]
 
         self.extra_import_maps = {
-            k: self._normalize_path_to_dataurl(v, _JS_PREFIX)
+            k: _normalize_path_to_dataurl(v, _JS_PREFIX)
             for k, v in self.extra_import_maps.items()
         }
 
         self.vue_app_component = [
             ZeroVueAppComponent(
                 name=component.name,
-                url=self._normalize_path_to_dataurl(component.url, _JS_PREFIX),
+                url=_normalize_path_to_dataurl(component.url, _JS_PREFIX),
             )
             for component in self.vue_app_component
         ]
 
-        self.favicon = self._normalize_path_to_base64_url(self.favicon, _ICON_PREFIX)
+        self.favicon = _normalize_path_to_base64_url(self.favicon, _ICON_PREFIX)  # type: ignore
 
-    @staticmethod
-    def _normalize_path_to_dataurl(path: typing.Union[str, Path], prefix: str):
-        if isinstance(path, Path):
-            path = path.read_text(encoding="utf-8")
 
-        return f"{prefix},{quote(path)}"
+def _normalize_path_to_dataurl(path: typing.Union[str, Path], prefix: str):
+    if isinstance(path, Path):
+        path = path.read_text(encoding="utf-8")
 
-    @staticmethod
-    def _normalize_path_to_base64_url(path: typing.Optional[Path], prefix: str):
-        if path is None:
-            return None
-        return f"{prefix},{base64.b64encode(path.read_bytes()).decode('utf-8')}"
+    return f"{prefix},{quote(path)}"
+
+
+def _normalize_path_to_base64_url(path: typing.Optional[Path], prefix: str):
+    if path is None:
+        return None
+    return f"{prefix},{base64.b64encode(path.read_bytes()).decode('utf-8')}"
 
 
 def render_zero_html(model: ZeroTemplateModel) -> str:

instaui/ui/__build_init.py

@@ -0,0 +1,73 @@
+from pathlib import Path
+from typing import List
+
+
+PYI_FILE = Path(__file__).parent / "__init__.pyi"
+INIT_FILE = Path(__file__).parent / "__init__.py"
+
+MARK_ALL = "# -- __all__"
+MARK_STATIC_IMPORTS = "# -- static imports"
+MARK_DYNAMIC_IMPORTS = "# -- dynamic imports"
+
+LAZY_MODULE_IMPORT = "from instaui.systems.module_system import LazyModule"
+
+
+def create_init_file():
+    all_part_lines, static_lines, dynamic_lines = _split_by_marks(
+        PYI_FILE, [MARK_ALL, MARK_STATIC_IMPORTS, MARK_DYNAMIC_IMPORTS]
+    )
+
+    # first line is comment, skip it
+    dynamic_lines = [
+        _conver_dynamic(line) for line in dynamic_lines[1:] if line.strip()
+    ]
+
+    with open(INIT_FILE, "w", encoding="utf-8") as f:
+        f.writelines("\n".join(all_part_lines))
+        f.write("\n")
+        f.writelines("\n".join(static_lines))
+        f.write("\n")
+
+        f.writelines(
+            "\n".join([MARK_DYNAMIC_IMPORTS, LAZY_MODULE_IMPORT, *dynamic_lines])
+        )
+
+    print(f"Create {INIT_FILE} success.")
+
+
+def _split_by_marks(file: Path, marks: List[str]):
+    with open(file, "r", encoding="utf-8") as f:
+        lines = f.read().splitlines()
+
+    marks_index = [lines.index(mark) for mark in marks]
+    marks_index.append(len(lines))
+
+    return [
+        lines[marks_index[i] : marks_index[i + 1]] for i in range(len(marks_index) - 1)
+    ]
+
+
+def _conver_dynamic(dynamic_code: str):
+    # "from instaui.components.highlight_code.code import Code as code" convert to "code = LazyModule('instaui.components.highlight_code.code', 'Code')"
+
+    # instaui.components.highlight_code.code
+    from_part = dynamic_code.split("import")[0][5:].strip()
+
+    # Code as code
+    import_part = dynamic_code.split("import")[1].strip()
+    has_as = " as " in import_part
+
+    member_name = ""
+    alias_name = ""
+
+    if has_as:
+        member_name, alias_name = import_part.split(" as ")
+    else:
+        member_name = import_part
+        alias_name = member_name
+
+    return f"{alias_name} = LazyModule('{from_part}', '{member_name}')"
+
+
+if __name__ == "__main__":
+    create_init_file()

instaui/ui/__init__.py

@@ -1,61 +1,4 @@
-from instaui.version import __version__
-from instaui.vars import TMaybeRef
-from instaui.vars.ref import ref, TRef
-
-from instaui.vars.data import ConstData as data, TConstData
-from instaui.vars.js_computed import JsComputed as js_computed, TJsComputed
-from instaui.vars.vue_computed import VueComputed as vue_computed, TVueComputed
-from instaui.vars.web_computed import web_computed as computed, TComputed
-from instaui.vars.state import state, StateModel
-from instaui.inject import inject_state, provide_state, injection_key
-from instaui.vars.vfor_item import TVForItem, TVForIndex
-from instaui.vars.element_ref import ElementRef as element_ref, run_element_method
-from instaui.html_tools import (
-    to_json,
-    add_css_link,
-    add_js_link,
-    add_style,
-    add_js_code,
-    add_vue_app_use,
-    to_config_data,
-    use_tailwind,
-    use_page_title,
-)
-
-from instaui.components.element import Element as element
-from instaui.components.row import Row as row
-from instaui.components.column import Column as column
-from instaui.components.grid import Grid as grid
-from instaui.components.directive import Directive as directive
-from instaui.components.vfor import VFor as vfor
-from instaui.components.vif import VIf as vif
-from instaui.components.match import Match as match
-from instaui.components.content import Content as content
-
-from instaui.event.web_event import ui_event as event, WebEvent as TEventFn
-from instaui.event.js_event import js_event
-from instaui.vars.event_context import EventContext as event_context
-from instaui.runtime.context import get_context as context
-
-import instaui.js as js
-from instaui.watch.web_watch import watch
-from instaui.watch.vue_watch import VueWatch as vue_watch
-from instaui.watch.js_watch import js_watch
-from instaui.handlers.watch_handler import WatchState as TWatchState
-from instaui.skip import skip_output
-from instaui.ui_functions.input_slient_data import InputSilentData as slient
-from instaui.js.js_output import JsOutput as js_output
-import instaui.experimental as experimental
-
-
-from instaui.ui_functions.server import create_server as server
-from instaui.ui_functions.ui_page import page
-from instaui.ui_functions.url_location import UrlLocation as url_location
-from instaui.ui_functions.str_format import str_format
-from instaui.ui_functions.ui_types import TBindable, is_bindable
-
-from .events import on_page_request_lifespan
-
+# -- __all__
 __all__ = [
     "__version__",
     "TMaybeRef",
@@ -88,6 +31,7 @@ __all__ = [
     "content",
     "add_style",
     "add_css_link",
+    "remove_css_link",
     "add_js_code",
     "add_js_link",
     "add_vue_app_use",
@@ -117,4 +61,70 @@ __all__ = [
     "str_format",
     "url_location",
     "on_page_request_lifespan",
+    "code",
+    "markdown",
 ]
+
+# -- static imports
+from instaui.version import __version__
+from instaui.vars import TMaybeRef
+from instaui.vars.ref import ref, TRef
+
+from instaui.vars.data import ConstData as data, TConstData
+from instaui.vars.js_computed import JsComputed as js_computed, TJsComputed
+from instaui.vars.vue_computed import VueComputed as vue_computed, TVueComputed
+from instaui.vars.web_computed import web_computed as computed, TComputed
+from instaui.vars.state import state, StateModel
+from instaui.inject import inject_state, provide_state, injection_key
+from instaui.vars.vfor_item import TVForItem, TVForIndex
+from instaui.vars.element_ref import ElementRef as element_ref, run_element_method
+from instaui.html_tools import (
+    to_json,
+    add_css_link,
+    remove_css_link,
+    add_js_link,
+    add_style,
+    add_js_code,
+    add_vue_app_use,
+    to_config_data,
+    use_tailwind,
+    use_page_title,
+)
+
+from instaui.components.element import Element as element
+from instaui.components.row import Row as row
+from instaui.components.column import Column as column
+from instaui.components.grid import Grid as grid
+from instaui.components.directive import Directive as directive
+from instaui.components.vfor import VFor as vfor
+from instaui.components.vif import VIf as vif
+from instaui.components.match import Match as match
+from instaui.components.content import Content as content
+
+from instaui.event.web_event import ui_event as event, WebEvent as TEventFn
+from instaui.event.js_event import js_event
+from instaui.vars.event_context import EventContext as event_context
+from instaui.runtime.context import get_context as context
+
+import instaui.js as js
+from instaui.watch.web_watch import watch
+from instaui.watch.vue_watch import VueWatch as vue_watch
+from instaui.watch.js_watch import js_watch
+from instaui.handlers.watch_handler import WatchState as TWatchState
+from instaui.skip import skip_output
+from instaui.ui_functions.input_slient_data import InputSilentData as slient
+from instaui.js.js_output import JsOutput as js_output
+import instaui.experimental as experimental
+
+from instaui.ui_functions.server import create_server as server
+from instaui.ui_functions.ui_page import page
+from instaui.ui_functions.url_location import UrlLocation as url_location
+from instaui.ui_functions.str_format import str_format
+from instaui.ui_functions.ui_types import TBindable, is_bindable
+
+from .events import on_page_request_lifespan
+
+# -- dynamic imports
+from instaui.systems.module_system import LazyModule
+code = LazyModule('instaui.components.highlight_code.code', 'Code')
+markdown = LazyModule('instaui.components.markdown.markdown', 'Markdown')

instaui/ui/__init__.pyi

@@ -0,0 +1,129 @@
+# -- __all__
+__all__ = [
+    "__version__",
+    "TMaybeRef",
+    "TBindable",
+    "is_bindable",
+    "ref",
+    "slient",
+    "data",
+    "TConstData",
+    "TRef",
+    "vue_computed",
+    "TVueComputed",
+    "js_computed",
+    "TJsComputed",
+    "computed",
+    "TComputed",
+    "state",
+    "StateModel",
+    "inject_state",
+    "provide_state",
+    "injection_key",
+    "TVForItem",
+    "TVForIndex",
+    "element_ref",
+    "run_element_method",
+    "to_json",
+    "to_config_data",
+    "element",
+    "vfor",
+    "content",
+    "add_style",
+    "add_css_link",
+    "remove_css_link",
+    "add_js_code",
+    "add_js_link",
+    "add_vue_app_use",
+    "use_tailwind",
+    "use_page_title",
+    "directive",
+    "vif",
+    "page",
+    "event",
+    "js_event",
+    "event_context",
+    "TEventFn",
+    "server",
+    "context",
+    "row",
+    "grid",
+    "js",
+    "watch",
+    "vue_watch",
+    "js_watch",
+    "TWatchState",
+    "match",
+    "column",
+    "experimental",
+    "skip_output",
+    "js_output",
+    "str_format",
+    "url_location",
+    "on_page_request_lifespan",
+    "code",
+    "markdown",
+]
+
+# -- static imports
+from instaui.version import __version__
+from instaui.vars import TMaybeRef
+from instaui.vars.ref import ref, TRef
+
+from instaui.vars.data import ConstData as data, TConstData
+from instaui.vars.js_computed import JsComputed as js_computed, TJsComputed
+from instaui.vars.vue_computed import VueComputed as vue_computed, TVueComputed
+from instaui.vars.web_computed import web_computed as computed, TComputed
+from instaui.vars.state import state, StateModel
+from instaui.inject import inject_state, provide_state, injection_key
+from instaui.vars.vfor_item import TVForItem, TVForIndex
+from instaui.vars.element_ref import ElementRef as element_ref, run_element_method
+from instaui.html_tools import (
+    to_json,
+    add_css_link,
+    remove_css_link,
+    add_js_link,
+    add_style,
+    add_js_code,
+    add_vue_app_use,
+    to_config_data,
+    use_tailwind,
+    use_page_title,
+)
+
+from instaui.components.element import Element as element
+from instaui.components.row import Row as row
+from instaui.components.column import Column as column
+from instaui.components.grid import Grid as grid
+from instaui.components.directive import Directive as directive
+from instaui.components.vfor import VFor as vfor
+from instaui.components.vif import VIf as vif
+from instaui.components.match import Match as match
+from instaui.components.content import Content as content
+
+from instaui.event.web_event import ui_event as event, WebEvent as TEventFn
+from instaui.event.js_event import js_event
+from instaui.vars.event_context import EventContext as event_context
+from instaui.runtime.context import get_context as context
+
+import instaui.js as js
+from instaui.watch.web_watch import watch
+from instaui.watch.vue_watch import VueWatch as vue_watch
+from instaui.watch.js_watch import js_watch
+from instaui.handlers.watch_handler import WatchState as TWatchState
+from instaui.skip import skip_output
+from instaui.ui_functions.input_slient_data import InputSilentData as slient
+from instaui.js.js_output import JsOutput as js_output
+import instaui.experimental as experimental
+
+from instaui.ui_functions.server import create_server as server
+from instaui.ui_functions.ui_page import page
+from instaui.ui_functions.url_location import UrlLocation as url_location
+from instaui.ui_functions.str_format import str_format
+from instaui.ui_functions.ui_types import TBindable, is_bindable
+
+from .events import on_page_request_lifespan
+
+# -- dynamic imports
+from instaui.components.highlight_code.code import Code as code
+from instaui.components.markdown.markdown import Markdown as markdown

instaui/ui/events.py

@@ -8,7 +8,7 @@ def on_page_request_lifespan(fn: Callable):
     Args:
         fn (Callable): A function to be called on each page request.
 
-    Example:
+    Examples:
     .. code-block:: python
         @ui.on_page_request_lifespan
         def _():

instaui/ui_functions/server.py

@@ -1,8 +1,10 @@
+from typing import Union
 from instaui.runtime.context import get_context
 
 
 def create_server(
     debug: bool = True,
+    use_gzip: Union[int, bool] = True,
 ):
     from instaui.fastapi_server.server import Server
 
@@ -10,4 +12,4 @@ def create_server(
     context._app_mode = "web"
     context._debug_mode = debug
 
-    return Server.get_instance()
+    return Server(use_gzip=use_gzip)

instaui/zero/func.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 import itertools
 from pathlib import Path
-from typing import Union
 import instaui.consts as consts
 from instaui.runtime._app import get_app_slot, get_default_app_slot
 from instaui.template import render_zero_html
@@ -10,15 +9,7 @@ from instaui.html_tools import to_config_data
 from instaui.runtime.dataclass import JsLink
 
 
-def to_html(file: Union[str, Path]):
-    if isinstance(file, str):
-        import inspect
-
-        frame = inspect.currentframe().f_back  # type: ignore
-        assert frame is not None
-        script_file = inspect.getfile(frame)
-        file = Path(script_file).parent.joinpath(file)
-
+def to_html(file: Path):
     file = Path(file)
 
     raw = to_html_str()
@@ -27,7 +18,7 @@ def to_html(file: Union[str, Path]):
     return file.resolve().absolute()
 
 
-def to_html_str():
+def get_template_model():
     system_slot = get_app_slot()
     default_app_slot = get_default_app_slot()
     html_resource = system_slot._html_resource
@@ -71,6 +62,11 @@ def to_html_str():
             for css_link in component.css:
                 model.css_links.append(css_link)
 
+        if component.externals:
+            for name, url in component.externals.items():
+                if url.is_file():
+                    model.add_extra_import_map(name, url)
+
     # register custom plugins
     for plugin in set(
         itertools.chain(
@@ -112,4 +108,9 @@ def to_html_str():
     ):
         model.style_tags.append(sylte_code)
 
+    return model
+
+
+def to_html_str():
+    model = get_template_model()
     return render_zero_html(model)

instaui/zero/scope.py

@@ -2,7 +2,8 @@ from pathlib import Path
 from typing import Union
 from instaui.runtime import new_app_slot, reset_app_slot
 from contextlib import contextmanager
-from .func import to_html, to_html_str
+from .func import to_html, to_html_str, get_template_model
+from instaui.template.zero_template import ZeroTemplateModel
 
 
 @contextmanager
@@ -14,7 +15,94 @@ def scope():
 
 class Wrapper:
     def to_html(self, file: Union[str, Path]):
+        file = self._get_caller_path(file)
         return to_html(file)
 
     def to_html_str(self):
         return to_html_str()
+
+    def to_debug_report(self, file: Union[str, Path]):
+        file = self._get_caller_path(file)
+
+        # Custom component dependencies must be recorded only during actual execution
+        to_html_str()
+        model = get_template_model()
+        with scope() as s:
+            _create_debug_report(model)
+            s.to_html(file.resolve().absolute())
+
+    @staticmethod
+    def _get_caller_path(file: Union[str, Path]) -> Path:
+        if isinstance(file, str):
+            import inspect
+
+            frame = inspect.currentframe().f_back.f_back  # type: ignore
+            assert frame is not None
+            script_file = inspect.getfile(frame)
+            file = Path(script_file).parent.joinpath(file)
+
+        return file
+
+
+def _create_debug_report(model: ZeroTemplateModel):
+    from instaui import ui, html
+
+    no_exists_path_class = "ex-no-exists-path"
+
+    def _path_exists_class(path: Path):
+        return "" if path.exists() else no_exists_path_class
+
+    ui.use_tailwind()
+    ui.add_style(rf".{no_exists_path_class} {{background-color: red;color: white;}}")
+
+    with ui.column().classes("gap-2"):
+        # import maps
+        html.paragraph("import maps")
+        with ui.grid(columns="auto 1fr").classes(
+            "gap-4 border-2 border-gray-200 p-4 place-center"
+        ):
+            html.span("name")
+            html.span("path")
+
+            html.span("vue")
+            html.span(str(model.vue_js_code))
+
+            html.span("instaui")
+            html.span(str(model.instaui_js_code))
+
+            for name, url in model.extra_import_maps.items():
+                if isinstance(url, Path) and url.is_file():
+                    html.span(name)
+                    html.span(str(url.resolve().absolute())).classes(
+                        _path_exists_class(url)
+                    )
+
+        # css links
+        html.paragraph("css links")
+        with ui.column().classes("gap-4 border-2 border-gray-200 p-4 place-center"):
+            for link in model.css_links:
+                if isinstance(link, Path) and link.is_file():
+                    html.span(str(link)).classes(_path_exists_class(link))
+
+        # js links
+        html.paragraph("js links")
+        with ui.column().classes("gap-4 border-2 border-gray-200 p-4 place-center"):
+            for info in model.js_links:
+                if isinstance(info.link, Path) and info.link.is_file():
+                    html.span(str(info.link)).classes(_path_exists_class(info.link))
+
+        # custom components
+        html.paragraph("custom components")
+        with ui.grid(columns="auto 1fr").classes(
+            "gap-4 border-2 border-gray-200 p-4 place-center"
+        ):
+            html.span("name")
+            html.span("js file path")
+
+            for info in model.vue_app_component:
+                html.span(info.name)
+
+                if isinstance(info.url, Path) and info.url.is_file():
+                    html.span(str(info.url)).classes(_path_exists_class(info.url))
+                else:
+                    html.span("not file")

{instaui-0.1.3.dist-info → instaui-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: instaui
-Version: 0.1.3
+Version: 0.1.4
 Summary: insta-ui is a Python-based UI library for rapidly building user interfaces.
 License: MIT
 Author: CrystalWindSnake