instaui 0.1.15__py2.py3-none-any.whl

instaui/template/__init__.py

@@ -0,0 +1,4 @@
+from .web_template import render_web_html
+from .zero_template import render_zero_html
+
+__all__ = ["render_web_html", "render_zero_html"]

instaui/template/_utils.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+import typing
+from pathlib import Path
+from urllib.parse import quote
+import base64
+
+
+_JS_PREFIX = "data:text/javascript;charset=utf-8"
+_CSS_PREFIX = "data:text/css;charset=utf-8"
+_ICON_PREFIX = "data:image/x-icon;base64"
+
+
+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_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')}"

instaui/template/env.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+import jinja2
+
+
+env = jinja2.Environment(
+    loader=jinja2.PackageLoader("instaui.static", "templates"),
+)

instaui/template/web_template.py

@@ -0,0 +1,49 @@
+from __future__ import annotations
+import typing
+from dataclasses import dataclass, field
+from .env import env
+from instaui.common.jsonable import dumps
+from instaui.runtime.context import get_context
+from instaui.runtime.dataclass import JsLink, VueAppComponent
+
+
+_html_template = env.get_template("web.html")
+
+
+@dataclass
+class WebTemplateModel:
+    vue_js_link: str
+    instaui_js_link: str
+    config_dict: typing.Dict[str, typing.Any] = field(default_factory=dict)
+    extra_import_maps: typing.Dict[str, str] = field(default_factory=dict)
+    css_links: typing.List[str] = field(default_factory=list)
+    style_tags: typing.List[str] = field(default_factory=list)
+    js_links: typing.List[JsLink] = field(default_factory=list)
+    script_tags: typing.List[str] = field(default_factory=list)
+    vue_app_use: typing.List[str] = field(default_factory=list)
+    vue_app_component: typing.List[VueAppComponent] = field(default_factory=list)
+    prefix: str = ""
+    title: typing.Optional[str] = None
+    favicon_url: str = ""
+
+    def add_extra_import_map(self, name: str, url: str):
+        self.extra_import_maps[name] = url
+
+    @property
+    def import_maps_string(self):
+        data = {
+            **self.extra_import_maps,
+            "vue": self.vue_js_link,
+            "instaui": self.instaui_js_link,
+        }
+
+        return dumps(data)
+
+    @property
+    def is_debug(self):
+        context = get_context()
+        return context.debug_mode
+
+
+def render_web_html(model: WebTemplateModel):
+    return _html_template.render(model=model)

instaui/template/webview_template.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+import typing
+from dataclasses import dataclass, field
+from instaui.common.jsonable import dumps
+from .env import env
+
+
+_html_template = env.get_template("webview.html")
+
+
+@dataclass(frozen=True)
+class WebViewVueAppComponent:
+    name: str
+    url: str
+
+
+@dataclass
+class WebViewTemplateModel:
+    vue_js_code: str
+    instaui_js_code: str
+    config_dict: typing.Dict[str, typing.Any] = field(default_factory=dict)
+    extra_import_maps: typing.Dict[str, str] = field(default_factory=dict)
+    css_links: typing.List[str] = field(default_factory=list)
+    style_tags: typing.List[str] = field(default_factory=list)
+    js_links: typing.List[str] = field(default_factory=list)
+    script_tags: typing.List[str] = field(default_factory=list)
+    vue_app_use: typing.List[str] = field(default_factory=list)
+    vue_app_component: typing.List[WebViewVueAppComponent] = field(default_factory=list)
+    title: typing.Optional[str] = None
+    favicon_url: typing.Optional[str] = None
+    on_app_mounted: typing.Optional[typing.Callable] = None
+
+    def add_extra_import_map(self, name: str, code: str):
+        self.extra_import_maps[name] = code
+
+    @property
+    def import_maps_string(self):
+        data = {
+            **self.extra_import_maps,
+            "vue": self.vue_js_code,
+            "instaui": self.instaui_js_code,
+        }
+
+        return dumps(data)
+
+
+def render_wbeview_html(model: WebViewTemplateModel) -> str:
+    return _html_template.render(model=model)

instaui/template/zero_template.py

