Merge pull request #65 from scikit-hep/ariostas/final_tweaks

chore: final tweaks before release

Author: ariostas

.pre-commit-config.yaml

@@ -5,7 +5,7 @@ ci:
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: check-added-large-files
       - id: check-case-conflict
@@ -19,7 +19,7 @@ repos:
       - id: trailing-whitespace
 
   - repo: https://github.com/mgedmin/check-manifest
-    rev: "0.50"
+    rev: "0.51"
     hooks:
       - id: check-manifest
         stages: [manual]
@@ -35,13 +35,13 @@ repos:
       - id: rst-directive-colons
 
   - repo: https://github.com/asottile/pyupgrade
-    rev: v3.19.1
+    rev: v3.21.0
     hooks:
       - id: pyupgrade
         args: [--py310-plus]
 
   - repo: https://github.com/asottile/setup-cfg-fmt
-    rev: v2.8.0
+    rev: v3.1.0
     hooks:
       - id: setup-cfg-fmt
         args: [--max-py-version=3.13, --include-version-classifiers]
@@ -80,7 +80,7 @@ repos:
   #      - id: oxipng
 
   - repo: https://github.com/python-jsonschema/check-jsonschema
-    rev: 0.33.0
+    rev: 0.34.1
     hooks:
       - id: check-github-workflows
       - id: check-github-actions
@@ -93,7 +93,7 @@ repos:
       - id: rm-unneeded-f-str
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.11.10"
+    rev: "v0.14.0"
     hooks:
       - id: ruff
         types_or: [python, pyi, jupyter]
@@ -103,7 +103,7 @@ repos:
         types_or: [python, pyi, jupyter]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: "v1.17.1"
+    rev: "v1.18.2"
     hooks:
       - id: mypy
         files: src

CHANGELOG.md

@@ -1,6 +1,27 @@
 # Changelog
 
-## 1.0.1 (16 Oct. 2025)
+## v1.0.1 (16 Oct. 2025)
 
-Complete overhaul of the parsing and conversion logic to improve reliability and maintainability.
-TODO
+This release provided significant bug fixes and cleanup with respect to the previous overhaul. The switch to Lark as the parsing backend and the internal AST were kept, but the code was significantly simplified and many issues were ironed out.
+
+### Breaking changes
+
+- A `numexpr` parsing bug was fixed, which had been present since the initial release of `formulate`. Bitwise operator precedence was changed, so some expressions will be interpreted differently, or fail to be parsed if they are not valid `numexpr` expressions. (See bug fixes section for more details.)
+- Some constant names were changed. In particular, very generic names are not assumed to be constants and will instead need more specific names. For example `c` is no longer interpreted as the speed of light, so `c_light` should be used instead. Constant names were taken from `hepunits` for consistency within Scikit-HEP.
+
+### Features and improvements
+
+- The CLI interface (which was briefly removed) was reintroduced.
+- Added dependency on `hepunits` in order to provide a useful set of constants.
+- Added methods to suggest fixes to parsing issues. These will be expanded in the future.
+
+### Bug fixes
+
+- ROOT parsing issues were resolved.
+- Various issues with constant and function conversions were resolved.
+- Bitwise operator precedence for `numexpr` expressions was fixed. An expression like `x > 1 & x < 3` was being parsed as `(x > 1) & (x < 3)` whereas `numexpr` would actually parse it as `x > (1 & x) < 3`.
+
+### Maintainability improvements
+
+- Added `lark` as a dependency, and moved away from standalone parsers. This simplifies the code and makes future adjustments to the grammar rules much easier.
+- Moved function and constant conversions into a central location instead of having them in each `to_*` function. Expressions are converted into a unified internal representation when they are parsed. This makes it easier to identify parsing and conversion issues.

docs/quickstart/whatsnew.rst

@@ -2,3 +2,4 @@ What's New
 =====================
 
 .. include:: ../../CHANGELOG.md
+   :parser: myst_parser.sphinx_

src/formulate/__init__.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import importlib.resources
 from typing import Any
 
 import lark
@@ -14,8 +15,6 @@
 
 
 def _get_parser(parser_type: str) -> lark.lark.Lark:
-    import importlib.resources
-
     grammar = (
         importlib.resources.files(__package__)
         / "resources"