Logging output auditor
SciTeX logging owns PS-220, the mandatory error rule for output in package source. SciTeX dev discovers the provider, invokes it, and reports findings. The rule definition and detector live in this package, so project audits and the AST linter apply the same policy.
The wheel advertises two entry points:
Group |
Name |
Factory |
|---|---|---|
|
|
|
|
|
|
The project factory supplies rule five-tuples and a checker accepting
(repo, violation_class, out, *, config=None). The linter factory constructs
Rule and Issue through the public scitex_dev.linter.spi only when the
plugin activates. Its checker opts into filepath metadata with
accepts_filepath=True; existing two-argument plugins retain their interface.
Importing SciTeX logging or its project factory does not import SciTeX dev.
Every authored Python file under src/ is in scope, including bundled directories
named tests, scripts, examples, or docs. Repository directories outside
src/ are outside this source policy. Builtin print, pprint, Rich console
printing, stdlib logger acquisition, and direct stdlib diagnostic calls fail.
JSON payloads, explicit file= streams, and content-rendering function names
do not exempt raw print. noqa, severity settings, category overrides,
disabled rules, and skip lists cannot weaken the error tier.
In a Git checkout the project auditor includes tracked and nonignored untracked
source, including hidden files and tracked files matching ignore patterns.
Ignored installed dependencies are excluded by Git rules without package-name
exceptions. Linked worktrees and projects nested in a repository use their own
src/ subtree. Outside Git (including source archives), every existing Python
file under src/ remains in scope. Inventory paths stay lexical so symlinks
cannot grant logger-backend ownership. Shell hooks retain changed-file scope;
native edits check the proposed target rather than the entire inventory.
Native hooks and the linter also check files reached through aliases into
src/, such as a legacy apps symlink. Resolving the source scope does not
grant backend ownership: allowance checks retain the original path. Native
hooks refuse an edit when its alias cannot be resolved.
Choose the logging primitive that matches the destination:
Destination |
Primitive |
|---|---|
Application diagnostics using its configured handlers |
|
Canonical stderr diagnostics isolated from embedding handlers |
|
Human results on stdout |
|
Exact protocol stdout |
|
Caller-owned protocol stream |
|
emit preserves a message without level prefixes and propagates write and
flush failures. Transport callers remain responsible for serialization.
See stream behavior for destination, capture, and
configuration behavior.
The detector parses source without importing it. It follows import and
assignment aliases, literal builtins.print access, literal getattr, and
Rich console constructor/method aliases within lexical scopes. Definition-time
expressions are scanned in their enclosing scope; comprehensions and local
bindings shadow outer aliases. Proved output fields are followed between
methods of the same class. Unrelated
methods named print, including the SciTeX plain-console adapter, are not
classified as builtin or Rich printing. Nonliteral dynamic imports, computed attribute
names, and runtime call-graph behavior are outside this static proof.
The logging implementation needs stdlib logging to implement its public API.
That is the sole backend allowance. It requires the declared distribution
name, the actual public getLogger wiring, the SciTeXLogger subclass, and
the logger setup statements. Each allowed call must then match an exact module,
lexical scope, and complete AST statement. Foreign symlink targets, copied
folder names, and diagnostics added to an allowed module do not acquire an
exemption. Backend code remains subject to the raw-print ban.
Older developer tooling cannot enforce mandatory filepath-aware plugins. Install the compatible logging/dev release pair when enabling this provider; missing or broken mandatory providers must fail visibly, rather than report a successful audit that skipped logging checks.
Install the development toolchain with the logging package:
uv pip install 'scitex-logging[dev]'
The development extra requires published scitex-dev 0.62.16 or later, with the mandatory provider and filepath contracts. Runtime logging does not import scitex-dev. Developer tooling discovers the logging-owned auditor, linter and hook providers through their registered entry points. Qualify candidate wheels in an isolated environment before publication; never label an unreleased checkout as an existing public version.
Logging’s runtime supports Python 3.9 and later. The optional Dev toolchain has additional dependencies with their own Python minimums; testing the logging runtime and provider interface on Python 3.9 does not establish that Dev’s entire dependency graph installs there.