@@ -0,0 +1,105 @@
+from __future__ import annotations
+import typing
+from pathlib import Path
+from urllib.parse import quote
+import base64
+from dataclasses import dataclass, field
+from .env import env
+from instaui.common.jsonable import dumps
+from instaui.runtime.dataclass import JsLink
+
+_TCodeOrPath = typing.Union[str, Path]
+_JS_PREFIX = "data:text/javascript;charset=utf-8"
+_CSS_PREFIX = "data:text/css;charset=utf-8"
+_ICON_PREFIX = "data:image/x-icon;base64"
+
+_html_template = env.get_template("zero.html")
+
+
+@dataclass(frozen=True)
+class ZeroVueAppComponent:
+    name: str
+    url: _TCodeOrPath
+
+
+@dataclass
+class ZeroTemplateModel:
+    vue_js_code: _TCodeOrPath
+    instaui_js_code: _TCodeOrPath
+    config_dict: typing.Dict[str, typing.Any] = field(default_factory=dict)
+    extra_import_maps: typing.Dict[str, _TCodeOrPath] = field(default_factory=dict)
+    css_links: typing.List[_TCodeOrPath] = field(default_factory=list)
+    style_tags: typing.List[str] = field(default_factory=list)
+    js_links: typing.List[JsLink] = field(default_factory=list)
+    script_tags: typing.List[str] = field(default_factory=list)
+    vue_app_use: typing.List[str] = field(default_factory=list)
+    vue_app_component: typing.List[ZeroVueAppComponent] = field(default_factory=list)
+    prefix: str = ""
+    title: typing.Optional[str] = None
+    favicon: typing.Optional[Path] = None
+
+    def add_extra_import_map(self, name: str, url: _TCodeOrPath):
+        self.extra_import_maps[name] = url
+
+    @property
+    def import_maps_string(self):
+        data = {
+            **self.extra_import_maps,
+            "vue": self.vue_js_code,
+            "instaui": self.instaui_js_code,
+        }
+
+        return dumps(data)
+
+    def normalize_path_with_self(self):
+        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 = [
+            _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=_normalize_path_to_dataurl(link.link, _JS_PREFIX),
+                attrs=link.attrs,
+            )
+            for link in self.js_links
+        ]
+
+        self.extra_import_maps = {
+            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=_normalize_path_to_dataurl(component.url, _JS_PREFIX),
+            )
+            for component in self.vue_app_component
+        ]
+
+        self.favicon = _normalize_path_to_base64_url(self.favicon, _ICON_PREFIX)  # type: ignore
+
+
+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_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:
+    model.normalize_path_with_self()
+    return _html_template.render(model=model)

instaui/ui/__init__.py

@@ -0,0 +1,144 @@
+# -- __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",
+    "label",
+    "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",
+    "vue_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",
+    "webview",
+    "code",
+    "markdown",
+    "echarts",
+    "use_shadcn_classless",
+    "mermaid",
+]
+
+# -- static imports
+from instaui.version import __version__
+from instaui.vars.types 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.components.label import label
+
+from instaui.event.web_event import event, WebEvent as TEventFn
+from instaui.event.js_event import js_event
+from instaui.event.vue_event import vue_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
+from instaui.extra_libs._import_error import show_error  # noqa: E402, F401
+
+# -- dynamic imports
+from instaui.systems.module_system import LazyModule as _LazyModule
+markdown = _LazyModule('instaui.components.markdown.markdown', 'Markdown')
+webview = _LazyModule('instaui.webview', 'WebviewWrapper')
+use_shadcn_classless = _LazyModule('instaui.shadcn_classless._index', 'use_shadcn_classless')
+# -- extra libs
+mermaid = _LazyModule('instaui.extra_libs._mermaid', 'mermaid', import_error_callback=show_error('Mermaid is not installed. Please run "pip install instaui-mermaid" to install it.'),)
+code = _LazyModule('instaui.extra_libs._shiki_code', 'code', import_error_callback=show_error('Shiki is not installed. Please run "pip install instaui-shiki" to install it.'),)
+echarts = _LazyModule('instaui.extra_libs._echarts', 'echarts', import_error_callback=show_error('Echarts is not installed. Please run "pip install instaui-echarts" to install it.'),)

instaui/ui/__init__.pyi

@@ -0,0 +1,149 @@
+# -- __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",
+    "label",
+    "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",
+    "vue_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",
+    "webview",
+    "code",
+    "markdown",
+    "echarts",
+    "use_shadcn_classless",
+    "mermaid",
+]
+
+# -- static imports
+from instaui.version import __version__
+from instaui.vars.types 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.components.label import label
+
+from instaui.event.web_event import event, WebEvent as TEventFn
+from instaui.event.js_event import js_event
+from instaui.event.vue_event import vue_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
+from instaui.extra_libs._import_error import show_error  # noqa: E402, F401
+
+# -- dynamic imports
+from instaui.components.markdown.markdown import Markdown as markdown
+from instaui.webview import WebviewWrapper as webview
+from instaui.shadcn_classless._index import use_shadcn_classless
+
+# -- extra libs
+# mermaid = _LazyModule('instaui.extra_libs._mermaid', 'mermaid', import_error_callback=show_error('Mermaid is not installed. Please run "pip install instaui-mermaid" to install it.'),)
+from instaui_mermaid import Mermaid as mermaid  # type: ignore
+
+# code = _LazyModule('instaui.extra_libs._shiki_code', 'code', import_error_callback=show_error('Shiki is not installed. Please run "pip install instaui-shiki" to install it.'),)
+from instaui_shiki import shiki as code  # type: ignore
+
+# echarts = _LazyModule('instaui.extra_libs._echarts', 'echarts', import_error_callback=show_error('Echarts is not installed. Please run "pip install instaui-echarts" to install it.'),)
+from instaui_echarts import echarts  # type: ignore

