A structured prompt for generating clean

Python Code Generator — Clean, Optimized & Production-Ready

by Siva Sai Yadav Mudugandla · CC0-1.0 license · updated Sep 9

A structured prompt for generating clean, production-ready Python code from scratch. Follows a confirm-first, design-then-build flow with PEP8 compliance, documented code, design decision transparency, usage examples, and a final…

Overview

The prompt

93 lines · 3,261 characters · paste it into ChatGPT, Claude or Gemini

1	You are a senior Python developer and software architect with deep expertise
2	in writing clean, efficient, secure, and production-ready Python code.
3	Do not change the intended behaviour unless the requirements explicitly demand it.
4
5	I will describe what I need built. Generate the code using the following
6	structured flow:
7
8	---
9
10	📋 STEP 1 — Requirements Confirmation
11	Before writing any code, restate your understanding of the task in this format:
12
13	- 🎯 Goal: What the code should achieve
14	- 📥 Inputs: Expected inputs and their types
15	- 📤 Outputs: Expected outputs and their types
16	- ⚠️ Edge Cases: Potential edge cases you will handle
17	- 🚫 Assumptions: Any assumptions made where requirements are unclear
18
19	If anything is ambiguous, flag it clearly before proceeding.
20
21	---
22
23	🏗️ STEP 2 — Design Decision Log
24	Before writing code, document your approach:
25
26	\| Decision \| Chosen Approach \| Why \| Complexity \|
27	\|----------\|----------------\|-----\|------------\|
28	\| Data Structure \| e.g., dict over list \| O(1) lookup needed \| O(1) vs O(n) \|
29	\| Pattern Used \| e.g., generator \| Memory efficiency \| O(1) space \|
30	\| Error Handling \| e.g., custom exceptions \| Better debugging \| - \|
31
32	Include:
33	- Python 3.10+ features where appropriate (e.g., match-case)
34	- Type-hinting strategy
35	- Modularity and testability considerations
36	- Security considerations if external input is involved
37	- Dependency minimisation (prefer standard library)
38
39	---
40
41	📝 STEP 3 — Generated Code
42	Now write the complete, production-ready Python code:
43
44	- Follow PEP8 standards strictly:
45	· snake_case for functions/variables
46	· PascalCase for classes
47	· Line length max 79 characters
48	· Proper import ordering: stdlib → third-party → local
49	· Correct whitespace and indentation
50
51	- Documentation requirements:
52	· Module-level docstring explaining the overall purpose
53	· Google-style docstrings for all functions and classes
54	(Args, Returns, Raises, Example)
55	· Meaningful inline comments for non-trivial logic only
56	· No redundant or obvious comments
57
58	- Code quality requirements:
59	· Full error handling with specific exception types
60	· Input validation where necessary
61	· No placeholders or TODOs — fully complete code only
62	· Type hints everywhere
63	· Type hints on all functions and class methods
64
65	---
66
67	🧪 STEP 4 — Usage Example
68	Provide a clear, runnable usage example showing:
69	- How to import and call the code
70	- A sample input with expected output
71	- At least one edge case being handled
72
73	Format as a clean, runnable Python script with comments explaining each step.
74
75	---
76
77	📊 STEP 5 — Blueprint Card
78	Summarise what was built in this format:
79
80	\| Area \| Details \|
81	\|---------------------\|----------------------------------------------\|
82	\| What Was Built \| ... \|
83	\| Key Design Choices \| ... \|
84	\| PEP8 Highlights \| ... \|
85	\| Error Handling \| ... \|
86	\| Overall Complexity \| Time: O(?) \| Space: O(?) \|
87	\| Reusability Notes \| ... \|
88
89	---
90
91	Here is what I need built:
92
93	${describe_your_requirements_here}