reflex 0.5.4a2__py3-none-any.whl → 0.5.5__py3-none-any.whl

reflex/compiler/utils.py

@@ -3,9 +3,12 @@
 from __future__ import annotations
 
 import os
+from pathlib import Path
 from typing import Any, Callable, Dict, Optional, Type, Union
 from urllib.parse import urlparse
 
+from reflex.utils.prerequisites import get_web_dir
+
 try:
     from pydantic.v1.fields import ModelField
 except ModuleNotFoundError:
@@ -25,16 +28,17 @@ from reflex.components.base import (
     Title,
 )
 from reflex.components.component import Component, ComponentStyle, CustomComponent
-from reflex.state import BaseState, Cookie, LocalStorage
+from reflex.state import BaseState, Cookie, LocalStorage, SessionStorage
 from reflex.style import Style
 from reflex.utils import console, format, imports, path_ops
+from reflex.utils.imports import ImportVar, ParsedImportDict
 from reflex.vars import Var
 
 # To re-export this function.
 merge_imports = imports.merge_imports
 
 
-def compile_import_statement(fields: list[imports.ImportVar]) -> tuple[str, list[str]]:
+def compile_import_statement(fields: list[ImportVar]) -> tuple[str, list[str]]:
     """Compile an import statement.
 
     Args:
@@ -59,7 +63,7 @@ def compile_import_statement(fields: list[imports.ImportVar]) -> tuple[str, list
     return default, list(rest)
 
 
-def validate_imports(import_dict: imports.ImportDict):
+def validate_imports(import_dict: ParsedImportDict):
     """Verify that the same Tag is not used in multiple import.
 
     Args:
@@ -82,7 +86,7 @@ def validate_imports(import_dict: imports.ImportDict):
                 used_tags[import_name] = lib
 
 
-def compile_imports(import_dict: imports.ImportDict) -> list[dict]:
+def compile_imports(import_dict: ParsedImportDict) -> list[dict]:
     """Compile an import dict.
 
     Args:
@@ -91,7 +95,7 @@ def compile_imports(import_dict: imports.ImportDict) -> list[dict]:
     Returns:
         The list of import dict.
     """
-    collapsed_import_dict = imports.collapse_imports(import_dict)
+    collapsed_import_dict: ParsedImportDict = imports.collapse_imports(import_dict)
     validate_imports(collapsed_import_dict)
     import_dicts = []
     for lib, fields in collapsed_import_dict.items():
@@ -154,8 +158,11 @@ def compile_state(state: Type[BaseState]) -> dict:
 
 def _compile_client_storage_field(
     field: ModelField,
-) -> tuple[Type[Cookie] | Type[LocalStorage] | None, dict[str, Any] | None]:
-    """Compile the given cookie or local_storage field.
+) -> tuple[
+    Type[Cookie] | Type[LocalStorage] | Type[SessionStorage] | None,
+    dict[str, Any] | None,
+]:
+    """Compile the given cookie, local_storage or session_storage field.
 
     Args:
         field: The possible cookie field to compile.
