Merge branch 'main' into yogesh-xxx-fix-vega-warnings2

Author: b-yogesh

.github/workflows/publish.yml

@@ -3,6 +3,7 @@ name: Package and Publish
 on:
   release:
     types: [published]
+  workflow_dispatch:
 
 jobs:
   python-tests:
@@ -11,6 +12,9 @@ jobs:
       fail-fast: false
       matrix:
         python-version: ["3.10", "3.11", "3.12"]
+    defaults:
+      run:
+        working-directory: chartlets.py 
 
     steps:
     - uses: actions/checkout@v3
@@ -23,7 +27,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install .[dev]
+        pip install .[dev,demo]
         
     - name: Lint with flake8
       run: |
@@ -45,6 +49,9 @@ jobs:
     name: Publish Python Package to PyPI
     runs-on: ubuntu-latest
     needs: python-tests
+    defaults:
+      run:
+        working-directory: chartlets.py 
 
     steps:
     - uses: actions/checkout@v4
@@ -62,20 +69,25 @@ jobs:
     - name: Build package
       run: |
         python -m build
-        
-    - name: Publish to PyPI
-      run: |
-        pip install twine
-        python -m twine upload --username __token__ --password ${{ secrets.PYPI_API_TOKEN }} dist/*
+
+    - name: Publish package to PyPI
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}
+        packages_dir: chartlets.py/dist
+        verbose: true
 
   npm-tests:
     runs-on: ubuntu-latest
-
     strategy:
       matrix:
         node-version: [16.x, 18.x, 20.x]
         # See supported Node.js release schedule at
         # https://nodejs.org/en/about/releases/
+    defaults:
+      run:
+        working-directory: chartlets.js
 
     steps:
       - uses: actions/checkout@v3
@@ -84,6 +96,8 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
+          cache-dependency-path: chartlets.js/package-lock.json
+          
       - run: npm ci
       - run: npm run lint
       - run: npm run build
@@ -93,6 +107,9 @@ jobs:
     name: Publish TS-React Package to npmjs
     runs-on: ubuntu-latest
     needs: npm-tests
+    defaults:
+      run:
+        working-directory: chartlets.js
 
     steps:
       - uses: actions/checkout@v4
@@ -102,6 +119,9 @@ jobs:
         with:
           node-version: '18.x'
           registry-url: 'https://registry.npmjs.org'
+          cache: 'npm'
+          cache-dependency-path: chartlets.js/package-lock.json
+          
       - run: npm ci
       - run: npm run build
       - run: npm publish --access public

chartlets.js/CHANGES.md

@@ -1,3 +1,7 @@
+## Version 0.0.28 (from 2024/11/26)
+
+* Updated docs.
+
 ## Version 0.0.27 (from 2024/11/25)
 
 * Added component `IconButton` and enhanced other components' attributes.

chartlets.js/TODO.md

@@ -1,6 +1,6 @@
 {
   "name": "chartlets",
-  "version": "0.0.27",
+  "version": "0.0.28",
   "description": "An experimental library for integrating interactive charts into existing JavaScript applications.",
   "type": "module",
   "files": [

chartlets.js/package-lock.json

@@ -1,4 +1,6 @@
-## Version 0.0.x (in development)
+## Version 0.0.28 (from 2024/11/26)
+
+* Updated docs.
 
 * Added component `IconButton` and enhanced other components' attributes.
 

chartlets.js/package.json

@@ -22,7 +22,7 @@ def from_decorator(
         decorator_name: str,
         decorator_args: tuple[Any, ...],
         function: Any,
-        outputs_allowed: bool = False,
+        states_only: bool = False,
     ) -> "Callback":
         try:
             signature = inspect.signature(function)
@@ -45,22 +45,22 @@ def from_decorator(
         inputs: list[Input | State] = []
         outputs: list[Output] = []
         for arg in decorator_args:
-            if isinstance(arg, (Input, State)):
-                inputs.append(arg)
-            elif outputs_allowed and isinstance(arg, Output):
-                outputs.append(arg)
-            elif outputs_allowed:
+            if states_only and not isinstance(arg, State):
                 raise TypeError(
                     f"arguments for decorator {decorator_name!r}"
-                    f" must be of type Input, State, Output, AppInput,"
-                    f" or AppOutput, but got {arg.__class__.__name__!r}"
+                    f" must be of type State,"
+                    f" but got {arg.__class__.__name__!r}"
                 )
-            else:
+            if not isinstance(arg, (Input, State, Output)):
                 raise TypeError(
                     f"arguments for decorator {decorator_name!r}"
-                    f" must be of type Input,"
+                    f" must be of type Input, State, or Output,"
                     f" but got {arg.__class__.__name__!r}"
                 )
+            if isinstance(arg, Output):
+                outputs.append(arg)
+            else:
+                inputs.append(arg)
 
         num_params = len(signature.parameters) - 1
         num_inputs = len(inputs)

chartlets.py/CHANGES.md

@@ -2,7 +2,7 @@
 from abc import ABC
 
 from .callback import Callback
-from .channel import Channel
+from .channel import Input, State, Output
 
 
 class Contribution(ABC):
@@ -20,7 +20,7 @@ class Contribution(ABC):
     """
 
     # noinspection PyShadowingBuiltins
-    def __init__(self, name: str, **initial_state):
+    def __init__(self, name: str, **initial_state: Any):
         self.name = name
         self.initial_state = initial_state
         self.extension: str | None = None
@@ -47,7 +47,7 @@ def to_dict(self) -> dict[str, Any]:
             d.update(callbacks=[cb.to_dict() for cb in self.callbacks])
         return d
 
-    def layout(self, *args) -> Callable[[Callable], Callable]:
+    def layout(self, *args: State) -> Callable[[Callable], Callable]:
         """Provides a decorator for a user-provided function that
         returns the initial user interface layout.
 
@@ -65,13 +65,12 @@ def layout(self, *args) -> Callable[[Callable], Callable]:
         called `ctx`.
 
         Other parameters of the decorated function are user-defined
-        and must have a corresponding `chartlets.Input` or
-        `chartlets.State` arguments in the `layout` decorator in the
-        same order.
+        and must have a corresponding `chartlets.State` arguments
+        in the `layout` decorator in the same order.
 
         Args:
             args:
-                `chartlets.Input` or `chartlets.State` objects that
+                `chartlets.State` objects that
                 define the source of the value for the corresponding
                 parameter of the decorated function. Optional.
 
@@ -81,13 +80,13 @@ def layout(self, *args) -> Callable[[Callable], Callable]:
 
         def decorator(function: Callable) -> Callable:
             self.layout_callback = Callback.from_decorator(
-                "layout", args, function, outputs_allowed=False
+                "layout", args, function, states_only=True
             )
             return function
 
         return decorator
 
-    def callback(self, *args: Channel) -> Callable[[Callable], Callable]:
+    def callback(self, *args: Input | State | Output) -> Callable[[Callable], Callable]:
         """Provide a decorator for a user-provided callback function.
 
         Callback functions are event handlers that react
@@ -125,7 +124,7 @@ def callback(self, *args: Channel) -> Callable[[Callable], Callable]:
         def decorator(function: Callable) -> Callable:
             self.callbacks.append(
                 Callback.from_decorator(
-                    "callback", args, function, outputs_allowed=True
+                    "callback", args, function, states_only=False
                 )
             )
             return function

chartlets.py/chartlets/callback.py

@@ -19,16 +19,18 @@
 from chartlets.demo.contribs import Panel
 from chartlets.demo.utils import NumpyJSONEncoder
 
-DASHI_CONTEXT_KEY = "chartlets.context"
 
 # This would be done by a xcube server extension
 Extension.add_contrib_point("panels", Panel)
 
 
+_CONTEXT_KEY = "chartlets.context"
+
+
 class DashiHandler(tornado.web.RequestHandler):
     @property
     def ext_ctx(self) -> ExtensionContext:
-        return self.settings[DASHI_CONTEXT_KEY]
+        return self.settings[_CONTEXT_KEY]
 
     def set_default_headers(self):
         self.set_header("Access-Control-Allow-Origin", "*")
@@ -97,7 +99,7 @@ def print_usage(app, port):
     print(f"Listening on {url}...")
     print(f"API:")
     print(f"- {url}/chartlets/contributions")
-    ext_ctx: ExtensionContext = app.settings[DASHI_CONTEXT_KEY]
+    ext_ctx: ExtensionContext = app.settings[_CONTEXT_KEY]
     for contrib_point_name, contributions in ext_ctx.contributions.items():
         for i in range(len(contributions)):
             print(f"- {url}/chartlets/layout/{contrib_point_name}/{i}")
@@ -120,7 +122,7 @@ def make_app():
 
     # Load extensions
     ext_ctx = ExtensionContext.load(Context(), server_config.get("extensions", []))
-    app.settings[DASHI_CONTEXT_KEY] = ext_ctx
+    app.settings[_CONTEXT_KEY] = ext_ctx
 
     return app
 

chartlets.py/chartlets/contribution.py

@@ -4,16 +4,29 @@
 
 
 class Extension:
-    """A UI Extension."""
+    """An extension for a UI application that
+    uses the Chartlets JS framework."""
 
     _contrib_points: dict[type[Contribution], str] = {}
 
     @classmethod
     def add_contrib_point(cls, name: str, item_type: type[Contribution]):
+        """Add a contribution point.
+
+        Args:
+            name: The name of the contribution point.
+            item_type: The type of items that can be added
+                to the new contribution point.
+        """
         cls._contrib_points[item_type] = name
 
     @classmethod
     def get_contrib_point_names(cls) -> tuple[str, ...]:
+        """Get names of all known contribution points added
+        by the `add_contrib_point()` method.
+
+        Returns: Tuple of registered contribution point names.
+        """
         values = cls._contrib_points.values()
         # noinspection PyTypeChecker
         return tuple(values)
@@ -26,6 +39,13 @@ def __init__(self, name: str, version: str = "0.0.0"):
             setattr(self, contrib_point_name, [])
 
     def add(self, contribution: Contribution):
+        """Add a contribution to this extension.
+
+        Args:
+            contribution: The contribution.
+                Its type must be an instance of one of the
+                registered contribution types.
+        """
         contrib_type = type(contribution)
         contrib_point_name = self._contrib_points.get(contrib_type)
         if contrib_point_name is None:
@@ -37,6 +57,10 @@ def add(self, contribution: Contribution):
         contributions.append(contribution)
 
     def to_dict(self) -> dict[str, Any]:
+        """Convert this extension into a JSON-serializable dictionary.
+
+        Returns: A dictionary representing this extension.
+        """
         return dict(
             name=self.name,
             version=self.version,