Refactor uncertainty calculator modules and update imports

FridrichMethod · FridrichMethod · commit ecb650d5a89c · 2026-03-15T23:48:55.000-07:00
Renamed and reorganized several modules for clarity and consistency:
- `parsing.py` is now `parsers.py`
- `rendering.py` is now `render.py`
- `types.py` is now `_types.py`
Additionally, updated all relevant imports across the codebase to reflect these changes. Removed obsolete `formatting.py` and `parsing.py` files to streamline the project structure. This refactor aims to enhance code organization and maintainability.
diff --git a/.cursor/rules/uncertainty-calculator.mdc b/.cursor/rules/uncertainty-calculator.mdc
@@ -7,11 +7,11 @@ alwaysApply: true
 
 - Keep the canonical flow: `parse_inputs()` -> `validate_inputs()` -> `compute()` -> `render_output()`.
 - Keep module boundaries strict:
-  - `parsing.py`: input normalization and symbol/value maps
+  - `parsers.py`: input normalization and symbol/value maps
   - `validation.py`: invalid/missing symbol checks
   - `compute.py`: derivatives and uncertainty propagation math
-  - `rendering.py`: LaTeX assembly and layout modes
-  - `formatting.py`: shared SymPy-to-LaTeX helper wrappers
+  - `render.py`: LaTeX assembly and layout modes
+  - `format.py`: shared SymPy-to-LaTeX helper wrappers
 
 ## Safety and Compatibility
 
diff --git a/AGENTS.md b/AGENTS.md
@@ -9,10 +9,10 @@
 
 ## Core Pipeline (Do Not Bypass)
 
-1. `parse_inputs()` in `src/uncertainty_calculator/parsing.py`
+1. `parse_inputs()` in `src/uncertainty_calculator/parsers.py`
 2. `validate_inputs()` in `src/uncertainty_calculator/validation.py`
 3. `compute()` in `src/uncertainty_calculator/compute.py`
-4. `render_output()` in `src/uncertainty_calculator/rendering.py`
+4. `render_output()` in `src/uncertainty_calculator/render.py`
 
 Keep logic in the right layer. Prefer extending an existing stage over mixing concerns across modules.
 
@@ -25,11 +25,11 @@ Keep logic in the right layer. Prefer extending an existing stage over mixing co
 
 ## Module Ownership
 
-- `parsing.py`: normalize and map inputs into SymPy-friendly structures.
+- `parsers.py`: normalize and map inputs into SymPy-friendly structures.
 - `validation.py`: reject undefined or invalid symbolic references.
 - `compute.py`: derivatives and numeric uncertainty propagation.
-- `rendering.py`: LaTeX structure/format (combined vs separate, insert vs non-insert).
-- `formatting.py`: SymPy-to-LaTeX helper wrappers only.
+- `render.py`: LaTeX structure/format (combined vs separate, insert vs non-insert).
+- `format.py`: SymPy-to-LaTeX helper wrappers only.
 
 ## Change Rules
 
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -18,17 +18,17 @@ produce LaTeX that includes evaluated value and propagated uncertainty, plus opt
 
 ## Key Compatibility Constraints
 
-- Preserve the dataclass API in `src/uncertainty_calculator/types.py`.
+- Preserve the dataclass API in `src/uncertainty_calculator/_types.py`.
 - Preserve orchestration contract in `src/uncertainty_calculator/calculator.py`.
 - Treat output format as regression-sensitive; tests compare against legacy behavior.
 
 ## Where to Edit
 
-- Parsing or symbol mapping changes: `parsing.py`
+- Parsing or symbol mapping changes: `parsers.py`
 - Validation rules: `validation.py`
 - Derivative or uncertainty math: `compute.py`
-- LaTeX layout/output switches: `rendering.py`
-- LaTeX helper options: `formatting.py`
+- LaTeX layout/output switches: `render.py`
+- LaTeX helper options: `format.py`
 
 ## Test Discipline
 
