draftwright 0.2.13__tar.gz → 0.3.0__tar.gz

{draftwright-0.2.13 → draftwright-0.3.0}/CHANGELOG.md

@@ -1,5 +1,85 @@
 # Changelog
 
+## v0.3.0 — 2026-07-14
+
+**Breaking — feature-recogniser API renamed** (ADR 0013 / #568): *deliberate* breaks with
+**no compatibility aliases**, hence the minor bump. Only import paths and callable
+signatures change — but note this release also **changes drawing output**: new machined-
+feature callouts, corrected leader anchors, and a reoriented isometric (see Added / Fixed).
+
+### Added
+
+- **Machined-feature recognition — the #148 epic.** #135 deliberately handled only enclosed
+  rectangular through-slots; this broadens recognition, and each feature is recognised **and**
+  dimensioned **and** authorable (recognise + emit + declare, ADR 0011):
+  - **Blind slots + pockets** — floored recesses, `W × L × D DEEP` (#603).
+  - **Cross / intersecting slots** collapse into single continuous channels (#604).
+  - **Machined flats** on round stock — `{across} A/F` (#605).
+  - **Turned / circlip grooves** — `{width} WIDE × ø{floor}` (#606).
+  - **Slots / pockets in curved stock** — arc-bounded walls (#607).
+  - **Radiused-end (obround) slots** now report their **overall** length (#613).
+- **Chamfer callouts** — `C{leg}` / `{leg}×{angle}°` off each bevel (#560).
+- **Fillet radius callouts** — `R{radius}` off each rounded edge (#561).
+- **Plate / wall thickness** dimensions on multi-plate prismatics (#559).
+- **Prismatic step-position** dimensions locating each shoulder (#555).
+- **Countersink callouts** — `ø6 THRU ⌵ ø14 × 90°` (major-ø + included angle), like the
+  counterbore `⊔ ø.. ↧..` (#558). The countersink rides on `HoleRecord`/`HoleFeature`, so
+  grouping and the callout-width layout estimate account for it.
+- **Every recognised feature round-trips all three ADR-0011 surfaces (#574).** Beyond
+  detection, each feature now **emits** into the generated `--script` Sheet and is
+  **declarable** on the fluent `Sheet` surface — authored from scratch or read off a
+  build123d object: chamfer (#576), countersink (#575), plate (#577), step-position (#585),
+  fillet (#561), plus all the #148 features above.
+- **`draftwright.score.feature_census(part)`** — a per-kind recognised-feature census, a
+  measurement tool for tracking recognition coverage (#608).
+
+### Changed
+
+- **Feature recognisers renamed `find_`/`analyse_` → `recognise_`** and their
+  tuning/dependencies made keyword-only: `find_holes`→`recognise_holes`,
+  `find_bosses`→`recognise_bosses`, `find_hole_patterns`→`recognise_hole_patterns`,
+  `find_slots`→`recognise_slots`, `find_plates`→`recognise_plates`,
+  `find_chamfers`→`recognise_chamfers`, `find_turned_steps`→`recognise_turned_steps`,
+  `find_step_shoulders`→`recognise_step_shoulders`, `analyse_face_levels`→
+  `recognise_face_levels` (the last was also re-exported at top level as
+  `draftwright.analyse_face_levels` → now `draftwright.recognise_face_levels`).
+  Cylinder-analysis substrate (`analyse_cylinders`, `full_cylinders`,
+  `feature_diameters`) keeps its names.
+- **`recognise_step_shoulders` now returns `list[StepShoulder]`** (a frozen dataclass)
+  instead of raw `(axis, position)` tuples; `levels` is keyword-only.
+- **`recognise_turned_steps` now returns `list[TurnedStep]`** (empty for a non-turned
+  part) instead of `TurnedProfile | None`. `TurnedStep` gained an `axis` field (each step
+  is now a self-contained record); `TurnedProfile` remains only as a pipeline aggregate
+  (`TurnedProfile.from_steps(steps)`), no longer a recogniser return.
+- **`recognise_face_levels` now returns `list[FaceLevel]`** (a frozen `FaceLevel(z)`
+  record) instead of `list[float]`.
+- **Recognition record classes renamed to avoid clashing with the IR `Feature` types:**
+  `draftwright.recognition.HoleFeature` → `HoleRecord`, `BossFeature` → `BossRecord`
+  (the IR `draftwright.model.ir.HoleFeature`/`BossFeature` are unchanged).
+- **Page/scale sizing now reads the IR, not recognition records (ADR 0008 / #588).** The
+  part model is built up front and drives sheet sizing, so detected and declared parts share
+  one path and no recogniser record reaches the sheet estimators. Byte-identical to the old
+  estimators except a hole pattern that shares a machining spec with loose holes now sizes
+  separately (no phantom merged `N×`), which can shift a tightly-packed such part's layout.
+
+### Fixed
+
+- **Isometric view orientation (#620).** The iso camera viewed the *rear* (+Y) side against a
+  front-view orthographic set, mirroring asymmetric features; it now views from the same
+  front (−Y) / plan (+Z) / right (+X) combination.
+- **Chamfer leaders (#621)** anchor on the bevel-face centroid (the diagonal middle), not the
+  supporting plane's parametric origin (which projected to a corner/endpoint).
+- **Fillet leaders (#622)** anchor on the radius surface, not the face bounding-box centre
+  (which sat off the round, near the virtual sharp corner).
+- **Authored `ref_pts`-only dimensions** now render (with Z-strip sizing) (#562).
+- **Pitch-dim labels** are cleared off centrelines / bolt circles at creation time, not via
+  the repair loop (#129).
+
+### Removed
+
+- **`draftwright.features` compatibility module** — deleted. Import `recognise_slots`/
+  `Slot` from `draftwright.recognition` instead.
+
 ## v0.2.13 — 2026-07-09
 
 **Compose-then-pack is now the layout authority.** This patch finishes the

{draftwright-0.2.13 → draftwright-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: draftwright
-Version: 0.2.13
+Version: 0.3.0
 Summary: Automated technical-drawing generation for build123d
 Project-URL: Homepage, https://github.com/pzfreo/draftwright
 Project-URL: Repository, https://github.com/pzfreo/draftwright
@@ -682,7 +682,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: <3.15,>=3.10
-Requires-Dist: build123d-drafting-helpers>=0.13.0
+Requires-Dist: build123d-drafting-helpers>=0.13.1
 Requires-Dist: build123d<0.11,>=0.9.0; python_full_version < '3.13'
 Requires-Dist: build123d<0.12,>=0.11; python_full_version >= '3.13'
 Requires-Dist: numpy>=1.24

{draftwright-0.2.13 → draftwright-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "draftwright"
-version = "0.2.13"
+version = "0.3.0"
 description = "Automated technical-drawing generation for build123d"
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -17,7 +17,7 @@ dependencies = [
     # 3.13+. Mirrors pzfreo/build123d-mcp's dependency handling.
     "build123d>=0.9.0,<0.11 ; python_full_version < '3.13'",
     "build123d>=0.11,<0.12 ; python_full_version >= '3.13'",
-    "build123d-drafting-helpers>=0.13.0",
+    "build123d-drafting-helpers>=0.13.1",
     "numpy>=1.24",
     "reportlab>=4.0",
     "svglib>=1.5",
@@ -111,6 +111,7 @@ ignore = ["E501"]
 
 [dependency-groups]
 dev = [
+    "codespell>=2.3.0",
     "mypy>=2.1.0",
     "pytest>=8",
     "pytest-cov>=5",
@@ -119,6 +120,15 @@ dev = [
     "ruff>=0.4",
 ]
 
+[tool.codespell]
+# Spelling enforcement for the ADR 0013 contract (epic #584 WP3). Skips binary /
+# generated / vendored assets: STEP fixtures, the lockfile, fonts, git internals.
+skip = "*.stp,*.step,*.svg,*.dxf,*.pdf,uv.lock,.git,*.ttf,*.otf,src/draftwright/fonts/*"
+# Valid words/identifiers codespell's dictionary misflags (calibrated from a clean run):
+# `nd` a Dijkstra distance var, `tread` a real word (stair-tread faces), `accreting`
+# a real word, `testof` the `TestOf` class name, and the valid hyphenated re-* forms.
+ignore-words-list = "nd,tread,accreting,testof,re-using,re-declare,re-declared,re-declaring"
+
 [tool.uv]
 # On Python 3.13/3.14, build123d resolves to 0.11, whose OCP kernel is
 # cadquery-ocp-novtk (VTK dropped from the transitive tree — fine here, draftwright

{draftwright-0.2.13 → draftwright-0.3.0}/src/draftwright/__init__.py

@@ -23,7 +23,7 @@ from typing import TYPE_CHECKING
 # none of these names, so they stay sub-second instead of paying for the kernel
 # on every TAB press (#313). Each name maps to the submodule that provides it.
 _LAZY = {
-    "analyse_face_levels": "draftwright.analysis",
+    "recognise_face_levels": "draftwright.recognition",
     "dedup_diams": "draftwright.analysis",
     "build_drawing": "draftwright.builder",
     "generate_script": "draftwright.builder",
@@ -72,12 +72,13 @@ _sys.modules[__name__].__class__ = _DraftwrightModule
 
 
 if TYPE_CHECKING:  # static analysers / IDEs — no runtime import, no kernel cost
-    from draftwright.analysis import analyse_face_levels, dedup_diams
+    from draftwright.analysis import dedup_diams
     from draftwright.builder import build_drawing, generate_script, make_drawing
     from draftwright.drawing import Drawing, FeatureInfo
     from draftwright.export import fix_svg_page_size
     from draftwright.linting import lint_feature_coverage
     from draftwright.pmi import PmiRecord, extract_pmi
+    from draftwright.recognition import recognise_face_levels
     from draftwright.sheet import choose_scale
     from draftwright.sheet_dsl import Sheet
 
@@ -94,7 +95,7 @@ __all__ = [
     "FeatureInfo",
     "PmiRecord",
     "Sheet",
-    "analyse_face_levels",
+    "recognise_face_levels",
     "build_drawing",
     "choose_scale",
     "dedup_diams",

{draftwright-0.2.13 → draftwright-0.3.0}/src/draftwright/_core.py

@@ -31,6 +31,11 @@ from build123d_drafting.helpers import (
     format_drawing_scale,
 )
 
+# The model-neutral geometry primitives (`_END_ON`, `_xyz`, `HoleRef`, `_axis_letter`)
+# now live in the leaf `draftwright._geometry` so the IR waist (`model/`) can use them
+# without importing this stage-level grab-bag (ADR 0008; #584 WP2). Re-exported here for
+# the above-`_core` consumers (annotations/sheet/drawing/linting) that already import them.
+from draftwright._geometry import _END_ON, HoleRef, _axis_letter, _xyz  # noqa: F401
 from draftwright.fits import FitClass
 from draftwright.fonts import PLEX_MONO, PLEX_SANS_CONDENSED
 from draftwright.layout import _greedy_strip_1d, _solve_strip_1d
@@ -43,39 +48,6 @@ _MARGIN = 10.0
 
 _TB_CLEAR = _MARGIN + 1.0  # title-block inset: one extra mm over _MARGIN for clearance
 
-# The orthographic view a feature is dimensioned end-on in — the view normal to its
-# axis. Single source of truth shared by the planner (view choice) and the lint
-# coverage checks (where to look for a feature's dims). Orientation is data.
-_END_ON = {"x": "side", "y": "front", "z": "plan"}
-
-
-def _xyz(loc) -> tuple[float, float, float]:
-    """A build123d ``Vector`` (has ``.X/.Y/.Z``) or an ``(x, y, z)`` sequence → an
-    ``(x, y, z)`` float tuple. Shared by the detectors and the lint coverage checks
-    so the Vector-unpacking idiom lives in one place."""
-    if hasattr(loc, "X"):
-        return (loc.X, loc.Y, loc.Z)
-    x, y, z = loc
-    return (float(x), float(y), float(z))
-
-
-@dataclass(frozen=True)
-class HoleRef:
-    """A position-keyed reference to a hole — the IR-typed value the cover / hole-table
-    bookkeeping matches on, so the shared escalation never needs a recogniser ``Hole``
-    object (ADR 0008 Amendment 6). Built from any location via :meth:`of` (rounded, so
-    two references at the same position compare equal)."""
-
-    x: float
-    y: float
-    z: float
-
-    @classmethod
-    def of(cls, loc) -> HoleRef:
-        x, y, z = _xyz(loc)
-        return cls(round(x, 3), round(y, 3), round(z, 3))
-
-
 _FONT_SIZE = 3.0  # annotation text height (page-mm); the draft preset is built with this
 
 
@@ -161,14 +133,6 @@ def _text_width(text: str, font_size: float, font_path: str = PLEX_MONO) -> floa
     )
 
 
-def _axis_letter(obj) -> str:
-    """Letter (``"x"``/``"y"``/``"z"``) of ``obj.axis``'s dominant component.
-
-    ``obj`` is anything carrying an ``.axis`` 3-vector (a hole or a boss).
-    """
-    return max(zip("xyz", obj.axis, strict=True), key=lambda t: abs(t[1]))[0]
-
-
 _CONCENTRIC_TOL_MM = 0.5
 
 
@@ -506,12 +470,12 @@ class Analysis:
     bbox_max: float
     holes: list
     patterns: list
-    bosses: list  # external bosses (find_bosses), detected once — the one inventory (#244)
+    bosses: list  # external bosses (recognise_bosses), detected once — the one inventory (#244)
     slots: list
     z_diams: list[float]
     cross_diams: list[float]
     cyls: tuple[list, list]
-    prof: TurnedProfile | None  # turned step profile (find_turned_steps), detected once
+    prof: TurnedProfile | None  # turned step profile (recognise_turned_steps), detected once
     od_diam: float | None
     is_rotational: bool
     od_axis: str  # rotation/turning axis of a rotational part ("z" default; "x"/"y" #222)

draftwright-0.3.0/src/draftwright/_geometry.py

@@ -0,0 +1,50 @@
+"""Model-neutral geometry primitives — the leaf below both ``_core`` and ``model``.
+
+These four helpers read an axis / coordinate / position off a build123d object
+(or the IR) and carry no drawing, layout or page knowledge. They live here, not
+in :mod:`draftwright._core`, so the IR waist (:mod:`draftwright.model`) can use
+them without importing the stage-level drawing grab-bag (ADR 0008; #584 WP2).
+This module imports nothing from ``draftwright`` — it is the bottom of the DAG.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+# Axis letter -> the orthographic view a feature on that axis reads end-on in.
+_END_ON = {"x": "side", "y": "front", "z": "plan"}
+
+
+def _xyz(loc) -> tuple[float, float, float]:
+    """A build123d ``Vector`` (has ``.X/.Y/.Z``) or an ``(x, y, z)`` sequence → an
+    ``(x, y, z)`` float tuple. Shared by the detectors and the lint coverage checks
+    so the Vector-unpacking idiom lives in one place."""
+    if hasattr(loc, "X"):
+        return (loc.X, loc.Y, loc.Z)
+    x, y, z = loc
+    return (float(x), float(y), float(z))
+
+
+@dataclass(frozen=True)
+class HoleRef:
+    """A position-keyed reference to a hole — the IR-typed value the cover / hole-table
+    bookkeeping matches on, so the shared escalation never needs a recogniser ``Hole``
+    object (ADR 0008 Amendment 6). Built from any location via :meth:`of` (rounded, so
+    two references at the same position compare equal)."""
+
+    x: float
+    y: float
+    z: float
+
+    @classmethod
+    def of(cls, loc) -> HoleRef:
+        x, y, z = _xyz(loc)
+        return cls(round(x, 3), round(y, 3), round(z, 3))
+
+
+def _axis_letter(obj) -> str:
+    """Letter (``"x"``/``"y"``/``"z"``) of ``obj.axis``'s dominant component.
+
+    ``obj`` is anything carrying an ``.axis`` 3-vector (a hole or a boss).
+    """
+    return max(zip("xyz", obj.axis, strict=True), key=lambda t: abs(t[1]))[0]