| name | python-codebase-analysis |
| description | Analyzes a Python codebase and produces high-level recommendations for restructuring, refactoring, and alignment with modern best practices. Use when the user asks to analyze the codebase, audit code quality, suggest improvements, refactoring ideas, or assess maintainability, performance, testability, or technical debt. |
Python Codebase Analysis
Produce a structured analysis and recommendations report. Do not implement changes unless the user asks; focus on high-level findings and actionable suggestions.
Workflow
- Scope: Confirm or infer scope (whole repo, a package, or a path). Default to the project root.
- Explore: Scan layout (directories, key config files), entry points, tests, and docs. Use list_dir, grep, and semantic search; avoid reading every file.
- Assess: Evaluate each dimension below. Note evidence (file paths, patterns) and severity (critical / high / medium / low).
- Synthesize: Write the report using the output template. Prioritize by impact and effort; group related items.
Dimensions to Assess
1. Structure and layout
- Package/module boundaries: clear separation, no circular imports, src-layout vs flat.
- File and module size: modules > ~500–1000 lines; single-file "god" modules.
- Naming: consistent with language norms (e.g. Python: lowercase_with_underscores, TitleCase for classes).
- Dead or orphaned code: unused modules, commented-out blocks, unreachable branches.
- Duplication: copy-paste, similar logic that could be shared (DRY).
Evidence: Paths, line counts, import graphs if available.
2. Best practices alignment
Compare against project rules when present (e.g. .cursor/rules/python.mdc). Check:
- Naming (builtin shadowing, private
_ prefix, ALL_CAPS for module-level constants).
- Explicit checks vs exception-based control flow; falsy checks (
is None, len(x) == 0).
- Imports: top of file, grouped and sorted; no wildcard imports.
- Function shape: ≤3 positional args, keyword-only for the rest. Return an object rather than a tuple of many results.
- Constants: no magic numbers/strings; config or env for tunables.
- Error handling: narrow try/except; no bare except; logging over print in libraries.
- Public API: clear
__all__, py.typed for typed packages, separation of public vs _private.
- Library hygiene: use
logging.getLogger(__name__), never configure the root logger, set NullHandler in top-level __init__.py. No print() in library code (only in explicit CLI entry points). No sys.exit() in library code; raise exceptions instead.
- Error message quality: exceptions include enough context to diagnose (
ValueError("x must be positive, got -3") not ValueError("bad value")). Custom base exception class (e.g. class ReponameError(Exception)) so callers can catch library errors specifically. Appropriate use of warnings.warn() with DeprecationWarning/FutureWarning for planned changes.
- Encoding and I/O: explicit
encoding='utf-8' on open() calls (platform default varies). Consistent use of pathlib.Path over os.path string manipulation. Accept str | Path in public API. Context managers for all files and connections.
Evidence: Rule name or quote, example file:line or pattern. Grep for print(, sys.exit, sys.stdout, open( without encoding=, logging.basicConfig in non-CLI code.
3. Types and static checks
- Type coverage: annotations on public API and new code; use of
Any, untyped defs.
- Mypy (or equivalent): strictness, per-file overrides, global ignores.
- Linting: Ruff/Flake8/Pylint enabled; which rules; consistent formatting (e.g. Ruff format / Black).
- Docstrings: presence, format (e.g. Google), consistency with signatures and behavior.
Evidence: Config files, sample of annotated vs unannotated code.
4. Testing
- Structure: tests colocated or in
tests/; mirror of source layout; naming (test_*).
- Coverage: approximate line/branch coverage; untested modules or critical paths.
- Quality: one assertion per test; no tests that ignore results or swallow exceptions; use of parametrize/fixtures; independence and parallelizability.
- Gaps: missing edge cases, error paths, or integration tests for key flows.
Evidence: pytest.ini/pyproject.toml, coverage report or commands, example test file.
5. Performance and resource use
- Hot paths: unnecessary work in loops, repeated allocations, O(n²) or worse algorithms where it matters.
- I/O: blocking calls in async code; missing timeouts; large files read into memory.
- Caching: repeated computation or lookups that could be cached or memoized.
- Dependencies: heavy or unused libraries; optional features that could be lazy-loaded.
- Concurrency and thread safety: module-level mutable state (dicts, lists, caches) without locking. Lazy-initialized globals that are not thread-safe. Whether the library documents its thread-safety guarantees (or lack thereof). Reentrancy issues in functions that modify shared state.
Evidence: File:line or function name; no profiling required unless user provides data. Grep for module-level mutable assignments (e.g. _cache = {}, _registry = []).
6. Maintainability and extensibility
- Coupling: tight dependencies between modules; hard-coded dependencies instead of injection.
- Cohesion: modules/classes with a single responsibility; clear boundaries.
- Extensibility: adding features without editing many files; use of hooks, plugins, or strategy-style patterns where appropriate.
- Documentation quality: README accuracy (do install/usage instructions match the current API?). Sphinx build health (does it pass with
-W?). Public API coverage in docs (every public class/function in __all__ should appear in Sphinx automodule/autofunction). Broken cross-references or missing doc pages for public modules.
Evidence: Import structure, example functions or classes. Compare __all__ exports against Sphinx .. automodule directives. Check README examples against actual API.
7. Security and robustness
- Input validation: external input (CLI, files, env) validated at boundaries; no trust of caller data in libraries.
- Secrets: no credentials in code or logs; use of env or secret managers.
- Dependency hygiene: known vulnerable deps (
pip audit / Dependabot); pinned or minimum versions.
- Paths and execution: path traversal risks; subprocess/shell usage and injection.
Evidence: Grep for patterns (e.g. password, secret, eval, subprocess with shell=True).
8. Dependencies and tooling
- Declared deps: single source of truth (e.g.
pyproject.toml); optional groups (dev, docs).
- Version policy: minimum versions, avoidance of global pins for libraries.
- Tooling: consistent formatter and linter; CI runs checks and tests; no obsolete or conflicting config (e.g. both
setup.py and pyproject.toml without clear roles).
- CI/CD pipeline consistency: Python version matrix in CI matches
requires-python in pyproject.toml. CI runs the same checks as the local run-all-checks.sh (ruff, mypy, pytest, Sphinx, PyMarkdown). Publishing workflow present and correctly triggered (tag-based, Trusted Publishers or token auth).
- Configuration consistency: tool configs in
pyproject.toml (ruff, mypy, pytest) are consistent with each other and with project rules. No stale config sections for tools no longer used (e.g. [tool.black] or [tool.isort] when ruff handles both). Line-length and target-version settings agree across tools.
Evidence: pyproject.toml, requirements*.txt, CI config (.github/workflows/). Compare requires-python against CI matrix. Grep for stale [tool.*] sections.
9. Technical debt and risk
- Deprecations: use of deprecated APIs (stdlib, third-party); planned removals.
- Complexity: deeply nested conditionals; long functions; high cyclomatic complexity in critical code.
- TODOs/FIXMEs: concentration in one area; unlinked or vague items.
- Compatibility: Python version support; platform assumptions (e.g. paths, encoding).
Evidence: Grep for deprecation warnings, TODO/FIXME; example complex function.
10. Packaging and distribution
- Metadata completeness:
pyproject.toml has classifiers, project URLs (Homepage, Repository, Documentation), license expression (PEP 639), description, requires-python.
- Version single source of truth: one canonical version (
importlib.metadata, setuptools-scm, or _version.py); __version__ in the package is consistent.
- Build system: correct
[build-system] table; package installs cleanly with pip install -e .; no stale setup.py/setup.cfg alongside a complete pyproject.toml.
- Package contents:
__init__.py exports match the public API. py.typed marker present for typed packages. Correct [tool.setuptools.packages.find] or equivalent so subpackages and data files are included.
- Distribution hygiene: no build artifacts, test data, or large files accidentally included in the sdist/wheel.
.gitignore and/or MANIFEST.in configured appropriately.
Evidence: pyproject.toml metadata fields, pip install -e . output, py.typed presence, find_packages config. Compare __init__.py exports against __all__.
Output template
Use this structure for the report. Omit sections with no findings; keep each item concise with location and suggested direction.
# Codebase analysis: [project or path]
## Summary
[2–4 sentences: overall health, top 2–3 priorities.]
## 1. Structure and layout
- **Finding**: [what]. **Evidence**: [where]. **Suggestion**: [action].
[Repeat as needed.]
## 2. Best practices alignment
[Same pattern; reference project rules if present.]
## 3. Types and static checks
...
## 4. Testing
...
## 5. Performance and resource use
...
## 6. Maintainability and extensibility
...
## 7. Security and robustness
...
## 8. Dependencies and tooling
...
## 9. Technical debt and risk
...
## 10. Packaging and distribution
...
## Recommended priorities
1. [Highest impact, feasible first step]
2. [Next]
3. [Next]
Severity and wording
- Critical: Security or data integrity risk; blocks testing or deployment; pervasive violation of a core rule.
- High: Significant maintainability or bug risk; large refactor needed if left as-is.
- Medium: Clear improvement; can be scheduled with normal work.
- Low: Nice to have; style or minor consistency.
Use "Consider…", "Prefer…", "Avoid…" for suggestions. For critical/high, state the impact (e.g. "increases risk of…", "makes testing difficult because…").
Project-specific rules
If the repo contains a .cursor/rules/ directory, treat those rule files as the authoritative standard for the matching dimension. When a finding reinforces or contradicts a rule, cite the rule by filename; prefer referencing the rule file over repeating its text.
| Dimension(s) | Rule file(s) |
|---|
| 1 Structure and layout, 2 Best practices alignment, 3 Types and static checks, 9 Technical debt | python.mdc |
| 4 Testing | python_testing.mdc |
| 6 Maintainability (documentation quality) | doc_python.mdc, doc_readme.mdc, doc_user_guide.mdc, doc_dev_guide.mdc, doc_how_to.mdc — or run the critique-documentation skill for a deep documentation audit |
| 7 Security and robustness | security.mdc |
| 8 Dependencies and tooling, 10 Packaging and distribution | dependency_management.mdc, environment.mdc |
| Process (commits, pull requests, bug reports) | git_workflow.mdc, pull_request.mdc, bug_report.mdc |
| 2 Best practices (logging in library code) | logging.mdc, logging_nav.mdc |
| 2 Best practices, 5 Performance (transparent local/remote file I/O) | filecache.mdc |
Not every project ships every rule. If a referenced rule file does not exist, skip the corresponding part of the analysis rather than inventing a standard or reporting the rule's absence as a finding. In particular, the filecache and logging (and logging_nav) rules are project-specific and are frequently absent; when they are missing, ignore the file-access and logging-convention checks that depend on them.
Reference
For example findings and severity phrasing, see reference.md.
Scope and depth
- Prefer breadth first: touch all dimensions, then go deeper only where impact is high or the user asks.
- For large codebases, sample by package or layer (e.g. core vs CLI vs tests) and call out areas not reviewed.
- If the user asks for "quick" or "high-level" analysis, limit to summary + 1–2 findings per dimension and a short priority list.
