beancount-ast 0.0.1a2__tar.gz → 0.0.1a4__tar.gz

{beancount_ast-0.0.1a2 → beancount_ast-0.0.1a4}/.github/renovate.json

@@ -18,12 +18,6 @@
         "requires-python"
       ],
       "enabled": false
-    },
-    {
-      "matchDepNames": [
-        "beancount-parser"
-      ],
-      "enabled": false
     }
   ]
 }

{beancount_ast-0.0.1a2 → beancount_ast-0.0.1a4}/.gitignore

@@ -27,3 +27,4 @@ experiments/v3/arrow/*.arrow
 .env
 target
 uv.lock
+.envrc

{beancount_ast-0.0.1a2 → beancount_ast-0.0.1a4}/.pre-commit-config.yaml

@@ -15,7 +15,7 @@ repos:
         always_run: true
 
   - repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.24.1
+    rev: v0.25
     hooks:
       - id: validate-pyproject
         language: python
@@ -57,7 +57,7 @@ repos:
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.14.14
+    rev: v0.15.0
     hooks:
       # Run the linter.
       - id: ruff

{beancount_ast-0.0.1a2 → beancount_ast-0.0.1a4}/AGENTS.md

@@ -5,38 +5,33 @@
 - The Python API intentionally exposes the **parser AST** (directives + spans + raw tokens), not Beancount’s semantic `beancount.core` model.
 
 ## Key layout
-- `src/lib.rs`: the PyO3 module `beancount_ast._ast`.
+- `src/lib.rs`: PyO3 module `beancount_ast._ast`.
   - Registers all exposed Python classes in `#[pymodule(name = "_ast")]`.
-  - Converts Rust parser nodes (`beancount_parser::ast::*`) into `Py*` structs.
-  - Public Python entrypoints are `parse_string` and `parse_file`.
-- `py-src/beancount_ast/__init__.py`: re-exports symbols from `beancount_ast._ast`.
-- `py-src/beancount_ast/_ast.pyi`: stubs of `src/lib.rs`, when you change any interface, you should also update it.
-- `tests/test_parse_snapshots.py`: snapshot-style API tests using `pytest` + `syrupy`.
+  - Converts `beancount_parser::ast::*` nodes into `Py*` wrappers.
+  - Exposes `parse_string` and `parse_file` to Python.
+- `py-src/beancount_ast/__init__.py`: re-exports compiled `_ast` symbols and the `Directive` ABC for consumers.
+- `py-src/beancount_ast/_directive.py`: defines the `Directive` ABC and registers all directive classes.
+- `py-src/beancount_ast/_ast.pyi`: canonical type stubs mirroring the compiled `beancount_ast._ast` extension.
+- `tests/test_parse_snapshots.py`: snapshot-style API tests (`pytest` + `syrupy`).
 
 ## Workflows (local + CI-aligned)
-- Python deps / test env are managed with `uv` (see `.github/workflows/tests.yml`).
+- Running python tests.
   - Setup: `uv sync --dev --no-install-project`
-  - Run tests: `uv run pytest`
+  - Re-build module after any rust code change: `maturin develop --locked --release --uv -v`
+  - Run tests: `pytest`
 - Rust checks mirror CI (`.github/workflows/ci.yml`):
   - Format: `cargo fmt --all -- --check`
   - Lint: `cargo clippy --workspace --all-targets --all-features -- -D warnings`
 
 ## Conventions to follow when changing Rust bindings
-- Avoid `unwrap()` / `expect()`; the crate denies them (`src/lib.rs` has `#![deny(clippy::unwrap_used, clippy::expect_used)]`).
+- Avoid `unwrap()` / `expect()` / `unwrap_of_default()`; the crate denies them (`src/lib.rs` has `#![deny(clippy::unwrap_used, clippy::expect_used)]`), the error should be propagated to caller.
 - Python-facing data structures are thin, mostly immutable “record” types:
   - Define a `Py*` struct with `#[pyclass(..., get_all)]` and `pyderive` derives (`PyNew`, `PyRepr`, `PyStr`, and sometimes `PyEq`).
-  - If the type should appear in stubs, add `#[cfg_attr(feature = "stub-gen", ...gen_stub_pyclass)]`.
+  - when you update rust code, you should also update type stub.
 - When adding a new directive/type:
   1) Add the `Py*` struct.
   2) Register it in the `_ast` module init.
   3) Extend the conversion layer (e.g. `directive_to_py(...)`).
-  4) Update the `Directive` type alias used for stubs (see the `stub-gen` block at the end of `src/lib.rs`).
-
-## Stub generation
-- The stub generator binary is `src/bin/stub_gen.rs` and is only available with the `stub-gen` feature.
-- Typical command:
-  - `cargo run --bin stub_gen --features stub-gen`
-- The generated output updates `py-src/beancount_ast/_ast.pyi`.
 
 ## Formatting / linting
 - Non-code config formatting uses `dprint` (see `dprint.json`) and is enforced via pre-commit.