ym-handcalcs 0.1.0__tar.gz

ym_handcalcs-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ym_handcalcs-0.1.0/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: ym-handcalcs
+Version: 0.1.0
+Summary: ym_handcalcs: renders handcalcs to ReportLab, and the `_hc` block for ymprint.
+Author-email: Connor Ferster <connor@structuralpython.com>
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Dist: handcalcs>=2.0.0rc1
+Requires-Dist: reportlab>=4.5.1
+Project-URL: Homepage, https://github.com/StructuralPython/ym-handcalcs
+
+# ym-handcalcs
+
+Render [handcalcs](https://github.com/connorferster/handcalcs) calculations in
+[YMPrint](https://github.com/StructuralPython/ymprint) documents.
+
+ym-handcalcs is a handcalcs renderer that produces ReportLab flowables, plus the `_hc`
+block that puts them in a YMPrint document: write Python, get typeset calculations
+with symbolic, substituted and computed values.
+
+## Installation
+
+Install it with YMPrint's `hc` extra:
+
+```bash
+pip install "ymprint[hc]"
+```
+
+ym-handcalcs needs handcalcs 2.0, which is currently a pre-release. pip installs it
+automatically; uv only installs a pre-release you name, so add it with `--with`:
+
+```bash
+uv tool install "ymprint[hc]" --with "handcalcs>=2.0.0rc1"
+```
+
+YMPrint registers the `_hc` block automatically when ym-handcalcs is installed.
+
+## The `_hc` block
+
+```yaml
+_vars:
+  w_DL: 2.5
+  w_LL: 4.0
+
+Beam design:
+  - _hc: |
+      ## Factored load
+      L = 6.0  # span, m
+      w_f = 1.25 * w_DL + 1.5 * w_LL
+      M_f = w_f * L**2 / 8
+  - The factored moment is {{ M_f }} kN·m.
+```
+
+The source runs in the document's `_vars`, like a `_py` block: it can use values from
+`_vars` and earlier blocks, and later blocks (and `{{ }}` interpolation) can use its
+results. As in handcalcs, `## ...` comments are headings, `# ...` comments are prose,
+inline comments annotate their line, and `# hc:` commands work as usual.
+
+The value is either the source as a string, or a mapping:
+
+| Option | Default | Meaning |
+| --- | --- | --- |
+| `source` | (required) | The Python source to run and render. |
+| `theme_color` | `"#0B5F66"` | A dark `#RRGGBB` colour; the whole palette is derived from it. |
+| `base_size` | the document's body text size | Font size, in points, that every calc style scales from. |
+
+Give a block an id to use it more than once in a mapping: `_hc_loads`, `_hc_moment`.
+
+## Using the renderer directly
+
+The renderer works without YMPrint. It returns a ReportLab stylesheet and a story:
+
+```python
+from handcalcs import HandCalcs
+from ym_handcalcs import ReportLabRenderer, build_pdf
+from ym_handcalcs.fonts import ensure_dejavu_registered
+
+ensure_dejavu_registered()  # YMPrint registers the DejaVu fonts itself
+result = HandCalcs(renderer=ReportLabRenderer(theme_color="#7A1F1F"))("a = 2\nb = a * 3\n")
+result["story"]  # list of flowables
+build_pdf(result, "calcs.pdf", title="Calcs")
+
+# or straight to a PDF
+HandCalcs(renderer=ReportLabRenderer())("a = 2\nb = a * 3\n", destination="calcs.pdf")
+```
+
+## Development
+
+```bash
+uv sync
+uv run pytest
+```
+
+Regenerate the golden files with `HANDCALCS_UPDATE_GOLDEN=1 uv run pytest` and review the diff.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).
+

ym_handcalcs-0.1.0/README.md

@@ -0,0 +1,87 @@
+# ym-handcalcs
+
+Render [handcalcs](https://github.com/connorferster/handcalcs) calculations in
+[YMPrint](https://github.com/StructuralPython/ymprint) documents.
+
+ym-handcalcs is a handcalcs renderer that produces ReportLab flowables, plus the `_hc`
+block that puts them in a YMPrint document: write Python, get typeset calculations
+with symbolic, substituted and computed values.
+
+## Installation
+
+Install it with YMPrint's `hc` extra:
+
+```bash
+pip install "ymprint[hc]"
+```
+
+ym-handcalcs needs handcalcs 2.0, which is currently a pre-release. pip installs it
+automatically; uv only installs a pre-release you name, so add it with `--with`:
+
+```bash
+uv tool install "ymprint[hc]" --with "handcalcs>=2.0.0rc1"
+```
+
+YMPrint registers the `_hc` block automatically when ym-handcalcs is installed.
+
+## The `_hc` block
+
+```yaml
+_vars:
+  w_DL: 2.5
+  w_LL: 4.0
+
+Beam design:
+  - _hc: |
+      ## Factored load
+      L = 6.0  # span, m
+      w_f = 1.25 * w_DL + 1.5 * w_LL
+      M_f = w_f * L**2 / 8
+  - The factored moment is {{ M_f }} kN·m.
+```
+
+The source runs in the document's `_vars`, like a `_py` block: it can use values from
+`_vars` and earlier blocks, and later blocks (and `{{ }}` interpolation) can use its
+results. As in handcalcs, `## ...` comments are headings, `# ...` comments are prose,
+inline comments annotate their line, and `# hc:` commands work as usual.
+
+The value is either the source as a string, or a mapping:
+
+| Option | Default | Meaning |
+| --- | --- | --- |
+| `source` | (required) | The Python source to run and render. |
+| `theme_color` | `"#0B5F66"` | A dark `#RRGGBB` colour; the whole palette is derived from it. |
+| `base_size` | the document's body text size | Font size, in points, that every calc style scales from. |
+
+Give a block an id to use it more than once in a mapping: `_hc_loads`, `_hc_moment`.
+
+## Using the renderer directly
+
+The renderer works without YMPrint. It returns a ReportLab stylesheet and a story:
+
+```python
+from handcalcs import HandCalcs
+from ym_handcalcs import ReportLabRenderer, build_pdf
+from ym_handcalcs.fonts import ensure_dejavu_registered
+
+ensure_dejavu_registered()  # YMPrint registers the DejaVu fonts itself
+result = HandCalcs(renderer=ReportLabRenderer(theme_color="#7A1F1F"))("a = 2\nb = a * 3\n")
+result["story"]  # list of flowables
+build_pdf(result, "calcs.pdf", title="Calcs")
+
+# or straight to a PDF
+HandCalcs(renderer=ReportLabRenderer())("a = 2\nb = a * 3\n", destination="calcs.pdf")
+```
+
+## Development
+
+```bash
+uv sync
+uv run pytest
+```
+
+Regenerate the golden files with `HANDCALCS_UPDATE_GOLDEN=1 uv run pytest` and review the diff.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).

ym_handcalcs-0.1.0/pyproject.toml

@@ -0,0 +1,31 @@
+[project]
+name = "ym-handcalcs"
+dynamic = ["version", "description"]
+readme = "README.md"
+authors = [
+    { name = "Connor Ferster", email = "connor@structuralpython.com" }
+]
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.14"
+dependencies = [
+    "handcalcs>=2.0.0rc1",
+    "reportlab>=4.5.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/StructuralPython/ym-handcalcs"
+
+[build-system]
+requires = ["flit_core>=3.12,<4"]
+build-backend = "flit_core.buildapi"
+
+[tool.flit.module]
+name = "ym_handcalcs"
+
+[dependency-groups]
+dev = [
+    "numpy>=2.3.0",
+    "pytest>=9.0.3",
+    "ymprint>=0.6.0",
+]

ym_handcalcs-0.1.0/src/ym_handcalcs/__init__.py

@@ -0,0 +1,17 @@
+"""
+ym_handcalcs: renders handcalcs to ReportLab, and the `_hc` block for ymprint.
+
+    from handcalcs import HandCalcs
+    from ym_handcalcs import ReportLabRenderer
+
+    result = HandCalcs(renderer=ReportLabRenderer())(source)
+    result["stylesheet"]  # reportlab.lib.styles.StyleSheet1
+    result["story"]       # list of flowables
+"""
+__version__ = "0.1.0"
+
+from .fonts import Fonts, FontFamily, ensure_dejavu_registered
+from .styles import DEFAULT_THEME, Palette, build_stylesheet
+from .renderer import ReportLabRenderer
+from .pdf import build_pdf
+from .block import BLOCK_CODE, convert_hc_block

ym_handcalcs-0.1.0/src/ym_handcalcs/block.py

@@ -0,0 +1,75 @@
+"""
+The ``_hc`` ymprint block: runs Python source in the document's variables and
+renders it with handcalcs.
+
+    _hc: |
+      L = 6.0  # span
+      M = w * L**2 / 8
+
+    _hc_beam:
+      source: |
+        ...
+      theme_color: "#0B5F66"
+      base_size: 9.5
+
+Like ``_py``, the source runs in the document's ``_vars``, so it can use
+values from ``_vars`` and earlier blocks, and later blocks can use its results.
+ymprint registers this block itself when ym_handcalcs is installed
+(``pip install ymprint[hc]``).
+"""
+from __future__ import annotations
+
+from typing import Any
+
+from handcalcs import HandCalcs, get_option
+from handcalcs.parsing import line_values
+
+from .renderer import ReportLabRenderer
+
+BLOCK_CODE = "_hc"
+OPTIONS = {"source", "theme_color", "base_size"}
+
+
+def block_options(block_key: str, block_value: Any) -> dict:
+    """The block's options as a dict; a bare string is the source."""
+    if isinstance(block_value, str):
+        return {"source": block_value}
+    if not isinstance(block_value, dict) or "source" not in block_value:
+        raise ValueError(
+            f"{block_key}: expected the Python source as a string, or a mapping with a "
+            f"'source' key (and optionally {', '.join(sorted(OPTIONS - {'source'}))})."
+        )
+    unknown = set(block_value) - OPTIONS
+    if unknown:
+        raise ValueError(
+            f"{block_key}: unknown option(s) {', '.join(sorted(unknown))}. "
+            f"Choose from: {', '.join(sorted(OPTIONS))}."
+        )
+    return block_value
+
+
+def run_source(source: str, namespace: dict):
+    """Run 'source' in 'namespace'; returns the recorded line values (or None)."""
+    if not get_option("line_values", True):
+        exec(source, namespace)
+        return None
+    return line_values.run(source, namespace)
+
+
+def convert_hc_block(block_key: str, block_value: Any, context: dict) -> list:
+    options = block_options(block_key, block_value)
+    source = options["source"]
+    namespace = context["vars"]
+    try:
+        values = run_source(source, namespace)
+    except Exception as e:
+        # The author's own code raised: report it like a failing _py block.
+        from ymprint.errors import PythonBlockError
+
+        raise PythonBlockError(block_key, source, e) from e
+    renderer = ReportLabRenderer(
+        theme_color=options.get("theme_color"),
+        base_size=options.get("base_size", context["styles"]["ymprint"].body.size),
+    )
+    result = HandCalcs(renderer=renderer).render_run(source, namespace, values)
+    return list(result["story"])

ym_handcalcs-0.1.0/src/ym_handcalcs/breaking.py

@@ -0,0 +1,133 @@
+"""
+Math-aware line breaking for rendered paragraph markup.
+
+ReportLab breaks a paragraph at any space and never at a non-breaking space
+(U+00A0). ``ranked_breaks`` gives every space in a rendered expression a
+*rank*: low ranks are good places to break (before a top-level ``+`` or
+``and``), high ranks poor ones (inside nested brackets), and ``None`` never
+(the space after an operator, so an operator always starts the continuation
+line). ``with_breaks(markup, max_rank)`` keeps the spaces up to ``max_rank``
+and makes every other one non-breaking.
+
+The rank is ``bracket_depth * CLASSES + operator_class``, so every break
+outside brackets beats every break inside them, and within one bracket level
+looser-binding operators win:
+
+- class 0: relations, comparisons and boolean words (``=``, ``→``, ``<``,
+  ``≤``, ``and``, ``or``, ``in``, ``is``, ``not``) and the spaces between plain
+  words (block headers);
+- class 1: ``+``, ``-`` and the space after a comma (collections, arguments);
+- class 2: ``·``, ``/``, ``//``, ``%``.
+
+Tags (``<font color="...">``) are skipped, so their attribute spaces are never
+touched.
+"""
+from __future__ import annotations
+
+import re
+from typing import Optional
+
+NBSP = " "
+CLASSES = 3
+OPERATOR_CLASS = {
+    "=": 0, "→": 0, "and": 0, "or": 0, "in": 0, "is": 0, "not": 0,
+    "+": 1, "-": 1, "−": 1,
+    "·": 2, "/": 2, "//": 2, "%": 2, "*": 2,
+}
+OPENERS = "([{"
+CLOSERS = ")]}"
+
+
+def _visible(markup: str) -> list[tuple[int, str]]:
+    """``(index, char)`` for every character of ``markup`` outside a tag."""
+    chars, in_tag = [], False
+    for idx, char in enumerate(markup):
+        if char == "<":
+            in_tag = True
+        elif char == ">" and in_tag:
+            in_tag = False
+        elif not in_tag:
+            chars.append((idx, char))
+    return chars
+
+
+def _token_after(chars: list[tuple[int, str]], pos: int) -> str:
+    """The visible token (up to the next space) starting at ``chars[pos]``."""
+    token = []
+    for _, char in chars[pos:]:
+        if char in (" ", NBSP):
+            break
+        token.append(char)
+    return "".join(token)
+
+
+def ranked_breaks(markup: str) -> dict[int, Optional[int]]:
+    """Map the index of every visible space in ``markup`` to its break rank (or None)."""
+    chars = _visible(markup)
+    ranks: dict[int, Optional[int]] = {}
+    depth = 0
+    previous_token = ""
+    for pos, (idx, char) in enumerate(chars):
+        if char in OPENERS:
+            depth += 1
+        elif char in CLOSERS:
+            depth = max(0, depth - 1)
+        if char != " ":
+            continue
+        before = "".join(c for _, c in chars[max(0, pos - 3):pos])
+        token_before = previous_token
+        token_after = _token_after(chars, pos + 1)
+        previous_token = token_after
+        if token_before in OPERATOR_CLASS and not before.endswith(","):
+            ranks[idx] = None  # keep an operator with its right operand
+        elif token_after in OPERATOR_CLASS:
+            ranks[idx] = depth * CLASSES + OPERATOR_CLASS[token_after]
+        elif before.endswith(","):
+            ranks[idx] = depth * CLASSES + 1
+        else:
+            ranks[idx] = depth * CLASSES
+    return ranks
+
+
+def _first_token(markup: str) -> str:
+    chars = _visible(markup)
+    return _token_after(chars, 0)
+
+
+def max_rank(markup: str) -> int:
+    ranks = [rank for rank in ranked_breaks(markup).values() if rank is not None]
+    return max(ranks, default=0)
+
+
+def with_breaks(markup: str, allowed: int) -> str:
+    """Keep the spaces of rank <= ``allowed`` and make every other one non-breaking."""
+    ranks = ranked_breaks(markup)
+    out = list(markup)
+    for idx, rank in ranks.items():
+        if rank is None or rank > allowed:
+            out[idx] = NBSP
+    return "".join(out)
+
+
+def unbreakable(markup: str) -> str:
+    return with_breaks(markup, -1)
+
+
+_ITEM_SPLIT = re.compile(r", ")
+
+
+def elide_collections(markup: str, max_items: int = 10, edge: int = 3) -> str:
+    """
+    Shorten every bracketed collection with more than ``max_items`` items to its
+    first and last ``edge`` items around an ellipsis. Only collections whose
+    items contain no nested brackets or tags are touched.
+    """
+    def shorten(match: re.Match) -> str:
+        opener, body, closer = match.group(1), match.group(2), match.group(3)
+        items = _ITEM_SPLIT.split(body)
+        if len(items) <= max_items:
+            return match.group(0)
+        kept = items[:edge] + ["…"] + items[-edge:]
+        return f"{opener}{', '.join(kept)}{closer}"
+
+    return re.sub(r"([\[{(])([^\[\]{}()<>]*)([\]})])", shorten, markup)