ENH: mark @unevaluated arguments as non-sympy (#380)

* ENH: implement `unevaluated` with `dataclasses` * ENH: implement `__slots__` for non-sympy arguments * ENH: implement `pickle` support * ENH: do not overwrite `_eval_subs` if no non-sympy attributes
ComPWA · Dec 21, 2023 · e341327 · e341327
1 parent b76435c
commit e341327
Show file tree

Hide file tree

Showing 6 changed files with 217 additions and 90 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -49,6 +49,7 @@
 add_module_names = False
 api_github_repo = f"{ORGANIZATION}/{REPO_NAME}"
 api_target_substitutions: dict[str, str | tuple[str, str]] = {
+    "T": "TypeVar",
     "BuilderReturnType": ("obj", "ampform.dynamics.builder.BuilderReturnType"),
     "DecoratedClass": ("obj", "ampform.sympy.DecoratedClass"),
     "DecoratedExpr": ("obj", "ampform.sympy.DecoratedExpr"),

diff --git a/pyproject.toml b/pyproject.toml
@@ -328,6 +328,11 @@ task-tags = ["cspell"]
 [tool.ruff.isort]
 known-third-party = ["sympy"]
 
+[tool.ruff.lint.flake8-bugbear]
+extend-immutable-calls = [
+    "ampform.sympy._decorator.argument",
+]
+
 [tool.ruff.per-file-ignores]
 "**/docs/usage/sympy.ipynb" = ["E731"]
 "*.ipynb" = [

diff --git a/src/ampform/sympy/__init__.py b/src/ampform/sympy/__init__.py
@@ -1,6 +1,8 @@
 """Tools that facilitate in building :mod:`sympy` expressions.
 
 .. autodecorator:: unevaluated
+.. autofunction:: argument
+
 .. dropdown:: SymPy assumptions
 
     .. autodata:: ExprClass
@@ -30,6 +32,7 @@
 from ._decorator import (
     ExprClass,  # noqa: F401  # pyright: ignore[reportUnusedImport]
     SymPyAssumptions,  # noqa: F401  # pyright: ignore[reportUnusedImport]
+    argument,  # noqa: F401  # pyright: ignore[reportUnusedImport]
     unevaluated,  # noqa: F401  # pyright: ignore[reportUnusedImport]
 )