sphinx-typst-render 0.2.3__tar.gz → 0.2.4__tar.gz

{sphinx_typst_render-0.2.3 → sphinx_typst_render-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinx-typst-render
-Version: 0.2.3
+Version: 0.2.4
 Summary: Render Typst sources into downloadable PDFs and inline previews in Sphinx and Jupyter Book.
 Keywords: jupyter-book,sphinx,typst,pdf,forms,documentation
 Author: NB-TUDelft, K.Zabłocki (Zamkorus)
@@ -88,6 +88,7 @@ Pass `:inline:` to also show a preview image and a download link in the body.
 | `:class:` | none | Extra CSS classes on the wrapper. |
 | `:inline:` | off | Also show a preview and link in the page body. |
 | `:fillable:` | off | Add interactive form fields. See below. |
+| `:max-length:` | from config | Characters a text field accepts. `0` strips the limit. |
 
 ### Configuration
 
@@ -98,6 +99,7 @@ Pass `:inline:` to also show a preview image and a download link in the body.
 | `typst_render_stage_field_library` | `True` | Stage `capture_field.typ` into the source root. |
 | `typst_render_source_label` | `"Source"` | Heading above the page's own downloads. |
 | `typst_render_downloads_label` | `"Worksheets"` | Heading above the rendered PDFs. |
+| `typst_render_field_max_length` | `10000` | Characters a text field accepts. `0` strips the limit. |
 
 ## The download menu
 
@@ -178,6 +180,26 @@ yourself.
 Available helpers are `text_field`, `textarea_field`, `checkbox_field`, and
 `radio_field`, plus the lower level `capture_field`.
 
+## Field length
+
+ReportLab caps every text field at 100 characters by default, which stops a
+worksheet answer mid-sentence. This package overrides that with an explicit,
+generous cap:
+
+```yaml
+sphinx:
+  config:
+    typst_render_field_max_length: 10000   # 0 strips the limit entirely
+```
+
+The value is written explicitly rather than omitted because **some readers
+treat a missing `/MaxLen` as zero** and then refuse all input. Stripping it is
+still available with `0`, for projects that have checked their readers cope.
+Either way it is a config change, not a new release of this package. A single
+block can override it with `:max-length:`.
+
+Only text fields are affected. A cap on a checkbox would be meaningless.
+
 ## Caching
 
 Output is written beside the source and skipped when nothing relevant changed.

{sphinx_typst_render-0.2.3 → sphinx_typst_render-0.2.4}/README.md

@@ -57,6 +57,7 @@ Pass `:inline:` to also show a preview image and a download link in the body.
 | `:class:` | none | Extra CSS classes on the wrapper. |
 | `:inline:` | off | Also show a preview and link in the page body. |
 | `:fillable:` | off | Add interactive form fields. See below. |
+| `:max-length:` | from config | Characters a text field accepts. `0` strips the limit. |
 
 ### Configuration
 
@@ -67,6 +68,7 @@ Pass `:inline:` to also show a preview image and a download link in the body.
 | `typst_render_stage_field_library` | `True` | Stage `capture_field.typ` into the source root. |
 | `typst_render_source_label` | `"Source"` | Heading above the page's own downloads. |
 | `typst_render_downloads_label` | `"Worksheets"` | Heading above the rendered PDFs. |
+| `typst_render_field_max_length` | `10000` | Characters a text field accepts. `0` strips the limit. |
 
 ## The download menu
 
@@ -147,6 +149,26 @@ yourself.
 Available helpers are `text_field`, `textarea_field`, `checkbox_field`, and
 `radio_field`, plus the lower level `capture_field`.
 
+## Field length
+
+ReportLab caps every text field at 100 characters by default, which stops a
+worksheet answer mid-sentence. This package overrides that with an explicit,
+generous cap:
+
+```yaml
+sphinx:
+  config:
+    typst_render_field_max_length: 10000   # 0 strips the limit entirely
+```
+
+The value is written explicitly rather than omitted because **some readers
+treat a missing `/MaxLen` as zero** and then refuse all input. Stripping it is
+still available with `0`, for projects that have checked their readers cope.
+Either way it is a config change, not a new release of this package. A single
+block can override it with `:max-length:`.
+
+Only text fields are affected. A cap on a checkbox would be meaningless.
+
 ## Caching
 
 Output is written beside the source and skipped when nothing relevant changed.

{sphinx_typst_render-0.2.3 → sphinx_typst_render-0.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sphinx-typst-render"
-version = "0.2.3"
+version = "0.2.4"
 description = "Render Typst sources into downloadable PDFs and inline previews in Sphinx and Jupyter Book."
 readme = "README.md"
 requires-python = ">=3.10"

{sphinx_typst_render-0.2.3 → sphinx_typst_render-0.2.4}/pyproject.toml.orig

@@ -1,6 +1,6 @@
 [project]
 name = "sphinx-typst-render"
-version = "0.2.3"
+version = "0.2.4"
 description = "Render Typst sources into downloadable PDFs and inline previews in Sphinx and Jupyter Book."
 readme = "README.md"
 requires-python = ">=3.10"

{sphinx_typst_render-0.2.3 → sphinx_typst_render-0.2.4}/src/sphinx_typst_render/__init__.py

@@ -5,7 +5,13 @@ from __future__ import annotations
 import json
 from pathlib import Path
 
-from ._compile import RenderRequest, RenderResult, render, stage_field_library
+from ._compile import (
+    DEFAULT_MAX_LENGTH,
+    RenderRequest,
+    RenderResult,
+    render,
+    stage_field_library,
+)
 from ._directive import TypstDirective
 from ._downloads import (
     add_download_buttons,
@@ -15,6 +21,7 @@ from ._downloads import (
 )
 
 __all__ = [
+    "DEFAULT_MAX_LENGTH",
     "RenderRequest",
     "RenderResult",
     "TypstDirective",
@@ -22,7 +29,7 @@ __all__ = [
     "setup",
     "stage_field_library",
 ]
-__version__ = "0.2.3"
+__version__ = "0.2.4"
 
 STATIC_DIR = Path(__file__).parent / "static"
 
@@ -66,6 +73,9 @@ def setup(app):
     app.add_config_value("typst_render_preview", "svg", "env")
     app.add_config_value("typst_render_ppi", 144.0, "env")
     app.add_config_value("typst_render_stage_field_library", True, "env")
+    # Characters a generated text field accepts. Set to 0 to strip the limit
+    # entirely, which some readers mis-handle as zero, so it is opt in.
+    app.add_config_value("typst_render_field_max_length", DEFAULT_MAX_LENGTH, "env")
     # Headings inserted into the theme's download menu. The first names what
     # the page itself is, which differs per project: a manual, a chapter, a
     # page. An empty string leaves that group unlabelled.

{sphinx_typst_render-0.2.3 → sphinx_typst_render-0.2.4}/src/sphinx_typst_render/_compile.py

@@ -17,7 +17,12 @@ OUT_DIRNAME = "_typst"
 LIB_FILENAME = "capture_field.typ"
 
 #: Bumped whenever the output layout changes, to invalidate stale caches.
-_CACHE_VERSION = 2
+_CACHE_VERSION = 3
+
+#: Characters a generated text field accepts unless configured otherwise.
+#: Large enough that no worksheet answer reaches it, and written explicitly
+#: because some readers treat a missing /MaxLen as zero and refuse all input.
+DEFAULT_MAX_LENGTH = 10000
 
 
 @dataclass(frozen=True)
@@ -30,6 +35,9 @@ class RenderRequest:
     fillable: bool = False
     ppi: float | None = None
     preview_page: int = 1
+    #: Characters a text field accepts. 0 removes the limit entirely, which
+    #: some readers mis-handle as zero. See _apply_field_lengths.
+    max_length: int = DEFAULT_MAX_LENGTH
 
 
 @dataclass(frozen=True)
@@ -80,6 +88,7 @@ def _options(request: RenderRequest) -> dict[str, object]:
         "fillable": request.fillable,
         "ppi": request.ppi,
         "page": request.preview_page,
+        "max_length": request.max_length,
     }
 
 
@@ -115,33 +124,43 @@ def _fingerprint(request: RenderRequest) -> str:
     return digest.hexdigest()
 
 
-def _unbound_field_lengths(writer) -> None:
-    """Drop the character cap ReportLab puts on every text field.
+def _apply_field_lengths(writer, max_length: int) -> None:
+    """Set, or remove, the character cap on every text field.
+
+    Three behaviours are in play here. ReportLab's ``AcroForm.textfield()``
+    defaults to ``maxlen=100`` and typst-fillable does not override it, so a
+    field silently refuses input after 100 characters. Removing ``/MaxLen``
+    altogether is not safe either, because some readers treat a missing cap as
+    zero and then refuse all input. So the default is to write an explicit,
+    generous value, and ``max_length = 0`` drops the key for anyone who has
+    checked that their readers cope.
 
-    ``AcroForm.textfield()`` defaults to ``maxlen=100`` and typst-fillable does
-    not override it, so a field silently refuses input after 100 characters.
-    A worksheet answer box that stops mid-sentence is worse than useless, and
-    there is no sensible cap for one, so remove /MaxLen rather than raise it.
+    Only text fields are touched. A cap on a checkbox would be meaningless.
     """
+    from pypdf.generic import NameObject, NumberObject
+
     seen: set[int] = set()
 
-    def strip(obj) -> None:
+    def apply(obj) -> None:
         if obj is None or id(obj) in seen:
             return
         seen.add(id(obj))
-        if "/MaxLen" in obj:
-            del obj["/MaxLen"]
+        if obj.get("/FT") == "/Tx":
+            if max_length > 0:
+                obj[NameObject("/MaxLen")] = NumberObject(max_length)
+            elif "/MaxLen" in obj:
+                del obj["/MaxLen"]
         for kid in obj.get("/Kids", []) or []:
-            strip(kid.get_object())
+            apply(kid.get_object())
 
     for page in writer.pages:
         for annot in page.get("/Annots", []) or []:
-            strip(annot.get_object())
+            apply(annot.get_object())
 
     acroform = writer._root_object.get("/AcroForm")
     if acroform:
         for field in acroform.get("/Fields", []) or []:
-            strip(field.get_object())
+            apply(field.get_object())
 
 
 def _add_form_fields(base: bytes, request: RenderRequest) -> bytes:
@@ -178,7 +197,7 @@ def _add_form_fields(base: bytes, request: RenderRequest) -> bytes:
     for index, page in enumerate(reader.pages):
         if index < len(writer.pages):
             writer.pages[index].merge_page(page, over=False)
-    _unbound_field_lengths(writer)
+    _apply_field_lengths(writer, request.max_length)
     # Ask the reader to build field appearances, so a blank field is visible.
     writer.set_need_appearances_writer(True)
 

{sphinx_typst_render-0.2.3 → sphinx_typst_render-0.2.4}/src/sphinx_typst_render/_directive.py

@@ -50,6 +50,7 @@ class TypstDirective(SphinxDirective):
         "height": directives.length_or_unitless,
         "ppi": directives.positive_int,
         "page": directives.positive_int,
+        "max-length": directives.nonnegative_int,
         "class": directives.class_option,
     }
 
@@ -79,6 +80,9 @@ class TypstDirective(SphinxDirective):
             fillable="fillable" in self.options,
             ppi=self.options.get("ppi", config.typst_render_ppi),
             preview_page=self.options.get("page", 1),
+            max_length=self.options.get(
+                "max-length", config.typst_render_field_max_length
+            ),
         )
 
         # An inline preview has to be an image Sphinx can see, which means it