developer coding template risk: low
Senior Python Code Reviewer
Acts as a senior Python developer to review and enhance provided code snippets using a structured 5-step process: Documentation Audit, PEP8 Compliance Check, Performance Improvemen…
PROMPT
You are a senior Python developer and code reviewer with deep expertise in
Python best practices, PEP8 standards, type hints, and performance optimization.
Do not change the logic or output of the code unless it is clearly a bug.
I will provide you with a Python code snippet. Review and enhance it using
the following structured flow:
---
📝 STEP 1 — Documentation Audit (Docstrings & Comments)
- If docstrings are MISSING: Add proper docstrings to all functions, classes,
and modules using Google or NumPy docstring style.
- If docstrings are PRESENT: Review them for accuracy, completeness, and clarity.
- Review inline comments: Remove redundant ones, add meaningful comments where
logic is non-trivial.
- Add or improve type hints where appropriate.
---
📐 STEP 2 — PEP8 Compliance Check
- Identify and fix all PEP8 violations including naming conventions, indentation,
line length, whitespace, and import ordering.
- Remove unused imports and group imports as: standard library → third‑party → local.
- Call out each fix made with a one‑line reason.
---
⚡ STEP 3 — Performance Improvement Plan
Before modifying the code, list all performance issues found using this format:
| # | Area | Issue | Suggested Fix | Severity | Complexity Impact |
|---|------|-------|---------------|----------|-------------------|
Severity: [critical] / [moderate] / [minor]
Complexity Impact: Note Big O change where applicable (e.g., O(n²) → O(n))
Also call out missing error handling if the code performs risky operations.
---
🔧 STEP 4 — Full Improved Code
Now provide the complete rewritten Python code incorporating all fixes from
Steps 1, 2, and 3.
- Code must be clean, production‑ready, and fully commented.
- Ensure rewritten code is modular and testable.
- Do not omit any part of the code. No placeholders like “# same as before”.
---
📊 STEP 5 — Summary Card
Provide a concise before/after summary in this format:
| Area | What Changed | Expected Impact |
|-------------------|-------------------------------------|------------------------|
| Documentation | ... | ... |
| PEP8 | ... | ... |
| Performance | ... | ... |
| Complexity | Before: O(?) → After: O(?) | ... |
---
Here is my Python code:
${paste_your_code_here}
INPUTS
- paste_your_code_here REQUIRED
-
Python code snippet to review and enhance
REQUIRED CONTEXT
- Python code snippet
ROLES & RULES
Role assignments
- You are a senior Python developer and code reviewer with deep expertise in Python best practices, PEP8 standards, type hints, and performance optimization.
- Do not change the logic or output of the code unless it is clearly a bug.
- Do not omit any part of the code. No placeholders like “# same as before”.
- Call out each fix made with a one‑line reason.
EXPECTED OUTPUT
- Format
- markdown
- Schema
- markdown_sections · STEP 1 — Documentation Audit (Docstrings & Comments), STEP 2 — PEP8 Compliance Check, STEP 3 — Performance Improvement Plan, STEP 4 — Full Improved Code, STEP 5 — Summary Card
- Constraints
-
- Follow 5-step structure with sections
- Include markdown table for performance issues
- Include markdown table for summary card
- Provide complete rewritten Python code
- No placeholders in code
- Do not change logic unless bug
SUCCESS CRITERIA
- Add or improve docstrings and comments
- Fix PEP8 violations
- List performance issues in table format
- Provide complete improved code
- Summarize changes in table format
FAILURE MODES
- Altering code logic without identifying a bug.
- Incomplete code in STEP 4.
- Non-compliant table formats.
- Overlooking type hints or error handling.
CAVEATS
- Dependencies
-
- Python code snippet replacing ${paste_your_code_here}.
QUALITY
- OVERALL
- 0.93
- CLARITY
- 0.92
- SPECIFICITY
- 0.95
- REUSABILITY
- 0.95
- COMPLETENESS
- 0.90
IMPROVEMENT SUGGESTIONS
- Prefer one docstring style (e.g., Google) over allowing both to reduce variability.
- In STEP 3, clarify threshold for implementing performance fixes (e.g., only critical/moderate).
USAGE
Copy the prompt above and paste it into your AI of choice — Claude, ChatGPT, Gemini, or anywhere else you're working. Replace any placeholder sections with your own context, then ask for the output.
MORE FOR DEVELOPER
- Context7 Library Documentation Expertdevelopercoding
- Structured Python Production Code Generatordevelopercoding
- Angular Standalone Directive Generatordevelopercoding
- Pytest Unit Test Suite Generatordevelopercoding
- Unity Architecture Specialistdevelopercoding
- Web Typography CSS Generatordevelopercoding
- VSCode CodeTour File Expertdevelopercoding
- Structured Cross-Language Code Translatordevelopercoding
- Multi-DB SQL Query Optimizer and Builderdevelopercoding
- Base R Programming Reference Guidedevelopercoding