nicegui 2.7.0__tar.gz → 2.8.0__tar.gz

{nicegui-2.7.0 → nicegui-2.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nicegui
-Version: 2.7.0
+Version: 2.8.0
 Summary: Create web-based user interfaces with Python. The nice way.
 Home-page: https://github.com/zauberzeug/nicegui
 License: MIT
@@ -37,7 +37,7 @@ Requires-Dist: matplotlib (>=3.5.0,<4.0.0) ; extra == "matplotlib"
 Requires-Dist: nicegui-highcharts (>=2.0.2,<3.0.0) ; extra == "highcharts"
 Requires-Dist: orjson (>=3.9.15) ; platform_machine != "i386" and platform_machine != "i686"
 Requires-Dist: plotly (>=5.13.0,<6.0.0) ; extra == "plotly"
-Requires-Dist: python-multipart (>=0.0.7)
+Requires-Dist: python-multipart (>=0.0.18)
 Requires-Dist: python-socketio[asyncio-client] (>=5.10.0)
 Requires-Dist: pywebview (>=5.0.1,<6.0.0) ; extra == "native"
 Requires-Dist: requests (>=2.32.0)
@@ -167,6 +167,7 @@ If you would like to support this project and have your avatar or company logo a
   <a href="https://github.com/sereneturtlefox"><img src="https://github.com/sereneturtlefox.png" width="50px" alt="None" /></a>
   <a href="https://github.com/daviborges666"><img src="https://github.com/daviborges666.png" width="50px" alt="Davi Borges" /></a>
   <a href="https://github.com/whoulden"><img src="https://github.com/whoulden.png" width="50px" alt="Wayne Houlden" /></a>
+  <a href="https://github.com/digiquip"><img src="https://github.com/digiquip.png" width="50px" alt="DigiQuip AS" /></a>
 </p>
 <!-- SPONSORS -->
 

{nicegui-2.7.0 → nicegui-2.8.0}/README.md

@@ -116,6 +116,7 @@ If you would like to support this project and have your avatar or company logo a
   <a href="https://github.com/sereneturtlefox"><img src="https://github.com/sereneturtlefox.png" width="50px" alt="None" /></a>
   <a href="https://github.com/daviborges666"><img src="https://github.com/daviborges666.png" width="50px" alt="Davi Borges" /></a>
   <a href="https://github.com/whoulden"><img src="https://github.com/whoulden.png" width="50px" alt="Wayne Houlden" /></a>
+  <a href="https://github.com/digiquip"><img src="https://github.com/digiquip.png" width="50px" alt="DigiQuip AS" /></a>
 </p>
 <!-- SPONSORS -->
 

{nicegui-2.7.0 → nicegui-2.8.0}/nicegui/air.py

@@ -38,7 +38,7 @@ class Air:
         self.log = logging.getLogger('nicegui.air')
         self.token = token
         self.relay = socketio.AsyncClient()
-        self.client = httpx.AsyncClient(app=core.app)
+        self.client = httpx.AsyncClient(transport=httpx.ASGITransport(app=core.app))
         self.streaming_client = httpx.AsyncClient()
         self.connecting = False
         self.streams: Dict[str, Stream] = {}

{nicegui-2.7.0 → nicegui-2.8.0}/nicegui/app/app.py

@@ -139,7 +139,8 @@ class App(FastAPI):
                          url_path: str,
                          local_directory: Union[str, Path],
                          *,
-                         follow_symlink: bool = False) -> None:
+                         follow_symlink: bool = False,
+                         max_cache_age: int = 3600) -> None:
         """Add a directory of static files.
 
         `add_static_files()` makes a local directory available at the specified endpoint, e.g. `'/static'`.
@@ -153,11 +154,15 @@ class App(FastAPI):
         :param url_path: string that starts with a slash "/" and identifies the path at which the files should be served
         :param local_directory: local folder with files to serve as static content
         :param follow_symlink: whether to follow symlinks (default: False)
+        :param max_cache_age: value for max-age set in Cache-Control header
         """
         if url_path == '/':
             raise ValueError('''Path cannot be "/", because it would hide NiceGUI's internal "/_nicegui" route.''')
