cs-object 0.1.0__py3-none-any.whl

cs_object-0.1.0.dist-info/METADATA

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: cs-object
+Version: 0.1.0
+Summary: Constrained Python authoring and CalculationSourceObject JSON export
+Author: Viktar B
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/viktar-b/CalculationSourceObject
+Project-URL: Repository, https://github.com/viktar-b/CalculationSourceObject
+Project-URL: Issues, https://github.com/viktar-b/CalculationSourceObject/issues
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Dynamic: license-file
+
+# cs-object
+
+Author constrained `.cso.py` calculations with Python 3.11+. Runtime dependencies
+are the standard library only. Read [authoring](../../docs/authoring.md) before
+writing calculations and use [two-panel](../../examples/two-panel/README.md) for
+shared metadata and composed calls.
+
+## Install and run
+
+Install from PyPI with `python -m pip install cs-object`. The import package and
+module command remain `cso_python`.
+
+Follow [workspace setup](../../docs/development.md#setup) to build and install a
+wheel. Distribution metadata lives in [pyproject.toml](pyproject.toml).
+Use the interpreter containing that wheel:
+
+```sh
+python -m cso_python bindings examples/two-panel
+python -m cso_python execute examples/two-panel/estimate.cso.py \
+  --function estimate --input width=2
+```
+
+`bindings --check` checks generated interfaces without writing or executing
+calculations. `execute` returns a versioned execution response; `export` returns
+CSO JSON. Inspect `python -m cso_python --help` and each subcommand's `--help`
+for options. Paths resolve from the invoking directory. Authored output and
+operational messages go to stderr so stdout contains one JSON response.
+
+## Generated calculation bindings
+
+`cso bindings` derives an importable `_cso_bindings` package from your `.cso.py`
+definitions. Each generated `.py` module creates callable handles containing a
+relative source path, function name and interface fingerprint. Its `.pyi` stub
+provides keyword-only signatures and typed dictionaries of public results.
+Generation parses definitions without executing the authored calculations.
+
+Importing a handle does not run the calculation. Calling it captures dependencies,
+plans the invocation and records its execution. This keeps composed calculations
+in the document and execution evidence. The generation and planning paths share
+the same definition parser. An outdated interface raises `STALE_BINDINGS`.
+
+After workspace setup, run this ordinary Python consumer from the repository root:
+
+```sh
+"$PYTHON" -m cso_python bindings examples/two-panel
+(cd examples/two-panel && "$PYTHON" - <<'PY'
+from _cso_bindings.geometry import rectangle
+
+result = rectangle(width=2, height=3)
+print(result["area"])       # 6
+print(result["perimeter"])  # 10
+PY
+)
+```
+
+This uses the same calculation as the composed report. Successful execution
+alone does not establish source-to-document consistency; run `cso verify` or
+`cso pdf` for that check. See [authoring](../../docs/authoring.md#binding-generation-and-project-layout)
+for generation roots, source-control policy and regeneration rules.
+
+The generation workflow resembles [Convex's generated function references](https://docs.convex.dev/generated-api/api):
+application functions determine the generated interface that callers import.
+CSO handles invoke local calculations through its capture and execution pipeline.
+This analogy does not prescribe a Git policy. [Convex recommends committing its generated code](https://docs.convex.dev/understanding/best-practices/other-recommendations#check-generated-code-into-version-control)
+so a checkout can type-check immediately; this repository regenerates ignored
+bindings during setup and consumer preparation.
+
+A generated handle reuses its captured plan and compiled code while its supplied
+input names, source bytes and assets remain unchanged. Calls through one handle
+run serially because each call updates that handle's execution trace.
+
+Successful execution supplies observations; it does not establish formula
+consistency. Use [the verified CLI](../../packages/cso-cli/README.md) for that check.
+The captured path preflights local source and executes captured UTF-8 bytes.
+Older single-file exports retain the development exporter. This is trusted local
+calculation authoring, not isolation for hostile Python.
+
+## Code and checks
+
+[Public helpers](src/cso_python/__init__.py), [capture](src/cso_python/source.py),
+[definitions](src/cso_python/definitions.py), [planner](src/cso_python/planner.py),
+[execution](src/cso_python/execution.py) and [bindings](src/cso_python/bindings.py)
+implement the pipeline described in [the code map](../../docs/code-map.md).
+
+With the wheel installed, run `python -I tests/run.py` from this package directory.
+The tests use package-owned synthetic fixtures and temporary bindings; no root
+examples or Node are required. [Workspace integration](../../tests/integration/README.md)
+owns actual example, installed cross-package and PDF acceptance.

cs_object-0.1.0.dist-info/RECORD

@@ -0,0 +1,22 @@
+cs_object-0.1.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+cs_object-0.1.0.dist-info/licenses/NOTICE,sha256=_KptAkLL5OwSjpKOyrRWijZ5XHraYzPxJxy5Vwa_q7w,130
+cso_python/__init__.py,sha256=VD3LiyvawRRWJqp-GTB28aEj0UiUgSlIqJj5yi6p3B0,754
+cso_python/__main__.py,sha256=IJlb-VCV1Nde1noTXcUb-KgaQwlyZVJj5Mp8V-dZW9A,1667
+cso_python/annotations.py,sha256=nKURd-tO2X_ZNcLksZoJGu_rl6eZ-HeKoFed67DjMr0,2487
+cso_python/authoring.py,sha256=3XkwOAuQhAyD1tyB9TuFfsS2igi0yaa1LuIehs6tAuk,3189
+cso_python/bindings.py,sha256=QX7__16UKi2t23eK-C55B5-PHALXOaN2EwRhBRBeZ_g,6575
+cso_python/definitions.py,sha256=9EFg20p6FBeulcwRtUMjdPkfwsQFYl75WDZUxpGj7Sw,17475
+cso_python/describe.py,sha256=8VAj-yswsik6IdfFwSl_LJJkYgldOZgt5lTIKWTPioM,4871
+cso_python/execution.py,sha256=V7YmLXJZXZ1I24kLtj5h3B3TRefhBxyUDy5MG6akqLQ,21048
+cso_python/exporter.py,sha256=aiVMWSNcEObRwdNltbLM5d02bDc2lwPBy7NmpH5is68,27849
+cso_python/function_calls.py,sha256=GsyMvp5Hf03-OL5U992jmOZuy4YKkFqu5nt1o9PuEQw,2010
+cso_python/glyphs.py,sha256=qBI0pQyPFfuvcUhPrtQSMyERJKKo78gDDSJdLeI9uY4,3095
+cso_python/handles.py,sha256=IXF6xsmqP1wYeQ18DmRIDFRKmCcey0qcvvM0GKMjBTI,4489
+cso_python/notation.py,sha256=W0dtyBteWIT_MGTpObcnstk693h5wGJjeJEUZUypwCE,23559
+cso_python/planner.py,sha256=4ggKjS6szVjmymmWAMjV-PKJOrGPivslV72PL47LI7A,48992
+cso_python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cso_python/source.py,sha256=5XyBR-bg_Ko6_6NSewvLZEWHe9p3in9I_-HyQBoZgf0,23924
+cs_object-0.1.0.dist-info/METADATA,sha256=nzIpiW1-MyrY86-sRWeO6Cn5kpxVQHwrsZdE5NImT9Y,5018
+cs_object-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+cs_object-0.1.0.dist-info/top_level.txt,sha256=d42-Q7iIyL8QUCFFlzie3HqwheLVPbjZRLAaWQSQjOE,11
+cs_object-0.1.0.dist-info/RECORD,,

cs_object-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

cs_object-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

cs_object-0.1.0.dist-info/licenses/NOTICE

@@ -0,0 +1,4 @@
+CalculationSourceObject
+Copyright 2026 Viktar Beliakou
+
+Third-party components retain their own licenses and attribution notices.

cs_object-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+cso_python

cso_python/__init__.py

@@ -0,0 +1,38 @@
+"""Public authoring helpers for constrained .cso.py calculations."""
+
+from .authoring import (
+    CalculationFunction,
+    CalculationResults,
+    CalculationSpec,
+    SectionSpec,
+    SymbolSpec,
+    calculation,
+    document_section,
+    documented_result,
+    figure,
+    given,
+    section,
+    symbol,
+    text,
+)
+from .execution import calculation_call
+from .handles import CalculationHandle, load_calculation
+
+__all__ = [
+    "CalculationFunction",
+    "CalculationResults",
+    "CalculationSpec",
+    "SectionSpec",
+    "SymbolSpec",
+    "calculation",
+    "calculation_call",
+    "document_section",
+    "documented_result",
+    "figure",
+    "given",
+    "load_calculation",
+    "CalculationHandle",
+    "section",
+    "symbol",
+    "text",
+]

cso_python/__main__.py

@@ -0,0 +1,45 @@
+from __future__ import annotations
+
+import argparse
+import sys
+
+from .exporter import add_export_arguments, export_from_args
+
+
+def main(argv: list[str] | None = None) -> int:
+    arguments = sys.argv[1:] if argv is None else argv
+    if arguments and arguments[0] == "bindings":
+        from .bindings import bindings_from_argv
+        return bindings_from_argv(arguments[1:])
+    if arguments and arguments[0] == "execute":
+        from .execution import execute_from_argv
+
+        return execute_from_argv(arguments[1:])
+    if arguments and arguments[0] == "describe":
+        from .describe import describe_from_argv
+
+        return describe_from_argv(arguments[1:])
+    parser = argparse.ArgumentParser(
+        prog="python -m cso_python",
+        description="Author and export constrained Python calculations. Export is not numerical verification.",
+    )
+    commands = parser.add_subparsers(dest="command", required=True)
+    export = commands.add_parser(
+        "export",
+        help="Export CalculationSourceObject JSON without numerical verification.",
+        description="Export formulas and runtime results as CSO JSON; does not independently verify formulas.",
+    )
+    commands.add_parser(
+        "execute",
+        help="Capture source and emit execution evidence for core verification.",
+    )
+    commands.add_parser(
+        "describe", help="Describe a calculation without executing authored code."
+    )
+    commands.add_parser("bindings", help="Generate typed calculation handles")
+    add_export_arguments(export)
+    return export_from_args(parser.parse_args(argv))
+
+
+if __name__ == "__main__":
+    raise SystemExit(main(sys.argv[1:]))

cso_python/annotations.py

@@ -0,0 +1,81 @@
+"""Resolve numeric annotation metadata from syntax, without evaluating authored code."""
+
+from __future__ import annotations
+
+import ast
+from dataclasses import dataclass
+
+from .source import Json, SourceError, authoring_name, kwargs, span
+
+
+@dataclass(frozen=True)
+class Annotation:
+    numeric_type: str
+    metadata: Json | None = None
+
+
+def annotation(
+    node: ast.expr, module: str, aliases: dict[str, Annotation]
+) -> Annotation:
+    if isinstance(node, ast.Name):
+        if node.id in ("float", "int"):
+            return Annotation(node.id)
+        if node.id in aliases:
+            return aliases[node.id]
+    if (
+        isinstance(node, ast.Subscript)
+        and authoring_name(node.value) == "Annotated"
+        and isinstance(node.slice, ast.Tuple)
+        and len(node.slice.elts) == 2
+        and isinstance(node.slice.elts[1], ast.Call)
+        and authoring_name(node.slice.elts[1].func) == "symbol"
+    ):
+        base = annotation(node.slice.elts[0], module, aliases)
+        if base.metadata is not None:
+            raise SourceError(
+                "AMBIGUOUS_METADATA",
+                "Only one symbol metadata declaration is allowed",
+                location=span(module, node),
+            )
+        spec = kwargs(
+            node.slice.elts[1],
+            module,
+            {
+                "id",
+                "root_key",
+                "glyph",
+                "description",
+                "unit",
+                "comment",
+                "notation_scope",
+            },
+            {"glyph", "description", "unit"},
+        )
+        return Annotation(base.numeric_type, spec)
+    raise SourceError(
+        "UNSUPPORTED_SIGNATURE",
+        "Expected float, int or an Annotated numeric alias",
+        location=span(module, node),
+    )
+
+
+def symbol_annotation(
+    node: ast.AnnAssign, module: str, aliases: dict[str, Annotation]
+) -> Annotation:
+    try:
+        declared = annotation(node.annotation, module, aliases)
+    except SourceError as error:
+        if error.diagnostic["code"] != "UNSUPPORTED_SIGNATURE":
+            raise
+        raise SourceError(
+            "MISSING_METADATA",
+            "Use Annotated numeric symbol metadata",
+            location=span(module, node),
+        ) from error
+    if declared.metadata is None:
+        raise SourceError(
+            "MISSING_METADATA",
+            "Annotated calculations require symbol metadata",
+            location=span(module, node),
+        )
+    return declared

cso_python/authoring.py

@@ -0,0 +1,128 @@
+from __future__ import annotations
+
+from collections.abc import Callable
+from contextlib import contextmanager
+from dataclasses import dataclass, field
+from typing import Any, TypeAlias, TypeVar
+
+CalculationResults: TypeAlias = dict[str, float]
+CalculationFunction: TypeAlias = Callable[..., CalculationResults]
+_Function = TypeVar("_Function", bound=CalculationFunction)
+
+
+@dataclass(frozen=True)
+class CalculationSpec:
+    id: str
+    title: str
+    schema_version: str
+    metadata: dict[str, Any] = field(default_factory=dict)
+
+
+@dataclass(frozen=True)
+class SectionSpec:
+    title: str
+    id: str | None = None
+    root: bool = False
+    metadata: dict[str, Any] = field(default_factory=dict)
+
+
+@dataclass(frozen=True)
+class SymbolSpec:
+    glyph: str
+    description: str
+    unit: str
+    comment: str = ""
+    id: str | None = None
+    root_key: str | None = None
+    notation_scope: str | None = None
+
+
+def calculation(
+    *,
+    id: str,
+    title: str,
+    schema_version: str = "1.0.0",
+    metadata: dict[str, Any] | None = None,
+) -> Callable[[_Function], _Function]:
+    """Attach CalculationSourceObject document metadata to a calculation function."""
+
+    def decorate(fn: _Function) -> _Function:
+        fn.__calculation_source__ = CalculationSpec(
+            id=id,
+            title=title,
+            schema_version=schema_version,
+            metadata=metadata or {},
+        )
+        return fn
+
+    return decorate
+
+
+def section(
+    *,
+    title: str,
+    id: str | None = None,
+    root: bool = False,
+    metadata: dict[str, Any] | None = None,
+) -> Callable[[_Function], _Function]:
+    """Attach CalculationSourceObject section metadata to a calculation function."""
+
+    def decorate(fn: _Function) -> _Function:
+        fn.__calculation_section__ = SectionSpec(
+            id=id,
+            title=title,
+            root=root,
+            metadata=metadata or {},
+        )
+        return fn
+
+    return decorate
+
+
+def symbol(
+    *,
+    glyph: str,
+    description: str,
+    unit: str,
+    comment: str = "",
+    id: str | None = None,
+    root_key: str | None = None,
+    notation_scope: str | None = None,
+) -> SymbolSpec:
+    """Declare CalculationSourceObject symbol metadata for source parsing."""
+
+    return SymbolSpec(
+        glyph=glyph,
+        description=description,
+        unit=unit,
+        comment=comment,
+        id=id,
+        root_key=root_key,
+        notation_scope=notation_scope,
+    )
+
+
+def given(value: float) -> float:
+    """Mark a literal input value while preserving normal Python execution."""
+
+    return value
+
+
+def documented_result(value: Any) -> Any:
+    """Mark a calculated value as an intentional FormulaSheet escape hatch."""
+
+    return value
+
+
+def text(*, id: str, content: str) -> None:
+    """Place literal review prose; the source parser retains its order."""
+
+
+def figure(*, id: str, path: str, media_type: str, caption: str, alt: str) -> None:
+    """Place a local figure; the source parser captures its asset identity."""
+
+
+@contextmanager
+def document_section(*, id: str, title: str, metadata: dict[str, Any] | None = None):
+    """Group one child level of calculation document content."""
+    yield