refdef 0.2.0__tar.gz → 0.3.0__tar.gz

{refdef-0.2.0 → refdef-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: refdef
-Version: 0.2.0
+Version: 0.3.0
 Summary: Reference designations as strict, typed, immutable Python values: parse, check, print, number and order
 Project-URL: Repository, https://github.com/OleJBondahl/refdef
 Author: Ole Johan Bondahl

{refdef-0.2.0 → refdef-0.3.0}/docs/CHANGELOG.md

@@ -5,6 +5,10 @@ Every change to the public surface gets a line under Unreleased until the releas
 
 ## Unreleased
 
+## 0.3.0 (2026-10-24)
+
+- Export `LetterRule` and `ClassTable` from `refdef`.
+
 ## 0.2.0 (2026-10-23)
 
 - Add `lowest_free(taken, reserved=(), *, first=1)`: the lowest free number over plain ints.

{refdef-0.2.0 → refdef-0.3.0}/docs/api-snapshot.txt

@@ -7,6 +7,11 @@ class Aspect
 class ClassEntry(code: 'str', title: 'str') -> 'None'
     One class code with its title, the typical device of the class.
 
+class ClassTable(name: 'str', version: 'str', depth: 'int', entries: 'tuple[ClassEntry, ...]') -> 'None'
+    Versioned class entries; `depth` is how many leading letters of a code are looked up.
+
+    A caller passes its own table to a custom Scheme; `version` names the table, not the library.
+
 class Designation(levels: 'tuple[Level, ...]' = (), top: 'str' = '') -> 'None'
     A tuple of levels and an optional top node, built by the constructor and `child` only.
 
@@ -18,6 +23,11 @@ class Issue(code: 'IssueCode', subject: 'str', message: 'str') -> 'None'
 class IssueCode
     The 21 issue codes: the first 16 come from the readers, the last 5 from check.
 
+class LetterRule(min_count: 'int' = 1, max_count: 'int' = 3, never: 'frozenset[str]' = frozenset({'I', 'O'})) -> 'None'
+    How many letters a code has and which letters never appear.
+
+    A caller builds a custom Scheme with it; `Scheme.extend` checks that `never` holds A-Z letters.
+
 class Level(aspect: 'Aspect', code: 'str' = '', number: 'int | None' = None, label: 'str' = '') -> 'None'
     One step in a tree: letters and a number (`-K2`), a number alone (`+3`) or a label (`+ER`).
 

{refdef-0.2.0 → refdef-0.3.0}/docs/guide/class-table.md

@@ -33,3 +33,12 @@ stay barred and `extend` never lifts a letter. Any iterable of letters works; a
 strict = STANDARD.extend(never={"A"})
 print([i.code.value for i in check([parse("-A1", bare=P).value], strict)])   # ['never_letter', 'unknown_class']
 ```
+
+A caller who builds its own scheme passes its own `ClassTable` and `LetterRule`, both public from `refdef`.
+
+```python
+from refdef import Aspect, ClassEntry, ClassTable, LetterRule, Scheme
+table = ClassTable(name="plant", version="1", depth=1, entries=(ClassEntry("A", "valve"),))
+mine = Scheme("plant", frozenset({Aspect.PRODUCT}), LetterRule(1, 2, frozenset("IO")), table)
+print(mine.classes.get("AB").title)   # valve
+```

{refdef-0.2.0 → refdef-0.3.0}/docs/llms.txt

@@ -60,5 +60,7 @@ ChannelTag: a terminal with an optional address (refdef.plc), printed as the ter
 parse_address: reads a direct PLC address (refdef.plc), repairing outer whitespace and leading zeros with an issue each; text that is not one gives None and a NOT_ADDRESS issue.
 Scheme: what check tests against: the aspects that are on, a letter rule and a class table; extend returns a new scheme with project classes, aspects and further barred letters (never: any iterable of A-Z letters, not a str).
 ClassEntry: one class code with its title, the typical device of the class.
+ClassTable: versioned class entries with the lookup depth; get(code) returns the entry or None.
+LetterRule: how many letters a code has and which letters never appear.
 STANDARD: the shipped scheme (function, product and location on, one to three letters without I and O, the versioned standard class table).
 check: tests designations against a scheme and returns an issue for each finding, in order; it reads nothing but its scheme argument.

{refdef-0.2.0 → refdef-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "refdef"
-version = "0.2.0"
+version = "0.3.0"
 description = "Reference designations as strict, typed, immutable Python values: parse, check, print, number and order"
 readme = "README.md"
 requires-python = ">=3.14"

{refdef-0.2.0 → refdef-0.3.0}/src/refdef/__init__.py

@@ -8,16 +8,18 @@ from refdef.issues import Issue, IssueCode, Parsed
 from refdef.level import Aspect, Level
 from refdef.numbering import allocate, lowest_free, number_group
 from refdef.order import natural_key, sort_key
-from refdef.scheme import STANDARD, ClassEntry, Scheme
+from refdef.scheme import STANDARD, ClassEntry, ClassTable, LetterRule, Scheme
 from refdef.terminal import Signal, Terminal
 
 __all__ = [
     "STANDARD",
     "Aspect",
     "ClassEntry",
+    "ClassTable",
     "Designation",
     "Issue",
     "IssueCode",
+    "LetterRule",
     "Level",
     "Parsed",
     "Scheme",

{refdef-0.2.0 → refdef-0.3.0}/src/refdef/_api.py

@@ -9,9 +9,24 @@ import inspect
 DOORS: tuple[str, ...] = ("refdef", "refdef.plc")
 
 
+class _SortedSet:
+    """A set default whose repr lists its members sorted, so the hash seed never shows."""
+
+    def __init__(self, members: frozenset[object]) -> None:
+        self.text = "frozenset({" + ", ".join(repr(m) for m in sorted(members, key=repr)) + "})"
+
+    def __repr__(self) -> str:
+        return self.text
+
+
 def _signature(obj: object) -> str:
     """The signature as source text, so 3.14 and 3.15 print the same bytes."""
-    return str(inspect.signature(obj, annotation_format=annotationlib.Format.STRING))  # ty: ignore[invalid-argument-type] - obj is callable here
+    sig = inspect.signature(obj, annotation_format=annotationlib.Format.STRING)  # ty: ignore[invalid-argument-type] - obj is callable here
+    params = [
+        p.replace(default=_SortedSet(p.default)) if isinstance(p.default, frozenset) else p
+        for p in sig.parameters.values()
+    ]
+    return str(sig.replace(parameters=params))
 
 
 def _head(name: str, obj: object) -> str:

{refdef-0.2.0 → refdef-0.3.0}/src/refdef/scheme.py

@@ -10,7 +10,10 @@ from refdef.tables import standard as _standard
 
 @dataclass(frozen=True)
 class LetterRule:
-    """How many letters a code has and which letters never appear."""
+    """How many letters a code has and which letters never appear.
+
+    A caller builds a custom Scheme with it; `Scheme.extend` checks that `never` holds A-Z letters.
+    """
 
     min_count: int = 1
     max_count: int = 3
@@ -27,7 +30,10 @@ class ClassEntry:
 
 @dataclass(frozen=True)
 class ClassTable:
-    """Versioned class entries; `depth` is how many leading letters of a code are looked up."""
+    """Versioned class entries; `depth` is how many leading letters of a code are looked up.
+
+    A caller passes its own table to a custom Scheme; `version` names the table, not the library.
+    """
 
     name: str
     version: str

refdef-0.3.0/tests/test_scheme_export.py

@@ -0,0 +1,16 @@
+"""LetterRule and ClassTable are public names: a caller builds a Scheme from them."""
+
+import refdef
+from refdef import Aspect, ClassEntry, ClassTable, LetterRule, Scheme
+
+
+def test_letter_rule_and_class_table_are_exported():
+    assert "LetterRule" in refdef.__all__
+    assert "ClassTable" in refdef.__all__
+
+
+def test_a_scheme_built_from_exported_names_looks_up_its_entry():
+    table = ClassTable(name="t", version="1", depth=1, entries=(ClassEntry("A", "x"),))
+    scheme = Scheme("custom", frozenset({Aspect.PRODUCT}), LetterRule(1, 2, frozenset("I")), table)
+    assert scheme.classes.get("A") == ClassEntry("A", "x")
+    assert scheme.letters.never == frozenset("I")

{refdef-0.2.0 → refdef-0.3.0}/uv.lock

@@ -321,7 +321,7 @@ wheels = [
 
 [[package]]
 name = "refdef"
-version = "0.2.0"
+version = "0.3.0"
 source = { editable = "." }
 
 [package.dev-dependencies]