func-to-web 2.7.0__tar.gz → 2.7.2__tar.gz

{func_to_web-2.7.0/src/func_to_web.egg-info → func_to_web-2.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: func-to-web
-Version: 2.7.0
+Version: 2.7.2
 Summary: Expose typed Python functions as web interfaces.
 Author: Beltrán Offerrall
 License: MIT License
@@ -61,7 +61,7 @@ Provides-Extra: test-browser
 Requires-Dist: playwright; extra == "test-browser"
 Dynamic: license-file
 
-# FuncToWeb 2.7.0
+# FuncToWeb
 
 [![PyPI version](https://img.shields.io/pypi/v/func-to-web.svg)](https://pypi.org/project/func-to-web/)
 [![Python](https://img.shields.io/pypi/pyversions/func-to-web.svg)](https://pypi.org/project/func-to-web/)
@@ -447,7 +447,7 @@ upload no execution ever uses expires; what your code received stays.
 ## Examples
 
 The examples are probably the best way to learn the library.
-[`examples/`](examples/README.md) contains 81 runnable programs in 11 folders.
+[`examples/`](docs/examples.md) contains 81 runnable programs in 11 folders.
 Each file teaches **a single capability**: you can read it in one sitting and
 run it as it is. Alongside them, [`examples/project/`](examples/project/) holds
 mini-apps, where several capabilities are combined into one small application.
@@ -539,13 +539,13 @@ mini-app with the dict swapped for a store.
 
 Those three libraries are the whole stack: nested forms, recursive validation,
 streaming, the file lifecycle and the published contract are all inside these
-lines (v2.6.0, `.py`/`.js`/`.css` under `src/`).
+lines (v2.7.1, `.py`/`.js`/`.css` under `src/`).
 
 ```text
 pytypehint       2,740 lines    types, validation, defaults
-pytypehintweb    9,468 lines    plan, widgets, transport (includes the JS/CSS)
-FuncToWeb        5,071 lines    routes, execution, storage, /doc
-total           ~17,300 lines
+pytypehintweb    9,499 lines    plan, widgets, transport (includes the JS/CSS)
+FuncToWeb        5,306 lines    routes, execution, storage, /doc
+total           ~17,500 lines
 ```
 
 Each layer can be read on its own: pytypehint is under 3,000 lines of pure
@@ -578,16 +578,52 @@ func-to-web && pip freeze` in an empty virtualenv prints exactly this.
 
 ## Documentation
 
-[docs/index.md](docs/index.md) is the complete index, organized by what you
-want to do, and the technical reference for everything the examples show in
-practice.
+The technical reference, organized by what you want to do. For hands-on use,
+see [Examples](docs/examples.md), one capability per file.
+
+### Start here
+
+- [Getting started](docs/getting-started.md): install, write your first function and run it.
+- [Examples](docs/examples.md): the runnable examples and mini-apps, how to run them, and what each folder teaches.
+- [`run()`](docs/run.md): the standalone application and the space index.
+- [`app_of()`](docs/router.md): mounting the application in an existing FastAPI host application.
+
+### Inputs and forms
+
+- [Types and validation](docs/types.md): constraints, dataclasses, lists, unions, optionals and defaults.
+- [Prefill and hidden parameters](docs/prefill.md): open a form with initial values, from Python or from the URL.
+- [Files](docs/files.md): uploads, reusable file references, and which layer applies each limit.
+- [`WebFunction`](docs/web-function.md): the name, description and slug of a function; prepared spaces.
+
+### Execution and results
+
+- [Execution over HTTP](docs/http.md): `/invoke`, the request body, the envelope and the status codes.
+- [Streaming](docs/streaming.md): `/invoke-stream`, SSE events and `print()` capture.
+- [Outputs](docs/outputs.md): text, images, tables and downloads with `Download`.
+- [`OpenForm`](docs/open-form.md): open another function's form with the return value as prefill.
+
+### Integration
+
+- [`/doc`](docs/api-docs.md): the published contract that a client or an agent consumes.
+- [`sdk.js`](docs/sdk.md): the helpers that call a space from your own frontend, and how to embed a function's page in another site.
+- [Static assets](docs/static-assets.md): `/static`, the icons, the theme and how they are cached.
+- [Security](docs/security.md): what FuncToWeb covers and what belongs to the host application.
+
+### Internals
+
+- [Architecture](docs/architecture.md): the layers and what each one solves.
+- [Limitations](docs/limitations.md): the known limits, in a single list.
+
+### Design notes
+
+The pages above say what each thing is: the signature, the values, the errors and one example. The reasoning behind each of those decisions lives apart, in [`design/`](docs/design/index.md) — for whoever contributes to FuncToWeb, and for the curious. Nothing there is needed in order to use the library.
 
 ## Status
 
-**FuncToWeb 2.7.0 is stable, used daily and actively maintained.**
+**FuncToWeb is stable, used daily and actively maintained.**
 
 The public API is the one described in
-[`docs/`](docs/index.md), and the known limitations are listed in
+[documentation](#documentation), and the known limitations are listed in
 [limitations.md](docs/limitations.md).
 
 ## License

{func_to_web-2.7.0 → func_to_web-2.7.2}/README.md

@@ -1,4 +1,4 @@
-# FuncToWeb 2.7.0
+# FuncToWeb
 
 [![PyPI version](https://img.shields.io/pypi/v/func-to-web.svg)](https://pypi.org/project/func-to-web/)
 [![Python](https://img.shields.io/pypi/pyversions/func-to-web.svg)](https://pypi.org/project/func-to-web/)
@@ -384,7 +384,7 @@ upload no execution ever uses expires; what your code received stays.
 ## Examples
 
 The examples are probably the best way to learn the library.
-[`examples/`](examples/README.md) contains 81 runnable programs in 11 folders.
+[`examples/`](docs/examples.md) contains 81 runnable programs in 11 folders.
 Each file teaches **a single capability**: you can read it in one sitting and
 run it as it is. Alongside them, [`examples/project/`](examples/project/) holds
 mini-apps, where several capabilities are combined into one small application.
@@ -476,13 +476,13 @@ mini-app with the dict swapped for a store.
 
 Those three libraries are the whole stack: nested forms, recursive validation,
 streaming, the file lifecycle and the published contract are all inside these
-lines (v2.6.0, `.py`/`.js`/`.css` under `src/`).
+lines (v2.7.1, `.py`/`.js`/`.css` under `src/`).
 
 ```text
 pytypehint       2,740 lines    types, validation, defaults
-pytypehintweb    9,468 lines    plan, widgets, transport (includes the JS/CSS)
-FuncToWeb        5,071 lines    routes, execution, storage, /doc
-total           ~17,300 lines
+pytypehintweb    9,499 lines    plan, widgets, transport (includes the JS/CSS)
+FuncToWeb        5,306 lines    routes, execution, storage, /doc
+total           ~17,500 lines
 ```
 
 Each layer can be read on its own: pytypehint is under 3,000 lines of pure
@@ -515,16 +515,52 @@ func-to-web && pip freeze` in an empty virtualenv prints exactly this.
 
 ## Documentation
 
-[docs/index.md](docs/index.md) is the complete index, organized by what you
-want to do, and the technical reference for everything the examples show in
-practice.
+The technical reference, organized by what you want to do. For hands-on use,
+see [Examples](docs/examples.md), one capability per file.
+
+### Start here
+
+- [Getting started](docs/getting-started.md): install, write your first function and run it.
+- [Examples](docs/examples.md): the runnable examples and mini-apps, how to run them, and what each folder teaches.
+- [`run()`](docs/run.md): the standalone application and the space index.
+- [`app_of()`](docs/router.md): mounting the application in an existing FastAPI host application.
+
+### Inputs and forms
+
+- [Types and validation](docs/types.md): constraints, dataclasses, lists, unions, optionals and defaults.
+- [Prefill and hidden parameters](docs/prefill.md): open a form with initial values, from Python or from the URL.
+- [Files](docs/files.md): uploads, reusable file references, and which layer applies each limit.
+- [`WebFunction`](docs/web-function.md): the name, description and slug of a function; prepared spaces.
+
+### Execution and results
+
+- [Execution over HTTP](docs/http.md): `/invoke`, the request body, the envelope and the status codes.
+- [Streaming](docs/streaming.md): `/invoke-stream`, SSE events and `print()` capture.
+- [Outputs](docs/outputs.md): text, images, tables and downloads with `Download`.
+- [`OpenForm`](docs/open-form.md): open another function's form with the return value as prefill.
+
+### Integration
+
+- [`/doc`](docs/api-docs.md): the published contract that a client or an agent consumes.
+- [`sdk.js`](docs/sdk.md): the helpers that call a space from your own frontend, and how to embed a function's page in another site.
+- [Static assets](docs/static-assets.md): `/static`, the icons, the theme and how they are cached.
+- [Security](docs/security.md): what FuncToWeb covers and what belongs to the host application.
+
+### Internals
+
+- [Architecture](docs/architecture.md): the layers and what each one solves.
+- [Limitations](docs/limitations.md): the known limits, in a single list.
+
+### Design notes
+
+The pages above say what each thing is: the signature, the values, the errors and one example. The reasoning behind each of those decisions lives apart, in [`design/`](docs/design/index.md) — for whoever contributes to FuncToWeb, and for the curious. Nothing there is needed in order to use the library.
 
 ## Status
 
-**FuncToWeb 2.7.0 is stable, used daily and actively maintained.**
+**FuncToWeb is stable, used daily and actively maintained.**
 
 The public API is the one described in
-[`docs/`](docs/index.md), and the known limitations are listed in
+[documentation](#documentation), and the known limitations are listed in
 [limitations.md](docs/limitations.md).
 
 ## License

{func_to_web-2.7.0 → func_to_web-2.7.2}/pyproject.toml

@@ -62,7 +62,11 @@ Source = "https://github.com/offerrall/FuncToWeb"
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 addopts = "--strict-markers --strict-config"
-filterwarnings = ["error"]
+filterwarnings = [
+    "error",
+    # Raised inside Starlette's TestClient by anyio 4.15, not by FuncToWeb.
+    "ignore:The anyio.abc.BlockingPortal alias is deprecated:DeprecationWarning",
+]
 markers = [
     "browser: needs a real headless browser",
     "package: builds or installs the distribution",

{func_to_web-2.7.0 → func_to_web-2.7.2}/src/func_to_web/config.py

@@ -3,7 +3,7 @@ from pathlib import Path
 from sys import platform
 from tempfile import gettempdir
 
-__version__ = "2.7.0"
+__version__ = "2.7.2"
 
 NAME: str = "".join(part.title() for part in __name__.split(".")[0].split("_"))
 

{func_to_web-2.7.0 → func_to_web-2.7.2}/src/func_to_web/static/sdk.js

@@ -51,6 +51,15 @@ const MODAL_STYLE = `
     background: transparent;
 }
 
+.ftw-modal-panel[data-ftw-sizing] {
+    visibility: hidden;
+    animation: ftw-reveal 0s 1.5s forwards;
+}
+
+@keyframes ftw-reveal {
+    to { visibility: visible; }
+}
+
 .ftw-modal-close {
     position: absolute;
     top: 10px;
@@ -568,6 +577,11 @@ export function openModal(url, options = {}) {
     panel.append(button);
     overlay.append(panel);
 
+    // Until the page reports its height the panel would open at its maximum
+    // and then shrink. It stays invisible meanwhile; the overlay still shows
+    // at once, and the stylesheet reveals the panel if no height ever comes.
+    if (autoHeight) panel.setAttribute("data-ftw-sizing", "");
+
     // The modal owns sizing and listener lifetime; its iframe fills the panel.
     const frame = embed(panel, url, { ...rest, autoHeight: false });
 
@@ -580,7 +594,9 @@ export function openModal(url, options = {}) {
 
     const channel = listen(frame, {
         onResize(size) {
-            if (autoHeight) panel.style.setProperty("--ftw-content-height", `${size}px`);
+            if (!autoHeight) return;
+            panel.style.setProperty("--ftw-content-height", `${size}px`);
+            panel.removeAttribute("data-ftw-sizing");
         },
         onResult(outputs) {
             if (onResult !== null) onResult(outputs);

{func_to_web-2.7.0 → func_to_web-2.7.2/src/func_to_web.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: func-to-web
-Version: 2.7.0
+Version: 2.7.2
 Summary: Expose typed Python functions as web interfaces.
 Author: Beltrán Offerrall
 License: MIT License
@@ -61,7 +61,7 @@ Provides-Extra: test-browser
 Requires-Dist: playwright; extra == "test-browser"
 Dynamic: license-file
 
-# FuncToWeb 2.7.0
+# FuncToWeb
 
 [![PyPI version](https://img.shields.io/pypi/v/func-to-web.svg)](https://pypi.org/project/func-to-web/)
 [![Python](https://img.shields.io/pypi/pyversions/func-to-web.svg)](https://pypi.org/project/func-to-web/)
@@ -447,7 +447,7 @@ upload no execution ever uses expires; what your code received stays.
 ## Examples
 
 The examples are probably the best way to learn the library.
-[`examples/`](examples/README.md) contains 81 runnable programs in 11 folders.
+[`examples/`](docs/examples.md) contains 81 runnable programs in 11 folders.
 Each file teaches **a single capability**: you can read it in one sitting and
 run it as it is. Alongside them, [`examples/project/`](examples/project/) holds
 mini-apps, where several capabilities are combined into one small application.
@@ -539,13 +539,13 @@ mini-app with the dict swapped for a store.
 
 Those three libraries are the whole stack: nested forms, recursive validation,
 streaming, the file lifecycle and the published contract are all inside these
-lines (v2.6.0, `.py`/`.js`/`.css` under `src/`).
+lines (v2.7.1, `.py`/`.js`/`.css` under `src/`).
 
 ```text
 pytypehint       2,740 lines    types, validation, defaults
-pytypehintweb    9,468 lines    plan, widgets, transport (includes the JS/CSS)
-FuncToWeb        5,071 lines    routes, execution, storage, /doc
-total           ~17,300 lines
+pytypehintweb    9,499 lines    plan, widgets, transport (includes the JS/CSS)
+FuncToWeb        5,306 lines    routes, execution, storage, /doc
+total           ~17,500 lines
 ```
 
 Each layer can be read on its own: pytypehint is under 3,000 lines of pure
@@ -578,16 +578,52 @@ func-to-web && pip freeze` in an empty virtualenv prints exactly this.
 
 ## Documentation
 
-[docs/index.md](docs/index.md) is the complete index, organized by what you
-want to do, and the technical reference for everything the examples show in
-practice.
+The technical reference, organized by what you want to do. For hands-on use,
+see [Examples](docs/examples.md), one capability per file.
+
+### Start here
+
+- [Getting started](docs/getting-started.md): install, write your first function and run it.
+- [Examples](docs/examples.md): the runnable examples and mini-apps, how to run them, and what each folder teaches.
+- [`run()`](docs/run.md): the standalone application and the space index.
+- [`app_of()`](docs/router.md): mounting the application in an existing FastAPI host application.
+
+### Inputs and forms
+
+- [Types and validation](docs/types.md): constraints, dataclasses, lists, unions, optionals and defaults.
+- [Prefill and hidden parameters](docs/prefill.md): open a form with initial values, from Python or from the URL.
+- [Files](docs/files.md): uploads, reusable file references, and which layer applies each limit.
+- [`WebFunction`](docs/web-function.md): the name, description and slug of a function; prepared spaces.
+
+### Execution and results
+
+- [Execution over HTTP](docs/http.md): `/invoke`, the request body, the envelope and the status codes.
+- [Streaming](docs/streaming.md): `/invoke-stream`, SSE events and `print()` capture.
+- [Outputs](docs/outputs.md): text, images, tables and downloads with `Download`.
+- [`OpenForm`](docs/open-form.md): open another function's form with the return value as prefill.
+
+### Integration
+
+- [`/doc`](docs/api-docs.md): the published contract that a client or an agent consumes.
+- [`sdk.js`](docs/sdk.md): the helpers that call a space from your own frontend, and how to embed a function's page in another site.
+- [Static assets](docs/static-assets.md): `/static`, the icons, the theme and how they are cached.
+- [Security](docs/security.md): what FuncToWeb covers and what belongs to the host application.
+
+### Internals
+
+- [Architecture](docs/architecture.md): the layers and what each one solves.
+- [Limitations](docs/limitations.md): the known limits, in a single list.
+
+### Design notes
+
+The pages above say what each thing is: the signature, the values, the errors and one example. The reasoning behind each of those decisions lives apart, in [`design/`](docs/design/index.md) — for whoever contributes to FuncToWeb, and for the curious. Nothing there is needed in order to use the library.
 
 ## Status
 
-**FuncToWeb 2.7.0 is stable, used daily and actively maintained.**
+**FuncToWeb is stable, used daily and actively maintained.**
 
 The public API is the one described in
-[`docs/`](docs/index.md), and the known limitations are listed in
+[documentation](#documentation), and the known limitations are listed in
 [limitations.md](docs/limitations.md).
 
 ## License