@@ -163,7 +170,7 @@ def _compile_client_storage_field(
     Returns:
         A dictionary of the compiled cookie or None if the field is not cookie-like.
     """
-    for field_type in (Cookie, LocalStorage):
+    for field_type in (Cookie, LocalStorage, SessionStorage):
         if isinstance(field.default, field_type):
             cs_obj = field.default
         elif isinstance(field.type_, type) and issubclass(field.type_, field_type):
@@ -176,7 +183,7 @@ def _compile_client_storage_field(
 
 def _compile_client_storage_recursive(
     state: Type[BaseState],
-) -> tuple[dict[str, dict], dict[str, dict[str, str]]]:
+) -> tuple[dict[str, dict], dict[str, dict], dict[str, dict]]:
     """Compile the client-side storage for the given state recursively.
 
     Args:
@@ -187,10 +194,12 @@ def _compile_client_storage_recursive(
             (
                 cookies: dict[str, dict],
                 local_storage: dict[str, dict[str, str]]
-            )
+                session_storage: dict[str, dict[str, str]]
+            ).
     """
     cookies = {}
     local_storage = {}
+    session_storage = {}
     state_name = state.get_full_name()
     for name, field in state.__fields__.items():
         if name in state.inherited_vars:
@@ -202,15 +211,20 @@ def _compile_client_storage_recursive(
             cookies[state_key] = options
         elif field_type is LocalStorage:
             local_storage[state_key] = options
+        elif field_type is SessionStorage:
+            session_storage[state_key] = options
         else:
             continue
     for substate in state.get_substates():
-        substate_cookies, substate_local_storage = _compile_client_storage_recursive(
-            substate
-        )
+        (
+            substate_cookies,
+            substate_local_storage,
+            substate_session_storage,
+        ) = _compile_client_storage_recursive(substate)
         cookies.update(substate_cookies)
         local_storage.update(substate_local_storage)
-    return cookies, local_storage
+        session_storage.update(substate_session_storage)
+    return cookies, local_storage, session_storage
 
 
 def compile_client_storage(state: Type[BaseState]) -> dict[str, dict]:
@@ -222,16 +236,17 @@ def compile_client_storage(state: Type[BaseState]) -> dict[str, dict]:
     Returns:
         A dictionary of the compiled client-side storage info.
     """
-    cookies, local_storage = _compile_client_storage_recursive(state)
+    cookies, local_storage, session_storage = _compile_client_storage_recursive(state)
     return {
         constants.COOKIES: cookies,
         constants.LOCAL_STORAGE: local_storage,
+        constants.SESSION_STORAGE: session_storage,
     }
 
 
 def compile_custom_component(
     component: CustomComponent,
-) -> tuple[dict, imports.ImportDict]:
+) -> tuple[dict, ParsedImportDict]:
     """Compile a custom component.
 
     Args:
@@ -244,7 +259,7 @@ def compile_custom_component(
     render = component.get_component(component)
 
     # Get the imports.
-    imports = {
+    imports: ParsedImportDict = {
         lib: fields
         for lib, fields in render._get_all_imports().items()
         if lib != component.library
@@ -329,7 +344,7 @@ def get_page_path(path: str) -> str:
     Returns:
         The path of the compiled JS file.
     """
-    return os.path.join(constants.Dirs.WEB_PAGES, path + constants.Ext.JS)
+    return str(get_web_dir() / constants.Dirs.PAGES / (path + constants.Ext.JS))
 
 
 def get_theme_path() -> str:
@@ -338,8 +353,10 @@ def get_theme_path() -> str:
     Returns:
         The path of the theme style.
     """
-    return os.path.join(
-        constants.Dirs.WEB_UTILS, constants.PageNames.THEME + constants.Ext.JS
+    return str(
+        get_web_dir()
+        / constants.Dirs.UTILS
+        / (constants.PageNames.THEME + constants.Ext.JS)
     )
 
 
@@ -349,8 +366,10 @@ def get_root_stylesheet_path() -> str:
     Returns:
         The path of the app root file.
     """
