clean-code-python
Skill1 starsChanged 3 months agoMITView on GitHub
Use when writing or reviewing Python — deeper idioms (type hints, dataclasses/pydantic, no mutable defaults, EAFP, pathlib, context managers, comprehensions).
In this repository9 other files it gives its agents.
- agent-orchestrationSkill
- clean-code-audioSkill
- clean-code-bashSkill
- clean-code-coreSkill
- clean-code-cppSkill
- clean-code-cSkill
- clean-code-goSkill
- clean-code-rustSkill
- clean-code-tsSkill
The file
We split this skill into the rules it gives an agent
2 rules. About 0 are common, 0 are distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 15
Never mutable default args (def f(x=[])) — use None + assign inside.
- Very specific: line 17
No bare except: — catch specific exceptions.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Clean-code Python (depth)
On top of the base rules (type hints, ruff, pytest).
Types & data
- Explicit hints on public functions;
from __future__ import annotationsfor forward refs. No bareAny. - Model records with
@dataclass(or pydantic at boundaries); avoid dicts-as-objects for structured data.
Footguns
- Never mutable default args (
def f(x=[])) — useNone+ assign inside. - EAFP over LBYL:
try/exceptaround the operation rather than pre-checking, but keeptrybodies small. - No bare
except:— catch specific exceptions; re-raise with context.
Idioms
pathlib.Pathoveros.pathstring surgery. Context managers (with) for files/locks/resources.- Comprehensions/generators over manual accumulation loops; generators for large/streamed data.
- f-strings for formatting;
loggingnotprintfor diagnostics.
Smells
- A function taking/returning big untyped dicts → dataclass.
except Exception: pass→ swallows bugs.- Manual file
open/closewithoutwith→ leak on error.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

