chainlit 2.0.0__py3-none-any.whl → 2.0.dev0__py3-none-any.whl

chainlit/config.py

@@ -17,30 +17,22 @@ from typing import (
 )
 
 import tomli
-from dataclasses_json import DataClassJsonMixin
-from pydantic import Field
-from pydantic.dataclasses import dataclass
-from starlette.datastructures import Headers
-
-from chainlit.data.base import BaseDataLayer
 from chainlit.logger import logger
 from chainlit.translations import lint_translation_json
 from chainlit.version import __version__
+from dataclasses_json import DataClassJsonMixin
+from pydantic.dataclasses import Field, dataclass
+from starlette.datastructures import Headers
 
 from ._utils import is_path_inside
 
 if TYPE_CHECKING:
-    from fastapi import Request, Response
-
     from chainlit.action import Action
     from chainlit.message import Message
-    from chainlit.types import ChatProfile, InputAudioChunk, Starter, ThreadDict
+    from chainlit.types import InputAudioChunk, ChatProfile, Starter, ThreadDict
     from chainlit.user import User
-else:
-    # Pydantic needs to resolve forward annotations. Because all of these are used
-    # within `typing.Callable`, alias to `Any` as Pydantic does not perform validation
-    # of callable argument/return types anyway.
-    Request = Response = Action = Message = ChatProfile = InputAudioChunk = Starter = ThreadDict = User = Any  # fmt: off
+    from fastapi import Request, Response
+
 
 BACKEND_ROOT = os.path.dirname(__file__)
 PACKAGE_ROOT = os.path.dirname(os.path.dirname(BACKEND_ROOT))
@@ -55,7 +47,6 @@ FILES_DIRECTORY = Path(APP_ROOT) / ".files"
 FILES_DIRECTORY.mkdir(exist_ok=True)
 
 config_dir = os.path.join(APP_ROOT, ".chainlit")
-public_dir = os.path.join(APP_ROOT, "public")
 config_file = os.path.join(config_dir, "config.toml")
 config_translation_dir = os.path.join(config_dir, "translations")
 
@@ -71,15 +62,15 @@ user_env = []
 # Duration (in seconds) during which the session is saved when the connection is lost
 session_timeout = 3600
 
-# Duration (in seconds) of the user session expiry
-user_session_timeout = 1296000  # 15 days
-
 # Enable third parties caching (e.g LangChain cache)
 cache = false
 
 # Authorized origins
 allow_origins = ["*"]
 
+# Follow symlink for asset mount (see https://github.com/Chainlit/chainlit/issues/317)
+# follow_symlink = false
+
 [features]
 # Process and display HTML in messages. This can be a security risk (see https://stackoverflow.com/questions/19603097/why-is-it-dangerous-to-render-user-generated-html-or-javascript)
 unsafe_allow_html = false
@@ -108,13 +99,12 @@ edit_message = true
 # Name of the assistant.
 name = "Assistant"
 
-# default_theme = "dark"
-
-# layout = "wide"
-
 # Description of the assistant. This is used for HTML tags.
 # description = ""
 
+# Large size content are by default collapsed for a cleaner ui
+default_collapse_content = true
+
 # Chain of Thought (CoT) display mode. Can be "hidden", "tool_call" or "full".
 cot = "full"
 
@@ -129,6 +119,9 @@ cot = "full"
 # The Javascript file can be served from the public directory.
 # custom_js = "/public/test.js"
 
+# Specify a custom font url.
+# custom_font = "https://fonts.googleapis.com/css2?family=Inter:wght@400;500;700&display=swap"
+
 # Specify a custom meta image url.
 # custom_meta_image_url = "https://chainlit-cloud.s3.eu-west-3.amazonaws.com/logo/chainlit_banner.png"
 
@@ -137,6 +130,36 @@ cot = "full"
 # Be careful: If this is a relative path, it should not start with a slash.
 # custom_build = "./public/build"
 
