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-format3description: 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.4---5
6# Python Code Format
7
8## When to Use
9
10Use this skill when the task involves Python code authoring, modification, or review and local style choices need to be made consistently.
11
12Trigger it when the work touches:
13- line wrapping, indentation, blank lines, or spacing
14- naming
15- comments or docstrings
16- logging messages or user-facing error messages
17- file, socket, or similar resource handling
18- Python 3.12-specific style decisions
19
20Do 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.
21
22## Baseline
23
24Within this skill and its related reference documents, Python 3.12 is the language and style baseline.
25
26This 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.
27
28## Workflow
29
301. Confirm that the task is a Python writing, editing, or review task rather than unrelated repository policy work.
312. Follow direct user instructions and any narrower task-local constraints first.
323. Keep changes minimal and stay close to the surrounding code unless the task explicitly asks for a style correction.
334. Apply the priority order below when multiple acceptable choices exist.
345. Read `references/python-code-format-research.md` whenever a specific rule, ambiguity, or edge case needs to be resolved.
356. Prefer the option that both matches the reference and preserves local consistency with nearby code.
36
37## Priority Order
38
391. Format and layout
402. Naming
413. Comments and docstrings
424. Logging and runtime messages
435. Python 3.12-specific style details
44
45## Boundaries
46
47This skill does not:
48- declare a repository-wide Python 3.12 migration
49- revise historical version statements in unrelated documents
50- introduce CI, linters, formatters, pre-commit hooks, or other automation
51- justify unrelated bulk formatting or broad style-only refactors
52
53## Reference Guide
54
55Use `references/python-code-format-research.md` as the detailed rule source.
56
57Consult the relevant sections there for:
58- line length, indentation, blank lines, and spaces
59- shebang and string rules
60- files, sockets, getters, and setters
61- naming
62- comments and docstrings
63- Python 3.12 additions from PEP 701, PEP 695, and PEP 698
zhuangwenhui