diff --git a/README.md b/README.md
@@ -64,11 +64,11 @@ The calculator is designed to be used as a Python module. Below is a complete ex
 The core logic is organized by responsibility:
 
 - `calculator.py`: orchestrates the pipeline
-- `parsing.py`: builds symbols/mappings from inputs
+- `parsers.py`: builds symbols/mappings from inputs
 - `compute.py`: performs derivatives and numeric propagation
-- `rendering.py`: produces LaTeX output
-- `types.py`: input dataclasses and type aliases
-- `formatting.py` / `validation.py`: shared helpers
+- `render.py`: produces LaTeX output
+- `_types.py`: input dataclasses and type aliases
+- `format.py` / `validation.py`: shared helpers
 
 ### 1. Define the Equation
 
diff --git a/src/uncertainty_calculator/__init__.py b/src/uncertainty_calculator/__init__.py
@@ -1,7 +1,7 @@
 """Uncertainty Calculator Package."""
 
+from uncertainty_calculator._types import Digits, Equation, Variable, Variables
 from uncertainty_calculator.calculator import UncertaintyCalculator
-from uncertainty_calculator.types import Digits, Equation, LastUnit, Variable, Variables
 
-__version__ = "0.1.1"
-__all__ = ["Digits", "Equation", "LastUnit", "UncertaintyCalculator", "Variable", "Variables"]
+__version__ = "0.1.2"
+__all__ = ["Digits", "Equation", "UncertaintyCalculator", "Variable", "Variables"]
diff --git a/src/uncertainty_calculator/calculator.py b/src/uncertainty_calculator/calculator.py
@@ -4,8 +4,8 @@
 
 from uncertainty_calculator._types import Digits, Equation, Variables
 from uncertainty_calculator.compute import ComputeState, compute
-from uncertainty_calculator.parsing import ParseState, parse_inputs
-from uncertainty_calculator.rendering import RenderOptions, render_output
+from uncertainty_calculator.parsers import ParseState, parse_inputs
+from uncertainty_calculator.render import RenderOptions, render_output
 from uncertainty_calculator.validation import validate_inputs
 
 
diff --git a/src/uncertainty_calculator/compute.py b/src/uncertainty_calculator/compute.py
@@ -8,8 +8,8 @@
 from sympy import S, diff, simplify, sqrt
 
 from uncertainty_calculator._types import Digits
-from uncertainty_calculator.formatting import latex_number
-from uncertainty_calculator.parsing import ParseState
+from uncertainty_calculator.format import latex_number
+from uncertainty_calculator.parsers import ParseState
 
 
 @dataclass
diff --git a/src/uncertainty_calculator/format.py b/src/uncertainty_calculator/format.py
@@ -1,4 +1,4 @@
-"""Formatting helpers for LaTeX output."""
+"""Format helpers for LaTeX output."""
 
 from __future__ import annotations
 
diff --git a/src/uncertainty_calculator/parsers.py b/src/uncertainty_calculator/parsers.py
@@ -9,12 +9,12 @@
 from sympy import Symbol, symbols, sympify
 
 from uncertainty_calculator._types import Equation, Variables
-from uncertainty_calculator.formatting import latex_number
+from uncertainty_calculator.format import latex_number
 
 
 @dataclass
 class ParseState:
-    """Intermediate parsed inputs ready for computation/rendering."""
+    """Intermediate parsed inputs ready for computation/render."""
 
     symbols: list[Symbol]
     unc_symbols: list[Symbol]
diff --git a/src/uncertainty_calculator/render.py b/src/uncertainty_calculator/render.py
@@ -1,4 +1,4 @@
-"""Rendering helpers for the uncertainty calculator."""
+"""Render helpers for the uncertainty calculator."""
 
 from __future__ import annotations
 
@@ -7,13 +7,13 @@
 from dataclasses import dataclass
 
 from uncertainty_calculator.compute import ComputeState