+        if max_cache_age < 0:
+            raise ValueError('''Value of max_cache_age must be a positive integer or 0.''')
 
-        handler = CacheControlledStaticFiles(directory=local_directory, follow_symlink=follow_symlink)
+        handler = CacheControlledStaticFiles(
+            directory=local_directory, follow_symlink=follow_symlink, max_cache_age=max_cache_age)
 
         @self.get(url_path + '/{path:path}')
         async def static_file(request: Request, path: str = '') -> Response:
@@ -167,7 +172,7 @@ class App(FastAPI):
                         local_file: Union[str, Path],
                         url_path: Optional[str] = None,
                         single_use: bool = False,
-                        ) -> str:
+                        max_cache_age: int = 3600) -> str:
         """Add a single static file.
 
         Allows a local file to be accessed online with enabled caching.
@@ -179,8 +184,12 @@ class App(FastAPI):
         :param local_file: local file to serve as static content
         :param url_path: string that starts with a slash "/" and identifies the path at which the file should be served (default: None -> auto-generated URL path)
         :param single_use: whether to remove the route after the file has been downloaded once (default: False)
+        :param max_cache_age: value for max-age set in Cache-Control header
         :return: encoded URL which can be used to access the file
         """
+        if max_cache_age < 0:
+            raise ValueError('''Value of max_cache_age must be a positive integer or 0.''')
+
         file = Path(local_file).resolve()
         if not file.is_file():
             raise ValueError(f'File not found: {file}')
@@ -190,7 +199,7 @@ class App(FastAPI):
         def read_item() -> FileResponse:
             if single_use:
                 self.remove_route(path)
-            return FileResponse(file, headers={'Cache-Control': 'public, max-age=3600'})
+            return FileResponse(file, headers={'Cache-Control': f'public, max-age={max_cache_age}'})
 
         return urllib.parse.quote(path)
 

{nicegui-2.7.0 → nicegui-2.8.0}/nicegui/element.py

@@ -519,6 +519,8 @@ class Element(Visibility):
             for key, value in self._props.items()
             if not key.startswith('_') and key not in IGNORED_PROPS and value
         ]
+        if not self.visible:
+            additions.append(f'visible={self.visible}')
         if additions:
             result += f' [{", ".join(additions)}]'
 

{nicegui-2.7.0 → nicegui-2.8.0}/nicegui/elements/json_editor.js

