3tears-enforcement
Shared static-analysis enforcement scanners for the 3tears ecosystem.
What this package does
Each module under threetears.enforcement.<domain> ships an AST-based scanner that enforces a single architectural invariant across a Python source tree. Consumer repos import the scanner, inject their per-repo configuration (allowlists, exemption files, src roots), and run it from a thin pytest test class.
This replaces a previous pattern in which the same enforcement test files were vendored verbatim across multiple repos with manual sync requirements. The shared package eliminates duplication and drift while keeping per-repo configuration where it belongs.
Domains
Adopting
invalidation_listenerin a repo that already runs a local copy. Three things change, and only the first is obvious.
- The exemption format. The hub's pre-shared walker keyed by BARE MODULE PATH (
src/aibots/gateway/acl.py). The shared parser wants apath:line:symboltriple and rejects anything else withExemptionError, so an unmigrated file does not degrade -- it aborts the domain. Rewrite each entry as<path>:*:<registry-spelling>, keeping its# rationale:line.*means "any line in that file", which is what you want: keying an exemption to a line number silently stops matching when the line moves.minimum_live_registriesis yours to supply, and it is REQUIRED with no default. Count the L2-live registries your repo actually wires and put that number in the shell. It is the floor that makes a green report mean anything.- Repo-specific shell assertions do not come across. A local walker typically carries checks the shared domain has no equivalent for -- which processes must be in scope, that an L1-only registry is not dragged in, detector positive/negative cases. Those are yours to keep: port them into the thin shell rather than assuming the domain replaced them, because deleting the local file deletes them silently.
This note describes a one-time migration and should be deleted once every consumer has adopted the domain. Tracked as ENF-7WQ2 in the
14-eng-ai-botbacklog, which is this family's backlog of record -- not this repo's, so do not go looking for it here.
| Module | Invariant enforced |
|---|---|
cache |
Every stateful data surface routes through BaseCollection; no bespoke SQLiteBackend wrappers; no direct pool access to Collection-backed tables; every migration-defined table has a Collection class. |
underscore_access |
Underscore prefix is a stability contract: no cross-module private import, no cross-class protected access, modules with public names have __all__, no subclass shadowing of base private attributes, no __all__ listing private names. |
codebase_conventions |
No bare print(), no stdlib logging.getLogger (use threetears.observe), from __future__ import annotations required, return type annotations required. |
coercion_coverage |
Tool subclasses override execute, never run, preserving the normalize_kwargs → execute input-coercion path. |
dependency_alignment |
Declared dependencies match actual imports (no undeclared module-top sibling import, no declaration nothing imports); designated contracts packages import only stdlib, their own namespace, and configured extras; a package with a pinned DependencyFloor declares exactly the ruled hard-dependency list, no more and no fewer. |
dict_state_detection |
No raw dict/OrderedDict persistent state in __init__; use SQLiteBackend (L1) or NATS KV for shared state. |
invalidation_listener |
Every L2-live CollectionRegistry starts the cross-pod invalidation listener, and every start is paired with a stop. Carries a REQUIRED non-vacuity floor: a scan reaching nothing reports what a clean repo reports. |
logger_coverage |
Every production module declares a module-level log = get_logger(__name__) unless explicitly exempt. |
migration_yugabyte_safety |
Migration shapes are yugabyte-safe per threetears.core.data.migrations.enforcement. |
nats_wrapper_usage |
All nats-py imports route through threetears.nats.NatsClient; no direct import nats. |
no_silent_swallow |
Exception handlers must log, re-raise, or carry # NOSILENT: <reason>. |
no_stdlib_logging |
No production module imports stdlib logging directly; use threetears.observe. |
How to use it
Each domain exposes a configuration dataclass and a high-level runner:
# tests/enforcement/test_cache_primitive_usage.py
from pathlib import Path
from threetears.enforcement.cache import CacheEnforcementConfig, run_cache_enforcement
_CONFIG = CacheEnforcementConfig(
repo_root=Path(__file__).parents[2],
allowed_sqlite_construction_sites=frozenset({
"packages/registry/src/threetears/registry/l1_cache.py",
}),
collection_table_allowlist={
"memories": "MemoriesCollection",
# ... per-repo
},
migration_table_allowlist=frozenset({"_schema_migrations"}),
exemptions_path=Path(__file__).parent / "_cache_exemptions.txt",
enforcement_mode_env_var="CACHE_ENFORCEMENT_MODE",
)
class TestCachePrimitiveUsage:
def test_no_bespoke_sqlite_backend_construction(self) -> None:
run_cache_enforcement(_CONFIG, walker="sqlite_construction")
def test_no_bespoke_cache_wrapper_classes(self) -> None:
run_cache_enforcement(_CONFIG, walker="wrapper_class")
def test_no_direct_pool_access_to_collection_tables(self) -> None:
run_cache_enforcement(_CONFIG, walker="pool_access")
def test_all_tables_have_collections(self) -> None:
run_cache_enforcement(_CONFIG, walker="missing_collection")
Per-repo exemption files (e.g., _cache_exemptions.txt) stay in the consumer repo's tests/enforcement/ directory. The package's parse_exemptions_with_rationale reads them at test time.
How to onboard a new repo
- Add
3tears-enforcementas a dev dependency. - For each domain you want to enforce: create a thin shell test file at
tests/enforcement/test_<domain>.pyfollowing the pattern above. Inject your repo's allowlists/exemptions. - Create per-domain exemption files at
tests/enforcement/_<domain>_exemptions.txtif needed. Every exemption requires a preceding# rationale: <specific reason>line. - Run
pytest tests/enforcement/to verify the scanners work against your tree.
How to add a new enforcement domain
- Create
src/threetears/enforcement/<domain>/withwalkers.py,config.py,runner.py, and__init__.py. - Use
common/helpers (ast_helpers,collection_registry,repo_layout,pyproject_discovery,inheritance,exemptions,modes,violations,reports). Do not duplicate scaffolding. Two in particular, because both have already been re-implemented in this package rather than imported:ast_helpersowns the dotted-name spelling family --dotted,callee_names,receiver,argument_spellings. If you are about to write a loop that walks anast.Attributechain accumulating segments, it exists. Three copies of that walk shipped here before it was shared, each differing by one detail that turned out to be a parameter (dotted'sunwrap_subscriptis the survivor).collection_registryowns "whichCollectionRegistrynames are L2-live" -- take the answer from there rather than re-deriving it.CLIENT_SPELLINGSis a heuristic list that grows, so a second copy goes stale silently while still compiling.
- Walkers return
list[Violation]. Configs are frozen dataclasses. Runners orchestrate walker → exemption-application → mode-resolution → report. - Write unit tests in
tests/<domain>/. - Document the domain in this README.
Release files for 3tears-enforcement 0.49.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| 3tears_enforcement-0.49.0.tar.gz | 213.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| 3tears_enforcement-0.49.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 410.1 kB
Release files / 3tears_enforcement-0.49.0.tar.gz
| Download URL | 3tears_enforcement-0.49.0.tar.gz |
|---|---|
| Size | 213.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7959644f5bcd5907a9a880aeccb8fa82b44d1d282b067bf0a549c6d1874cf1db
|
|
BLAKE2b-256 checksum How to use checksums |
f12db14b3f806c7bacc9d68eafad831ecbcf817000874710188045584a47fe4c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.
Transparency logRelease files / 3tears_enforcement-0.49.0-py3-none-any.whl
| Download URL | 3tears_enforcement-0.49.0-py3-none-any.whl |
|---|---|
| Size | 197.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7364c279df4bf726cf1d01a3108e3f24d6204a618a363f10e6bb4909e884a980
|
|
BLAKE2b-256 checksum How to use checksums |
cc9b349ab50ed4bc6ac6c0e22467aa2568406176281226b1df96ebf0301d0146
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.
Transparency log