-    return os.path.join(
-        constants.STYLES_DIR, constants.PageNames.STYLESHEET_ROOT + constants.Ext.CSS
+    return str(
+        get_web_dir()
+        / constants.Dirs.STYLES
+        / (constants.PageNames.STYLESHEET_ROOT + constants.Ext.CSS)
     )
 
 
@@ -360,9 +379,7 @@ def get_context_path() -> str:
     Returns:
         The path of the context module.
     """
-    return os.path.join(
-        constants.Dirs.WEB, constants.Dirs.CONTEXTS_PATH + constants.Ext.JS
-    )
+    return str(get_web_dir() / (constants.Dirs.CONTEXTS_PATH + constants.Ext.JS))
 
 
 def get_components_path() -> str:
@@ -371,7 +388,11 @@ def get_components_path() -> str:
     Returns:
         The path of the compiled components.
     """
-    return os.path.join(constants.Dirs.WEB_UTILS, "components" + constants.Ext.JS)
+    return str(
+        get_web_dir()
+        / constants.Dirs.UTILS
+        / (constants.PageNames.COMPONENTS + constants.Ext.JS),
+    )
 
 
 def get_stateful_components_path() -> str:
@@ -380,9 +401,10 @@ def get_stateful_components_path() -> str:
     Returns:
         The path of the compiled stateful components.
     """
-    return os.path.join(
-        constants.Dirs.WEB_UTILS,
-        constants.PageNames.STATEFUL_COMPONENTS + constants.Ext.JS,
+    return str(
+        get_web_dir()
+        / constants.Dirs.UTILS
+        / (constants.PageNames.STATEFUL_COMPONENTS + constants.Ext.JS)
     )
 
 
@@ -436,23 +458,24 @@ def write_page(path: str, code: str):
         f.write(code)
 
 
-def empty_dir(path: str, keep_files: list[str] | None = None):
+def empty_dir(path: str | Path, keep_files: list[str] | None = None):
     """Remove all files and folders in a directory except for the keep_files.
 
     Args:
         path: The path to the directory that will be emptied
         keep_files: List of filenames or foldernames that will not be deleted.
     """
+    path = Path(path)
+
     # If the directory does not exist, return.
-    if not os.path.exists(path):
+    if not path.exists():
         return
 
     # Remove all files and folders in the directory.
     keep_files = keep_files or []
-    directory_contents = os.listdir(path)
-    for element in directory_contents:
-        if element not in keep_files:
-            path_ops.rm(os.path.join(path, element))
+    for element in path.iterdir():
+        if element.name not in keep_files:
+            path_ops.rm(element)
 
 
 def is_valid_url(url) -> bool:

reflex/components/__init__.py

@@ -1,4 +1,5 @@
 """Import all the components."""
+
 from __future__ import annotations
 
 from reflex.utils import lazy_loader

reflex/components/base/__init__.py

@@ -1,4 +1,5 @@
 """Base components."""
+
 from __future__ import annotations
 
 from reflex.utils import lazy_loader

reflex/components/base/app_wrap.py

@@ -1,4 +1,5 @@
 """Top-level component that wraps the entire app."""
+
 from reflex.components.base.fragment import Fragment
 from reflex.components.component import Component
 from reflex.vars import Var

reflex/components/base/fragment.py

@@ -1,4 +1,5 @@
 """React fragments to enable bare returns of component trees from functions."""
+
 from reflex.components.component import Component
 
 

reflex/components/base/link.py

@@ -1,6 +1,5 @@
 """Display the title of the current page."""
 
-
 from reflex.components.component import Component
 from reflex.vars import Var
 

reflex/components/base/script.py

@@ -2,11 +2,11 @@
 
 https://nextjs.org/docs/app/api-reference/components/script
 """
-from __future__ import annotations
 
-from typing import Any, Union
+from __future__ import annotations
 
 from reflex.components.component import Component
+from reflex.event import EventHandler
 from reflex.vars import Var
 
 
@@ -30,6 +30,15 @@ class Script(Component):
     # When the script will execute: afterInteractive | beforeInteractive | lazyOnload
     strategy: Var[str] = "afterInteractive"  # type: ignore
 
+    # Triggered when the script is loading
+    on_load: EventHandler[lambda: []]
+
+    # Triggered when the script has loaded
+    on_ready: EventHandler[lambda: []]
+
+    # Triggered when the script has errored
+    on_error: EventHandler[lambda: []]
+
     @classmethod
     def create(cls, *children, **props) -> Component:
         """Create an inline or user-defined script.
@@ -58,18 +67,5 @@ class Script(Component):
             raise ValueError("Must provide inline script or `src` prop.")
         return super().create(*children, **props)
 
-    def get_event_triggers(self) -> dict[str, Union[Var, Any]]:
-        """Get the event triggers for the component.
-
-        Returns:
-            The event triggers.
-        """
-        return {
-            **super().get_event_triggers(),
-            "on_load": lambda: [],
-            "on_ready": lambda: [],
-            "on_error": lambda: [],
-        }
-
 
 script = Script.create

reflex/components/base/script.pyi

@@ -7,8 +7,8 @@ from typing import Any, Dict, Literal, Optional, Union, overload
 from reflex.vars import Var, BaseVar, ComputedVar
 from reflex.event import EventChain, EventHandler, EventSpec
 from reflex.style import Style
-from typing import Any, Union
 from reflex.components.component import Component
+from reflex.event import EventHandler
 from reflex.vars import Var
 
 class Script(Component):
@@ -112,6 +112,5 @@ class Script(Component):
             ValueError: when neither children nor `src` are specified.
         """
         ...
-    def get_event_triggers(self) -> dict[str, Union[Var, Any]]: ...
 
 script = Script.create

reflex/components/chakra/base.py

@@ -1,18 +1,19 @@
 """Components that are based on Chakra-UI."""
+
 from __future__ import annotations
 
 from functools import lru_cache
 from typing import List, Literal
 
 from reflex.components.component import Component
-from reflex.utils import imports
+from reflex.utils.imports import ImportDict, ImportVar
 from reflex.vars import Var
 
 
 class ChakraComponent(Component):
     """A component that wraps a Chakra component."""
 
-    library = "@chakra-ui/react@2.6.1"
+    library: str = "@chakra-ui/react@2.6.1"  # type: ignore
     lib_dependencies: List[str] = [
         "@chakra-ui/system@2.5.7",
         "framer-motion@10.16.4",
@@ -35,14 +36,14 @@ class ChakraComponent(Component):
 
     @classmethod
     @lru_cache(maxsize=None)
-    def _get_dependencies_imports(cls) -> imports.ImportDict:
+    def _get_dependencies_imports(cls) -> ImportDict:
         """Get the imports from lib_dependencies for installing.
 
         Returns:
             The dependencies imports of the component.
         """
         return {
-            dep: [imports.ImportVar(tag=None, render=False)]
+            dep: [ImportVar(tag=None, render=False)]
             for dep in [
                 "@chakra-ui/system@2.5.7",
                 "framer-motion@10.16.4",
@@ -70,15 +71,16 @@ class ChakraProvider(ChakraComponent):
             ),
         )
 
-    def _get_imports(self) -> imports.ImportDict:
-        _imports = super()._get_imports()
-        _imports.setdefault(self.__fields__["library"].default, []).append(
-            imports.ImportVar(tag="extendTheme", is_default=False),
-        )
-        _imports.setdefault("/utils/theme.js", []).append(
-            imports.ImportVar(tag="theme", is_default=True),
-        )
-        return _imports
+    def add_imports(self) -> ImportDict:
+        """Add imports for the ChakraProvider component.
+
+        Returns:
+            The import dict for the component.
+        """
+        return {
+            self.library: ImportVar(tag="extendTheme", is_default=False),
+            "/utils/theme.js": ImportVar(tag="theme", is_default=True),
+        }
 
     @staticmethod
     @lru_cache(maxsize=None)

reflex/components/chakra/base.pyi

@@ -10,7 +10,7 @@ from reflex.style import Style
 from functools import lru_cache
 from typing import List, Literal
 from reflex.components.component import Component
-from reflex.utils import imports
+from reflex.utils.imports import ImportDict, ImportVar
 from reflex.vars import Var
 
 class ChakraComponent(Component):
@@ -156,6 +156,8 @@ class ChakraProvider(ChakraComponent):
         """
         ...
 
+    def add_imports(self) -> ImportDict: ...
+
 chakra_provider = ChakraProvider.create()
 
 class ChakraColorModeProvider(Component):

reflex/components/chakra/datadisplay/code.py

@@ -1,4 +1,5 @@
 """A code component."""
+
 from reflex.components.chakra import (
     ChakraComponent,
 )

reflex/components/chakra/datadisplay/divider.py

@@ -1,4 +1,5 @@
 """A line to divide parts of the layout."""
+
 from typing import Literal
 
 from reflex.components.chakra import ChakraComponent, LiteralDividerVariant

reflex/components/chakra/datadisplay/table.py

@@ -1,4 +1,5 @@
 """Table components."""
+
 from typing import List, Tuple
 
 from reflex.components.chakra import ChakraComponent

reflex/components/chakra/datadisplay/table.pyi

@@ -184,6 +184,7 @@ class Thead(ChakraComponent):
 
         """
         ...
+
     @staticmethod
     def validate_headers(headers): ...
 
@@ -264,6 +265,7 @@ class Tbody(ChakraComponent):
             Component: The table body component
         """
         ...
+
     @staticmethod
     def validate_rows(rows): ...
 
@@ -344,6 +346,7 @@ class Tfoot(ChakraComponent):
             The table footer component.
         """
         ...
+
     @staticmethod
     def validate_footers(footers): ...
 

reflex/components/chakra/datadisplay/tag.py

@@ -1,4 +1,5 @@
 """Chakra Tag Component."""
+
 from typing import Optional
 
 from reflex.components.chakra import (

reflex/components/chakra/disclosure/transition.py

@@ -1,4 +1,5 @@
 """A transition Component."""
+
 from typing import Union
 
 from reflex.components.chakra import ChakraComponent

reflex/components/chakra/feedback/circularprogress.py

@@ -1,4 +1,5 @@
 """Container to stack elements with spacing."""
+
 from typing import Union
 
 from reflex.components.chakra import ChakraComponent

reflex/components/chakra/forms/button.py

@@ -1,4 +1,5 @@
 """A button component."""
+
 from typing import List
 
 from reflex.components.chakra import (

reflex/components/chakra/forms/checkbox.py

@@ -1,14 +1,13 @@
 """A checkbox component."""
-from __future__ import annotations
 
-from typing import Any, Union
+from __future__ import annotations
 
 from reflex.components.chakra import (
     ChakraComponent,
     LiteralColorScheme,
     LiteralTagSize,
 )
-from reflex.constants import EventTriggers
+from reflex.event import EventHandler
 from reflex.vars import Var
 
 
@@ -56,16 +55,8 @@ class Checkbox(ChakraComponent):
     # The spacing between the checkbox and its label text (0.5rem)
     spacing: Var[str]
 
-    def get_event_triggers(self) -> dict[str, Union[Var, Any]]:
-        """Get the event triggers that pass the component's value to the handler.
-
-        Returns:
-            A dict mapping the event trigger to the var that is passed to the handler.
-        """
-        return {
-            **super().get_event_triggers(),
-            EventTriggers.ON_CHANGE: lambda e0: [e0.target.checked],
-        }
+    # Fired when the checkbox is checked or unchecked
+    on_change: EventHandler[lambda e0: [e0.target.checked]]
 
 
 class CheckboxGroup(ChakraComponent):

reflex/components/chakra/forms/checkbox.pyi

@@ -7,13 +7,11 @@ from typing import Any, Dict, Literal, Optional, Union, overload
 from reflex.vars import Var, BaseVar, ComputedVar
 from reflex.event import EventChain, EventHandler, EventSpec
 from reflex.style import Style
-from typing import Any, Union
 from reflex.components.chakra import ChakraComponent, LiteralColorScheme, LiteralTagSize
-from reflex.constants import EventTriggers
+from reflex.event import EventHandler
 from reflex.vars import Var
 
 class Checkbox(ChakraComponent):
-    def get_event_triggers(self) -> dict[str, Union[Var, Any]]: ...
     @overload
     @classmethod
     def create(  # type: ignore

reflex/components/chakra/forms/colormodeswitch.py

@@ -14,6 +14,7 @@ rx.text(
 )
 ```
 """
+
 from __future__ import annotations
 
 from reflex.components.chakra import ChakraComponent

reflex/components/chakra/forms/editable.py

@@ -1,10 +1,9 @@
 """An editable component."""
-from __future__ import annotations
 
-from typing import Any, Union
+from __future__ import annotations
 
 from reflex.components.chakra import ChakraComponent
-from reflex.constants import EventTriggers
+from reflex.event import EventHandler
 from reflex.vars import Var
 
 
@@ -37,19 +36,17 @@ class Editable(ChakraComponent):
     # The initial value of the Editable in both edit and preview mode.
     default_value: Var[str]
 
-    def get_event_triggers(self) -> dict[str, Union[Var, Any]]:
-        """Get the event triggers that pass the component's value to the handler.
-
-        Returns:
-            A dict mapping the event trigger to the var that is passed to the handler.
-        """
-        return {
-            **super().get_event_triggers(),
-            EventTriggers.ON_CHANGE: lambda e0: [e0],
-            EventTriggers.ON_EDIT: lambda e0: [e0],
-            EventTriggers.ON_SUBMIT: lambda e0: [e0],
-            EventTriggers.ON_CANCEL: lambda e0: [e0],
-        }
+    # Fired when the Editable is changed.
+    on_change: EventHandler[lambda e0: [e0]]
+
+    # Fired when the Editable is in edit mode.
+    on_edit: EventHandler[lambda e0: [e0]]
+
+    # Fired when the Editable is submitted.
+    on_submit: EventHandler[lambda e0: [e0]]
+
+    # Fired when the Editable is canceled.
+    on_cancel: EventHandler[lambda e0: [e0]]
 
 
 class EditableInput(ChakraComponent):

reflex/components/chakra/forms/editable.pyi

@@ -7,13 +7,11 @@ from typing import Any, Dict, Literal, Optional, Union, overload
 from reflex.vars import Var, BaseVar, ComputedVar
 from reflex.event import EventChain, EventHandler, EventSpec
 from reflex.style import Style
-from typing import Any, Union
 from reflex.components.chakra import ChakraComponent
-from reflex.constants import EventTriggers
+from reflex.event import EventHandler
 from reflex.vars import Var
 
 class Editable(ChakraComponent):
-    def get_event_triggers(self) -> dict[str, Union[Var, Any]]: ...
     @overload
     @classmethod
     def create(  # type: ignore

reflex/components/chakra/forms/form.py

@@ -1,4 +1,5 @@
 """Form components."""
+
 from __future__ import annotations
 
 from reflex.components.chakra import ChakraComponent