-from uncertainty_calculator.formatting import latex_number, latex_symbol, latex_value
-from uncertainty_calculator.parsing import ParseState
+from uncertainty_calculator.format import latex_number, latex_symbol, latex_value
+from uncertainty_calculator.parsers import ParseState
 
 
 @dataclass
 class RenderOptions:
-    """Rendering configuration for the output."""
+    """Render configuration for the output."""
 
     last_unit: str | None
     separate: bool
diff --git a/src/uncertainty_calculator/validation.py b/src/uncertainty_calculator/validation.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from uncertainty_calculator.parsing import ParseState
+from uncertainty_calculator.parsers import ParseState
 
 
 def validate_inputs(parse_state: ParseState) -> None:
diff --git a/tests/test_compute.py b/tests/test_compute.py
@@ -7,7 +7,7 @@
 
 from uncertainty_calculator import Digits, Equation, Variable
 from uncertainty_calculator.compute import compute
-from uncertainty_calculator.parsing import parse_inputs
+from uncertainty_calculator.parsers import parse_inputs
 
 
 def _simple_parse_state(value: float, uncertainty: float = 0.1):
diff --git a/tests/test_format.py b/tests/test_format.py
@@ -1,11 +1,11 @@
 # pyright: reportMissingImports=false
-"""Tests for formatting helpers."""
+"""Tests for format helpers."""
 
 from __future__ import annotations
 
 from sympy import sympify
 
-from uncertainty_calculator.formatting import latex_number
+from uncertainty_calculator.format import latex_number
 
 
 def test_latex_number_basic_formatting():
diff --git a/tests/test_parsers.py b/tests/test_parsers.py
@@ -1,12 +1,12 @@
-"""Tests for parsing helpers."""
+"""Tests for parsers helpers."""
 
 from __future__ import annotations
 
 import pytest
 
 from tests.input_parsers import parse_equation, parse_variables
 from uncertainty_calculator import Equation, Variable
-from uncertainty_calculator.parsing import parse_inputs
+from uncertainty_calculator.parsers import parse_inputs
 
 
 def test_parse_equation_trims_and_builds_dataclass():
diff --git a/tests/test_render.py b/tests/test_render.py
@@ -1,12 +1,12 @@
 # pyright: reportMissingImports=false
-"""Tests for rendering helpers."""
+"""Tests for render helpers."""
 
 from __future__ import annotations
 
 from uncertainty_calculator import Digits, Equation, UncertaintyCalculator, Variable
 from uncertainty_calculator.compute import compute
-from uncertainty_calculator.parsing import parse_inputs
-from uncertainty_calculator.rendering import RenderOptions, render_output
+from uncertainty_calculator.parsers import parse_inputs
+from uncertainty_calculator.render import RenderOptions, render_output
 
 
 def _simple_parse_state(value: float, uncertainty: float = 0.1):
@@ -16,7 +16,7 @@ def _simple_parse_state(value: float, uncertainty: float = 0.1):
 
 
 def test_render_output_combined_contains_sigma_line():
-    """Combined rendering should include sigma line and equation alignment."""
+    """Combined render should include sigma line and equation alignment."""
     parse_state = _simple_parse_state(value=2.0, uncertainty=0.5)
     compute_state = compute(parse_state, digits=Digits(mu=2, sigma=2))
     options = RenderOptions(
@@ -30,7 +30,7 @@ def test_render_output_combined_contains_sigma_line():
 
 
 def test_zero_uncertainty_renders_sigma_without_empty_sqrt():
-    """Sigma rendering should short-circuit when uncertainties are zero."""
+    """Sigma render should short-circuit when uncertainties are zero."""
     digits = Digits(mu=2, sigma=2)
     calc = UncertaintyCalculator(
         digits=digits,

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-"""Formatting helpers for LaTeX output."""`
	`1`	`+"""Format helpers for LaTeX output."""`
`2`	`2`
`3`	`3`	`from __future__ import annotations`
`4`	`4`