instaui/ui/events.py

@@ -0,0 +1,25 @@
+from typing import Callable
+from instaui.launch_collector import get_launch_collector
+
+
+def on_page_request_lifespan(fn: Callable):
+    """Register a function to be called on each page request.
+
+    Args:
+        fn (Callable): A function to be called on each page request.
+
+    Examples:
+    .. code-block:: python
+        @ui.on_page_request_lifespan
+        def _():
+            print("page request start")
+            yield
+            print("page request end")
+
+        # can stop the lifespan by calling the returned function
+        stop_lifespan = ui.on_page_request_lifespan(lambda: None)
+        stop_lifespan()
+    """
+
+    remove_key = get_launch_collector().add_page_request_lifespan(fn)
+    return lambda: get_launch_collector().remove_page_request_lifespan(remove_key)

instaui/ui_functions/input_slient_data.py

@@ -0,0 +1,16 @@
+import typing
+from instaui.vars.mixin_types.py_binding import CanInputMixin
+
+
+class InputSilentData(CanInputMixin):
+    def __init__(self, value: typing.Union[CanInputMixin, typing.Any]) -> None:
+        self.value = value
+
+    def is_const_value(self) -> bool:
+        return not isinstance(self.value, CanInputMixin)
+
+    def _to_input_config(self):
+        if isinstance(self.value, CanInputMixin):
+            return self.value._to_input_config()
+        else:
+            return self.value

instaui/ui_functions/server.py

@@ -0,0 +1,15 @@
+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
+
+    context = get_context()
+    context._app_mode = "web"
+    context._debug_mode = debug
+
+    return Server(use_gzip=use_gzip)

instaui/ui_functions/str_format.py

@@ -0,0 +1,36 @@
+from typing import cast
+from instaui.vars.mixin_types.str_format_binding import StrFormatBindingMixin
+from instaui.vars.vue_computed import VueComputed
+
+
+def str_format(template: str, *args, **kwargs):
+    bindings = {}
+
+    tran_args = []
+
+    for idx, arg in enumerate(args):
+        is_mixin = isinstance(arg, StrFormatBindingMixin)
+        value = (
+            cast(StrFormatBindingMixin, arg)._to_str_format_binding(idx)
+            if is_mixin
+            else arg
+        )
+        tran_args.append(value[-1] if is_mixin else value)
+        if is_mixin:
+            bindings[value[0]] = arg
+
+    tran_kwargs = {}
+
+    for idx, (k, v) in enumerate(kwargs.items()):
+        is_mixin = isinstance(v, StrFormatBindingMixin)
+        value = (
+            cast(StrFormatBindingMixin, v)._to_str_format_binding(idx)
+            if is_mixin
+            else v
+        )
+        tran_kwargs[k] = value[-1] if is_mixin else value
+        if is_mixin:
+            bindings[value[0]] = v
+
+    code = "()=>`" + template.format(*tran_args, **tran_kwargs) + "`"
+    return VueComputed(code, bindings=bindings)

instaui/ui_functions/ui_page.py

@@ -0,0 +1,16 @@
+from typing import Callable
+from instaui.launch_collector import get_launch_collector, PageInfo
+
+
+def page(path: str = "/"):
+    """Register a page route.
+
+    Args:
+        path (str): The route path.
+    """
+
+    def wrapper(func: Callable):
+        get_launch_collector().register_page(PageInfo(path, func))
+        return func
+
+    return wrapper

instaui/ui_functions/ui_types.py

@@ -0,0 +1,13 @@
+from typing import Any, TypeVar, Union
+from instaui.vars.mixin_types.observable import ObservableMixin
+from instaui.vars.mixin_types.py_binding import CanInputMixin, CanOutputMixin
+from instaui.vars.mixin_types.element_binding import ElementBindingMixin
+
+_T = TypeVar("_T")
+
+
+def is_bindable(obj: Any):
+    return isinstance(obj, (CanInputMixin, CanOutputMixin,ObservableMixin, ElementBindingMixin))
+
+
+TBindable = Union[CanInputMixin, CanOutputMixin,ObservableMixin, ElementBindingMixin[_T]]