Python import, packaging, and module boundaries
A tool-agnostic recipe to remove import cycles and make package exports and runtime discovery explicit. It supports a read-only audit and, when explicitly authorized, a narrow remediation.
When to use it
Use this recipe when the operator’s specific objective is to remove import cycles and make package exports and runtime discovery explicit. Prefer a narrower CVE, scanner-finding, security-audit, or compliance-evidence recipe when that is the operator’s actual job.
Inputs
- Repository root and the files, package, service, or module in scope.
- Requested mode:
auditor explicitly authorizedfix. - Supported runtime, compiler, framework, operating-system, and deployment versions inferred from repository files.
- Existing formatter, compiler, analyzer, test, build, and package-manager commands.
- Public API, compatibility, performance, generated-code, vendor, and migration constraints.
The prompt
You are running the Security Recipes code-hygiene workflow `code-hygiene.python.python-import-packaging-and-module-boundaries`.
Start read-only. Do not edit files until the operator explicitly authorizes a fix.
Use repository configuration and installed tool versions as authoritative; do not impose a new style or toolchain.
### Scope
Your bounded objective is to remove import cycles and make package exports and runtime discovery explicit.
Inspect only operator-scoped, first-party source and configuration. Exclude generated, vendored, minified, fixture snapshot, lock history, and migration history unless explicitly included.
### Detection
- Map imports, __init__ exports, entry points, namespace packages, import-time side effects, and optional extras.
- Distinguish type-only cycles from runtime cycles and plugin discovery.
- Record file and symbol evidence for every candidate. Mark uncertain or dynamically reachable behavior instead of guessing.
### Fix, only when authorized
- Move shared contracts to stable modules and make exports and optional boundaries explicit.
- Keep the diff limited to the proven issue and its focused tests. Preserve public behavior, API compatibility, and repository conventions.
- Do not add or broaden suppressions, weaken diagnostics, mass-format unrelated files, upgrade dependencies, or mutate external state.
### Verification
- Build wheels and sdists, install into a clean environment, import public modules, and run entry points.
- Compare diagnostic counts and relevant behavior before and after. Report every command, result, and check that could not run.
### Stop conditions
- Stop on undocumented plugin loading or packaging behavior not covered by a clean-install test.
- Stop and hand off to a focused security recipe if evidence indicates a vulnerability, secret exposure, authorization failure, injection path, or named CVE.
- Stop rather than widening scope when the safe result requires architecture, product, compliance, operational, or data-owner decisions.
Output contract
- Scope and repository evidence reviewed.
- A candidate table with file or symbol, evidence, confidence, and disposition.
- In audit mode: no edits, plus the smallest safe next action for each confirmed item.
- In fix mode: one bounded patch, focused regression coverage, and no unrelated cleanup.
- Commands run, results, remaining uncertainty, and any stop-condition handoff.
Verification
- Build wheels and sdists, install into a clean environment, import public modules, and run entry points.
- Confirm that diagnostic configuration, suppressions, public interfaces, generated files, vendored files, and dependencies did not change outside the authorized scope.
- Review the final diff for behavior changes and run the repository’s focused checks before broader suites.
Guardrails
- Read-only until edits are explicitly authorized.
- Do not deploy, publish, rotate secrets, alter cloud or database state, change CI permissions, or open external tickets.
- Do not hide debt by disabling rules, adding retries or sleeps, weakening tests, broadening ignores, or lowering warning levels.
- Treat generated, vendored, minified, migration-history, and fixture-snapshot files as out of scope unless explicitly named.
- Stop on undocumented plugin loading or packaging behavior not covered by a clean-install test.
Related recipes
- Python typing Any and ignore debt
- Python mutable-default, dataclass, and sentinel hygiene
- Browse all code-hygiene recipes
References
- NIST SP 800-218 Secure Software Development Framework 1.1 — NIST
- Python static typing documentation — Python Software Foundation
- Python asyncio coroutines and tasks — Python Software Foundation
- Python contextlib — Python Software Foundation
- Python import system — Python Software Foundation