@@ -1,4 +1,4 @@
-import { JSONEditor } from "standalone";
+import { JSONEditor, createAjvValidator } from "standalone";
 
 export default {
   template: "<div></div>",
@@ -9,6 +9,8 @@ export default {
     this.properties.onSelect = (selection) => {
       this.$emit("select", { selection: selection });
     };
+
+    this.checkValidation();
     this.editor = new JSONEditor({
       target: this.$el,
       props: this.properties,
@@ -21,8 +23,14 @@ export default {
     this.destroyEditor();
   },
   methods: {
+    checkValidation() {
+      if (this.schema !== undefined) {
+        this.properties.validator = createAjvValidator({ schema: this.schema, schemaDefinitions: {}, ajvOptions: {} });
+      }
+    },
     update_editor() {
       if (this.editor) {
+        this.checkValidation();
         this.editor.updateProps(this.properties);
       }
     },
@@ -43,5 +51,6 @@ export default {
   },
   props: {
     properties: Object,
+    schema: Object,
   },
 };

{nicegui-2.7.0 → nicegui-2.8.0}/nicegui/elements/json_editor.py

@@ -19,6 +19,7 @@ class JsonEditor(Element, component='json_editor.js', dependencies=['lib/vanilla
                  properties: Dict, *,
                  on_select: Optional[Handler[JsonEditorSelectEventArguments]] = None,
                  on_change: Optional[Handler[JsonEditorChangeEventArguments]] = None,
+                 schema: Optional[Dict] = None,
                  ) -> None:
         """JSONEditor
 
@@ -29,10 +30,14 @@ class JsonEditor(Element, component='json_editor.js', dependencies=['lib/vanilla
         :param properties: dictionary of JSONEditor properties
         :param on_select: callback which is invoked when some of the content has been selected
         :param on_change: callback which is invoked when the content has changed
+        :param schema: optional `JSON schema <https://json-schema.org/>`_ for validating the data being edited
         """
         super().__init__()
         self._props['properties'] = properties
 
+        if schema:
+            self._props['schema'] = schema
+
         if on_select:
             self.on_select(on_select)
 

{nicegui-2.7.0 → nicegui-2.8.0}/nicegui/elements/number.py

@@ -27,7 +27,7 @@ class Number(ValidationElement, DisableableElement):
         This element is based on Quasar's `QInput <https://quasar.dev/vue-components/input>`_ component.
 
         You can use the `validation` parameter to define a dictionary of validation rules,
-        e.g. ``{'Too small!': lambda value: value < 3}``.
+        e.g. ``{'Too small!': lambda value: value > 3}``.
         The key of the first rule that fails will be displayed as an error message.
         Alternatively, you can pass a callable that returns an optional error message.
         To disable the automatic validation on every value change, you can use the `without_auto_validation` method.

{nicegui-2.7.0 → nicegui-2.8.0}/nicegui/json/__init__.py

@@ -15,7 +15,7 @@ except ImportError:
 
 
 __all__ = [
+    'NiceGUIJSONResponse',
     'dumps',
     'loads',
-    'NiceGUIJSONResponse'
 ]

{nicegui-2.7.0 → nicegui-2.8.0}/nicegui/page.py

@@ -40,9 +40,14 @@ class page:
         This means it is private to the user and not shared with others
         (as it is done `when placing elements outside of a page decorator <https://nicegui.io/documentation/section_pages_routing#auto-index_page>`_).
 
-        Note:
-        The name of the decorated function is unused and can be anything.
-        The page route is determined by the `path` argument and registered globally.
+        Notes:
+
+        - The name of the decorated function is unused and can be anything.
+        - The page route is determined by the `path` argument and registered globally.
+        - The decorator does only work for free functions and static methods.
+          Instance methods or initializers would require a `self` argument, which the router cannot associate.
+          See `our modularization example <https://github.com/zauberzeug/nicegui/tree/main/examples/modularization/>`_
+          for strategies to structure your code.
 
         :param path: route of the new page (path must start with '/')
         :param title: optional page title

{nicegui-2.7.0 → nicegui-2.8.0}/nicegui/staticfiles.py

@@ -5,7 +5,11 @@ from starlette.types import Scope
 
 class CacheControlledStaticFiles(StaticFiles):
 
+    def __init__(self, *args, max_cache_age: int = 3600, **kwargs) -> None:
+        self.max_cache_age = max_cache_age
+        super().__init__(*args, **kwargs)
+
     async def get_response(self, path: str, scope: Scope) -> Response:
         response = await super().get_response(path, scope)
-        response.headers['Cache-Control'] = 'public, max-age=3600'
+        response.headers['Cache-Control'] = f'public, max-age={self.max_cache_age}'
         return response

{nicegui-2.7.0 → nicegui-2.8.0}/nicegui/testing/user.py

@@ -191,20 +191,23 @@ class User:
         """Return the root layout element of the current page."""
         return self._client.layout
 
-    def _gather_elements(self,
-                         target: Union[str, Type[T], None] = None,
-                         kind: Optional[Type[T]] = None,
-                         marker: Union[str, List[str], None] = None,
-                         content: Union[str, List[str], None] = None,
-                         ) -> Set[T]:
+    def _gather_elements(
+        self,
+        target: Union[str, Type[T], None] = None,
+        kind: Optional[Type[T]] = None,
+        marker: Union[str, List[str], None] = None,
+        content: Union[str, List[str], None] = None,
+    ) -> Set[T]:
         if target is None:
             if kind is None:
-                return set(ElementFilter(marker=marker, content=content))  # type: ignore
-            return set(ElementFilter(kind=kind, marker=marker, content=content))
+                elements = set(ElementFilter(marker=marker, content=content))
+            else:
+                elements = set(ElementFilter(kind=kind, marker=marker, content=content))
         elif isinstance(target, str):
-            return set(ElementFilter(marker=target)).union(ElementFilter(content=target))  # type: ignore
+            elements = set(ElementFilter(marker=target)).union(ElementFilter(content=target))
         else:
-            return set(ElementFilter(kind=target))
+            elements = set(ElementFilter(kind=target))
+        return {e for e in elements if e.visible}  # type: ignore
 
     def _build_error_message(self,
                              target: Union[str, Type[T], None] = None,

{nicegui-2.7.0 → nicegui-2.8.0}/nicegui/testing/user_plugin.py

@@ -42,7 +42,7 @@ async def user(nicegui_reset_globals,  # noqa: F811, pylint: disable=unused-argu
     """Create a new user fixture."""
     prepare_simulation(request)
     async with core.app.router.lifespan_context(core.app):
-        async with httpx.AsyncClient(app=core.app, base_url='http://test') as client:
+        async with httpx.AsyncClient(transport=httpx.ASGITransport(core.app), base_url='http://test') as client:
             yield User(client)
     ui.navigate = Navigate()
     ui.notify = notify
@@ -56,6 +56,6 @@ async def create_user(nicegui_reset_globals,  # noqa: F811, pylint: disable=unus
     """Create a fixture for building new users."""
     prepare_simulation(request)
     async with core.app.router.lifespan_context(core.app):
-        yield lambda: User(httpx.AsyncClient(app=core.app, base_url='http://test'))
+        yield lambda: User(httpx.AsyncClient(transport=httpx.ASGITransport(core.app), base_url='http://test'))
     ui.navigate = Navigate()
     ui.notify = notify

{nicegui-2.7.0 → nicegui-2.8.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "nicegui"
-version = "v2.7.0"
+version = "v2.8.0"
 description = "Create web-based user interfaces with Python. The nice way."
 authors = ["Zauberzeug GmbH <info@zauberzeug.com>"]
 license = "MIT"
@@ -19,7 +19,7 @@ python-socketio = {extras = ["asyncio-client"], version = ">=5.10.0"} # version
 vbuild = ">=0.8.2"
 watchfiles = ">=0.18.1"
 jinja2 = "^3.1.4" # https://github.com/zauberzeug/nicegui/security/dependabot/32
-python-multipart = ">=0.0.7"
+python-multipart = ">=0.0.18"
 orjson = {version = ">=3.9.15", markers = "platform_machine != 'i386' and platform_machine != 'i686'"} # https://github.com/zauberzeug/nicegui/security/dependabot/29, orjson does not support 32bit
 itsdangerous = "^2.1.2"
 aiofiles = ">=23.1.0"
@@ -63,8 +63,11 @@ numpy = [
 ]
 selenium = "^4.11.2"
 pyecharts = "^2.0.4"
-ruff = ">=0.3.5"
-pre-commit = ">=3.5.0"
+ruff = ">=0.8.1"
+pre-commit = [
+    {version = "<4.0.0", python = "<3.9"},
+    {version = ">=4.0.0", python = ">=3.9,<3.14"}
+]
 isort = "^5.11"
 polars = [
     {version = "^1.8.0", python = "~3.8"},
@@ -81,7 +84,7 @@ nicegui-pack = "nicegui.scripts.pack:main"
 
 [build-system]
 requires = [
-    "setuptools>=30.3.0,<50",
+    "setuptools>=30.3.0",
     "poetry-core>=1.0.0"
 ]
 build-backend = "poetry.core.masonry.api"
@@ -113,6 +116,7 @@ module = [
 ignore_missing_imports = true
 
 [tool.ruff]
+target-version = "py38"
 indent-width = 4
 line-length = 120
 
@@ -130,6 +134,7 @@ select = [
 ]
 fixable = [
     "I",  # isort
+    "RUF022", # `__all__` is not sorted
 ]
 ignore = [
     "E501", # line too long

{nicegui-2.7.0 → nicegui-2.8.0}/nicegui/__init__.py

@@ -10,15 +10,15 @@ from .version import __version__
 
 __all__ = [
     'APIRouter',
-    'app',
     'App',
     'Client',
-    'context',
     'ElementFilter',
+    'Tailwind',
+    '__version__',
+    'app',
+    'context',
     'elements',
     'html',
     'run',
-    'Tailwind',
     'ui',
-    '__version__',
 ]