Merge pull request #330 from emilhe/streaming

Streaming

.eslintignore

@@ -1,2 +1,2 @@
 *.css
-registerServiceWorker.js
+registerServiceWorker.js

.github/workflows/python-test.yml

@@ -53,4 +53,4 @@ jobs:
       if: ${{ always() }}
 
     - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v1
+      uses: codecov/codecov-action@v1

.gitignore

@@ -14,7 +14,6 @@ dist/
 downloads/
 eggs/
 .eggs/
-lib/
 lib64/
 parts/
 sdist/
@@ -134,4 +133,12 @@ dash_extensions/*
 inst/*
 **/file_system_backend/*
 man/*
-R/*
+R/*
+
+.idea/*
+pc_ex1/*
+page_components/*
+NAMESPACE
+DESCRIPTION
+jsconfig.json
+tmp**.py

.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+# default_language_version:
+#   python: python3.9
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.4.5
+    hooks:
+      - id: ruff
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.3.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      # - id: check-yaml
+      - id: check-toml
+      - id: check-added-large-files
+      - id: check-merge-conflict
+        additional_dependencies: ["flake8-docstrings", "darglint"]

.vscode/settings.json

@@ -7,4 +7,4 @@
     ],
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true
-}
+}

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.0.16] - 05-28-24
+
+### Added
+
+- Add new `SSE` component, which can receive (and buffer) server sent events such the output from an LLM.
+- Add new `LoadingTransform`, which makes it easy to re-use a single (full screen) loading component across the app.
+- Add new `BaseModelTransform`, which automates serialization/deserialization of Pydantic `BaseModel` objects.
+
 ## [1.0.15] - 05-04-24
 
 ### Added
@@ -160,7 +168,7 @@ All notable changes to this project will be documented in this file.
 
 ### Changed
 
-- Reimplementation of the `BeforeAfter` component by @AnnMarieW adding new features and improved mobile compatibility. NB: This is a **breaking** change, please consult the docs for an example using the new syntax 
+- Reimplementation of the `BeforeAfter` component by @AnnMarieW adding new features and improved mobile compatibility. NB: This is a **breaking** change, please consult the docs for an example using the new syntax
 - Improved support for the new `callback(background=True, ...)` syntax adding support for the `set_progress` keyword
 - Added syntax sugar for Celery task registration for use with the `CeleryManager` object
 - Added explicit raise of `NotImplementedError` for the (deprecated) `long_callback` syntax
@@ -194,7 +202,7 @@ All notable changes to this project will be documented in this file.
 
 ### Changed
 
-- Added info on pypi (has been missing after poetry migration) 
+- Added info on pypi (has been missing after poetry migration)
 - Added `CycleBreakerInput` component, which is to be used instead of the `break_cycle` keyword in 0.1.1
 - Fixed introduced bug when mixing imports from `dash` and `dash_extensions.enrich`
 
@@ -368,7 +376,7 @@ All notable changes to this project will be documented in this file.
 
 ### Change
 
-- Bugfixes in `MultiplexerTransform`, both of dcc.Loading and of proxies firing unintentionally on load. 
+- Bugfixes in `MultiplexerTransform`, both of dcc.Loading and of proxies firing unintentionally on load.
 - Reintroduced the `TriggerTransform` based on community feedback.
 - Security fixes of underlying npm packages.
 
@@ -383,7 +391,7 @@ All notable changes to this project will be documented in this file.
 
 - Updated `Burger` component; added new properties, added new example, slight changes to interface.
 - Updated `multipage_app.py` example; removed dependency on burger menu, removed burger helper function in `multipage.py`.
-- Added a `hijack` function to the `DashProxy` object. It can be used to inject app state into other app objects, typically used in frameworks such as dataiku 9.0 where the `Dash` object is constructed outside of the user code context. 
+- Added a `hijack` function to the `DashProxy` object. It can be used to inject app state into other app objects, typically used in frameworks such as dataiku 9.0 where the `Dash` object is constructed outside of the user code context.
 
 ### Remove
 
@@ -492,7 +500,7 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 
-- A new `enrich` module has been added. It exposes the functionality of previous callback blueprints (and more!) through a drop in replacement of (enriched) Dash components. 
+- A new `enrich` module has been added. It exposes the functionality of previous callback blueprints (and more!) through a drop in replacement of (enriched) Dash components.
 - Added folder of example code.
 
 ### Changed

CONTRIBUTING.md

@@ -1,4 +1,3 @@
 # CONTRIBUTING
 
 This project was generated by the [dash-component-boilerplate](https://github.com/plotly/dash-component-boilerplate) it contains the minimal set of code required to create your own custom Dash component.
-

TODO.md

@@ -1,2 +1,2 @@
 * Go through component doc strings
-* Add docs for dynamic components
+* Add docs for dynamic components

_validate_init.py

@@ -2,12 +2,12 @@
 DO NOT MODIFY
 This file is used to validate your publish settings.
 """
+
 from __future__ import print_function
 
+import importlib
 import os
 import sys
-import importlib
-
 
 components_package = "dash_extensions"
 
@@ -45,14 +45,16 @@ def check_manifest(filename):
 
 def check_file(dist, filename):
     if not check_dist(dist, filename):
-        print(missing_dist_msg.format(filename, components_package, "_js_dist"), file=sys.stderr)
+        print(
+            missing_dist_msg.format(filename, components_package, "_js_dist"),
+            file=sys.stderr,
+        )
     if not check_manifest(filename):
         print(missing_manifest_msg.format(filename), file=sys.stderr)
 
 
 for cur, _, files in os.walk(components_package):
     for f in files:
-
         if f.endswith("js"):
             # noinspection PyProtectedMember
             check_file(components_lib._js_dist, f)

codecov.yml

@@ -1,2 +1,2 @@
 ignore:
-  - "dash_extensions/snippets.py"
+  - "dash_extensions/snippets.py"

dash_extensions/__init__.py

@@ -1,13 +1,13 @@
 from __future__ import print_function as _
 
+import json
 import os as _os
 import sys as _sys
-import json
 
 import dash as _dash
 
 # noinspection PyUnresolvedReferences
-from ._imports_ import *
+from ._imports_ import *  # noqa: F401, F403
 from ._imports_ import __all__
 
 if not hasattr(_dash, "__plotly_dash") and not hasattr(_dash, "development"):

dash_extensions/_imports_.py

@@ -8,6 +8,7 @@
 from .Lottie import Lottie
 from .Mermaid import Mermaid
 from .Purify import Purify
+from .SSE import SSE
 from .WebSocket import WebSocket
 
 __all__ = [
@@ -21,5 +22,6 @@
     "Lottie",
     "Mermaid",
     "Purify",
+    "SSE",
     "WebSocket"
 ]

dash_extensions/dataiku.py

@@ -1,15 +1,15 @@
 import os
 import re
+from distutils.dir_util import copy_tree
 
 from dash import Dash
-from distutils.dir_util import copy_tree
 
 """
-The purpose of this module is to ease the integration of Dash with Dataiku. 
+The purpose of this module is to ease the integration of Dash with Dataiku.
 """
 
 
-def bind_assets_folder(app: Dash, app_id: str, assets_folder: str):
+def bind_assets_folder(app: Dash, app_id: str, assets_folder: str):  # noqa: C901
     """
     Dataiku 10 doesn't support separate asset folders for each Dash app. This function targets fixing this issue by
     (1) creating a new asset sub folder for each app, and (2) limiting asset loading to this folder.