Python Code Format
When to Use
Use this skill when the task involves Python code authoring, modification, or review and local style choices need to be made consistently.
Trigger it when the work touches:
- line wrapping, indentation, blank lines, or spacing
- naming
- comments or docstrings
- logging messages or user-facing error messages
- file, socket, or similar resource handling
- Python 3.12-specific style decisions
Do not use it for repository-wide Python version governance, CI, linter or formatter rollout, pre-commit setup, or broad refactors unrelated to the current task.
Baseline
Within this skill and its related reference documents, Python 3.12 is the language and style baseline.
This baseline applies only to the python-code-format skill system and its documents. It does not by itself declare a repository-wide Python upgrade or revise historical version statements elsewhere.
Workflow
- Confirm that the task is a Python writing, editing, or review task rather than unrelated repository policy work.
- Follow direct user instructions and any narrower task-local constraints first.
- Keep changes minimal and stay close to the surrounding code unless the task explicitly asks for a style correction.
- Apply the priority order below when multiple acceptable choices exist.
- Read
references/python-code-format-research.md whenever a specific rule, ambiguity, or edge case needs to be resolved.
- Prefer the option that both matches the reference and preserves local consistency with nearby code.
Priority Order
- Format and layout
- Naming
- Comments and docstrings
- Logging and runtime messages
- Python 3.12-specific style details
Boundaries
This skill does not:
- declare a repository-wide Python 3.12 migration
- revise historical version statements in unrelated documents
- introduce CI, linters, formatters, pre-commit hooks, or other automation
- justify unrelated bulk formatting or broad style-only refactors
Reference Guide
Use references/python-code-format-research.md as the detailed rule source.
Consult the relevant sections there for:
- line length, indentation, blank lines, and spaces
- shebang and string rules
- files, sockets, getters, and setters
- naming
- comments and docstrings
- Python 3.12 additions from PEP 701, PEP 695, and PEP 698
1---
2name: python-code-format
3description: Use when writing, editing, reviewing, or comparing Python code and task-local style decisions matter, especially for formatting, naming, docstrings, logging, resource handling, or Python 3.12-specific syntax choices.
4metadata:
5 source: https://skillmd.com/skills/zhuangwenhui/python-code-format
6---
7
8# Python Code Format
9
10## When to Use
11
12Use this skill when the task involves Python code authoring, modification, or review and local style choices need to be made consistently.
13
14Trigger it when the work touches:
15- line wrapping, indentation, blank lines, or spacing
16- naming
17- comments or docstrings
18- logging messages or user-facing error messages
19- file, socket, or similar resource handling
20- Python 3.12-specific style decisions
21
22Do not use it for repository-wide Python version governance, CI, linter or formatter rollout, pre-commit setup, or broad refactors unrelated to the current task.
23
24## Baseline
25
26Within this skill and its related reference documents, Python 3.12 is the language and style baseline.
27
28This baseline applies only to the `python-code-format` skill system and its documents. It does not by itself declare a repository-wide Python upgrade or revise historical version statements elsewhere.
29
30## Workflow
31
321. Confirm that the task is a Python writing, editing, or review task rather than unrelated repository policy work.
332. Follow direct user instructions and any narrower task-local constraints first.
343. Keep changes minimal and stay close to the surrounding code unless the task explicitly asks for a style correction.
354. Apply the priority order below when multiple acceptable choices exist.
365. Read `references/python-code-format-research.md` whenever a specific rule, ambiguity, or edge case needs to be resolved.
376. Prefer the option that both matches the reference and preserves local consistency with nearby code.
38
39## Priority Order
40
411. Format and layout
422. Naming
433. Comments and docstrings
444. Logging and runtime messages
455. Python 3.12-specific style details
46
47## Boundaries
48
49This skill does not:
50- declare a repository-wide Python 3.12 migration
51- revise historical version statements in unrelated documents
52- introduce CI, linters, formatters, pre-commit hooks, or other automation
53- justify unrelated bulk formatting or broad style-only refactors
54
55## Reference Guide
56
57Use `references/python-code-format-research.md` as the detailed rule source.
58
59Consult the relevant sections there for:
60- line length, indentation, blank lines, and spaces
61- shebang and string rules
62- files, sockets, getters, and setters
63- naming
64- comments and docstrings
65- Python 3.12 additions from PEP 701, PEP 695, and PEP 698