nmhit 0.1.4__tar.gz → 0.1.5__tar.gz

nmhit-0.1.5/.pre-commit-hooks.yaml

@@ -0,0 +1,10 @@
+- id: nmhit-format
+  name: nmhit-format
+  description: >-
+    Reformat NEML2-dialect HIT input files in place via nmhit's reparse/render
+    round-trip. Files without the `# neml2` dialect marker on their first
+    non-blank line are silently skipped.
+  entry: nmhit-format
+  language: python
+  files: \.i$
+  types: [text]

{nmhit-0.1.4 → nmhit-0.1.5}/CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.20)
 # Keep this version in sync with [project] version in pyproject.toml.
-project(neml2-hit VERSION 0.1.4 LANGUAGES CXX)
+project(neml2-hit VERSION 0.1.5 LANGUAGES CXX)
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)

{nmhit-0.1.4 → nmhit-0.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: nmhit
-Version: 0.1.4
+Version: 0.1.5
 Summary: Python bindings for the nmhit NEML2-flavored HIT parser
 License: MIT
 Classifier: Programming Language :: Python :: 3

{nmhit-0.1.4 → nmhit-0.1.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "scikit_build_core.build"
 
 [project]
 name = "nmhit"
-version = "0.1.4"  # Keep in sync with VERSION in CMakeLists.txt.
+version = "0.1.5"  # Keep in sync with VERSION in CMakeLists.txt.
 description = "Python bindings for the nmhit NEML2-flavored HIT parser"
 readme = "README.md"
 requires-python = ">=3.9"
@@ -18,6 +18,9 @@ classifiers = [
 [project.optional-dependencies]
 dev = ["pytest>=7"]
 
+[project.scripts]
+nmhit-format = "nmhit._cli:format_files"
+
 [tool.scikit-build]
 cmake.build-type = "Release"
 cmake.args = ["-DNMHIT_BUILD_TESTS=OFF", "-DNMHIT_BUILD_PYTHON=ON", "-DCMAKE_POSITION_INDEPENDENT_CODE=ON"]

nmhit-0.1.5/python/nmhit/_cli.py

@@ -0,0 +1,79 @@
+"""Command-line entry points for nmhit.
+
+Currently provides a single command, ``nmhit-format``, which reparses each
+input file with nmhit and writes the canonical render back in place. The
+intended use is as a pre-commit hook on NEML2-flavored HIT input files.
+
+Dialect opt-in
+--------------
+
+nmhit can parse plain MOOSE-HIT as well as NEML2-flavored HIT. To distinguish
+the two without ambiguity, NEML2 input files declare their dialect by writing
+the line ``# neml2`` as the first non-blank line of the file. The neml2-langserv
+VS Code extension uses the same marker to decide whether to attach. The
+formatter follows suit: files whose first non-blank line is not ``# neml2``
+are silently skipped, even if they match the hook's ``files:`` pattern.
+"""
+
+from __future__ import annotations
+
+import argparse
+import sys
+from pathlib import Path
+
+from . import parse_file
+
+DIALECT_MARKER = "# neml2"
+
+
+def _is_neml2(path: Path) -> bool:
+    """Return True iff the first non-blank line of *path* is exactly the
+    NEML2 dialect marker.
+    """
+    try:
+        with path.open() as f:
+            for line in f:
+                stripped = line.strip()
+                if not stripped:
+                    continue
+                return stripped == DIALECT_MARKER
+    except OSError:
+        return False
+    return False
+
+
+def format_files(argv: list[str] | None = None) -> int:
+    """Entry point for ``nmhit-format``.
+
+    Reparses each NEML2-marked input file and rewrites it in place if the
+    canonical render differs from the original. Returns 1 when any file was
+    modified (so the script exits non-zero under pre-commit, signalling that
+    a reformat happened and the commit should be retried), 0 otherwise.
+    """
+    parser = argparse.ArgumentParser(
+        prog="nmhit-format",
+        description=(
+            "Reformat NEML2-dialect HIT input files in place. Files without "
+            "the `# neml2` dialect marker on their first non-blank line are "
+            "skipped silently."
+        ),
+    )
+    parser.add_argument("files", nargs="+", help="HIT input files to format")
+    args = parser.parse_args(argv)
+
+    changed = 0
+    for arg in args.files:
+        path = Path(arg)
+        if not _is_neml2(path):
+            continue
+        src = path.read_text()
+        new = parse_file(path).render()
+        if new != src:
+            path.write_text(new)
+            print(f"reformatted {arg}", file=sys.stderr)
+            changed += 1
+    return 1 if changed else 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(format_files())