+[UI.theme]
+    default = "dark"
+    #layout = "wide"
+    #font_family = "Inter, sans-serif"
+# Override default MUI light theme. (Check theme.ts)
+[UI.theme.light]
+    #background = "#FAFAFA"
+    #paper = "#FFFFFF"
+
+    [UI.theme.light.primary]
+        #main = "#F80061"
+        #dark = "#980039"
+        #light = "#FFE7EB"
+    [UI.theme.light.text]
+        #primary = "#212121"
+        #secondary = "#616161"
+
+# Override default MUI dark theme. (Check theme.ts)
+[UI.theme.dark]
+    #background = "#FAFAFA"
+    #paper = "#FFFFFF"
+
+    [UI.theme.dark.primary]
+        #main = "#F80061"
+        #dark = "#980039"
+        #light = "#FFE7EB"
+    [UI.theme.dark.text]
+        #primary = "#EEEEEE"
+        #secondary = "#BDBDBD"
+
 [meta]
 generated_by = "{__version__}"
 """
@@ -184,6 +207,15 @@ class Palette(DataClassJsonMixin):
     text: Optional[TextOptions] = None
 
 
+@dataclass()
+class Theme(DataClassJsonMixin):
+    font_family: Optional[str] = None
+    default: Optional[Literal["light", "dark"]] = "dark"
+    layout: Optional[Literal["default", "wide"]] = "default"
+    light: Optional[Palette] = None
+    dark: Optional[Palette] = None
+
+
 @dataclass
 class SpontaneousFileUploadFeature(DataClassJsonMixin):
     enabled: Optional[bool] = None
@@ -213,13 +245,14 @@ class UISettings(DataClassJsonMixin):
     name: str
     description: str = ""
     cot: Literal["hidden", "tool_call", "full"] = "full"
-    font_family: Optional[str] = None
-    default_theme: Optional[Literal["light", "dark"]] = "dark"
-    layout: Optional[Literal["default", "wide"]] = "default"
+    # Large size content are by default collapsed for a cleaner ui
+    default_collapse_content: bool = True
     github: Optional[str] = None
+    theme: Optional[Theme] = None
     # Optional custom CSS file that allows you to customize the UI
     custom_css: Optional[str] = None
     custom_js: Optional[str] = None
+    custom_font: Optional[str] = None
     # Optional custom meta tag for image preview
     custom_meta_image_url: Optional[str] = None
     # Optional custom build directory for the frontend
@@ -236,9 +269,9 @@ class CodeSettings:
     password_auth_callback: Optional[
         Callable[[str, str], Awaitable[Optional["User"]]]
     ] = None
-    header_auth_callback: Optional[Callable[[Headers], Awaitable[Optional["User"]]]] = (
-        None
-    )
+    header_auth_callback: Optional[
+        Callable[[Headers], Awaitable[Optional["User"]]]
+    ] = None
     oauth_callback: Optional[
         Callable[[str, str, Dict[str, str], "User"], Awaitable[Optional["User"]]]
     ] = None
@@ -248,7 +281,6 @@ class CodeSettings:
     on_chat_end: Optional[Callable[[], Any]] = None
     on_chat_resume: Optional[Callable[["ThreadDict"], Any]] = None
     on_message: Optional[Callable[["Message"], Any]] = None
-    on_window_message: Optional[Callable[[str], Any]] = None
     on_audio_start: Optional[Callable[[], Any]] = None
     on_audio_chunk: Optional[Callable[["InputAudioChunk"], Any]] = None
     on_audio_end: Optional[Callable[[], Any]] = None
@@ -258,17 +290,14 @@ class CodeSettings:
     set_chat_profiles: Optional[
         Callable[[Optional["User"]], Awaitable[List["ChatProfile"]]]
     ] = None
-    set_starters: Optional[Callable[[Optional["User"]], Awaitable[List["Starter"]]]] = (
-        None
-    )
-    data_layer: Optional[Callable[[], BaseDataLayer]] = None
+    set_starters: Optional[
+        Callable[[Optional["User"]], Awaitable[List["Starter"]]]
+    ] = None
 
 
 @dataclass()
 class ProjectSettings(DataClassJsonMixin):
     allow_origins: List[str] = Field(default_factory=lambda: ["*"])
-    # Socket.io client transports option
-    transports: Optional[List[str]] = None
     enable_telemetry: bool = True
     # List of environment variables to be provided by each user to use the app. If empty, no environment variables will be asked to the user.
     user_env: Optional[List[str]] = None
@@ -277,10 +306,10 @@ class ProjectSettings(DataClassJsonMixin):
     # Path to the local chat db
     # Duration (in seconds) during which the session is saved when the connection is lost
     session_timeout: int = 3600
-    # Duration (in seconds) of the user session expiry
-    user_session_timeout: int = 1296000  # 15 days
     # Enable third parties caching (e.g LangChain cache)
     cache: bool = False
+    # Follow symlink for asset mount (see https://github.com/Chainlit/chainlit/issues/317)
+    follow_symlink: bool = False
 
 
 @dataclass()
@@ -361,7 +390,7 @@ def init_config(log=False):
             dst = os.path.join(config_translation_dir, file)
             if not os.path.exists(dst):
                 src = os.path.join(TRANSLATIONS_DIR, file)
-                with open(src, encoding="utf-8") as f:
+                with open(src, "r", encoding="utf-8") as f:
                     translation = json.load(f)
                     with open(dst, "w", encoding="utf-8") as f:
                         json.dump(translation, f, indent=4)
@@ -418,7 +447,7 @@ def load_settings():
 
         if not meta or meta.get("generated_by") <= "0.3.0":
             raise ValueError(
-                f"Your config file '{config_file}' is outdated. Please delete it and restart the app to regenerate it."
+                "Your config file is outdated. Please delete it and restart the app to regenerate it."
             )
 
         lc_cache_path = os.path.join(config_dir, ".langchain.db")
@@ -476,7 +505,7 @@ def load_config():
 def lint_translations():
     # Load the ground truth (en-US.json file from chainlit source code)
     src = os.path.join(TRANSLATIONS_DIR, "en-US.json")
-    with open(src, encoding="utf-8") as f:
+    with open(src, "r", encoding="utf-8") as f:
         truth = json.load(f)
 
         # Find the local app translations
@@ -484,7 +513,7 @@ def lint_translations():
             if file.endswith(".json"):
                 # Load the translation file
                 to_lint = os.path.join(config_translation_dir, file)
-                with open(to_lint, encoding="utf-8") as f:
+                with open(to_lint, "r", encoding="utf-8") as f:
                     translation = json.load(f)
 
                     # Lint the translation file

chainlit/context.py

@@ -3,9 +3,8 @@ import uuid
 from contextvars import ContextVar
 from typing import TYPE_CHECKING, Dict, List, Optional, Union
 
-from lazify import LazyProxy
-
 from chainlit.session import ClientType, HTTPSession, WebsocketSession
+from lazify import LazyProxy
 
 if TYPE_CHECKING:
     from chainlit.emitter import BaseChainlitEmitter
@@ -24,17 +23,18 @@ class ChainlitContext:
     loop: asyncio.AbstractEventLoop
     emitter: "BaseChainlitEmitter"
     session: Union["HTTPSession", "WebsocketSession"]
+    active_steps: List["Step"]
 
     @property
     def current_step(self):
-        if previous_steps := local_steps.get():
-            return previous_steps[-1]
+        if self.active_steps:
+            return self.active_steps[-1]
 
     @property
     def current_run(self):
-        if previous_steps := local_steps.get():
+        if self.active_steps:
             return next(
-                (step for step in previous_steps if step.name in CL_RUN_NAMES), None
+                (step for step in self.active_steps if step.name in CL_RUN_NAMES), None
             )
 
     def __init__(
@@ -46,6 +46,7 @@ class ChainlitContext:
 
         self.loop = asyncio.get_running_loop()
         self.session = session
+        self.active_steps = []
 
         if emitter:
             self.emitter = emitter
@@ -104,8 +105,8 @@ def init_http_context(
 def get_context() -> ChainlitContext:
     try:
         return context_var.get()
-    except LookupError as e:
-        raise ChainlitContextException from e
+    except LookupError:
+        raise ChainlitContextException()
 
 
 context: ChainlitContext = LazyProxy(get_context, enable_cache=False)