Python编码风格

A Python coding-style guide covering formatting, type annotations, immutable data, security checks, Pydantic update schemas, and asynchronous code.

In plain words
What is it for?
Use it when writing or reviewing Python code, especially code with schemas, shared state, security-sensitive inputs, database or file operations, and async services.
Why use it?
It helps prevent inconsistent code, accidental data changes, security problems, event-loop errors, and blocked asynchronous applications.

Cursor rule

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/nongjun/awesome-harness-engineering/python
Clone the repo
git clone --depth 1 https://github.com/nongjun/awesome-harness-engineering
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 527 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.00527
Opus 5 $0.00000 $0.00264
Sonnet 5 $0.00000 $0.00105
Haiku 4.5 $0.00000 $0.00053

Measured yesterday against content hash 8be61b8f4d9b, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

Python编码风格 scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

rules/Python编码风格.mdc · 45 lines

What it actually says

Python 编码风格

本文件以 Python 特定内容扩展通用编码风格规则。

规范

  • 遵循 PEP 8 规范
  • 所有函数签名使用类型注解

不可变性

优先使用不可变数据结构:dataclass 配合 frozen=True,或 typing.NamedTuple,以减少共享可变状态带来的副作用与竞态。

格式化

  • black 用于代码格式化
  • isort 用于导入排序
  • ruff 用于代码检查

安全

  • 使用 bandit 做静态安全分析:bandit -r .
  • 环境变量读取后校验非空,缺失时显式失败,不得静默继续

Pydantic Schema 继承

Update Schema 必须覆盖所有非 None 默认值字段:当 XxxUpdate 继承 XxxCreate 时,Create 中合理的默认值(gender="unknown"source="manual"tags=[])在 Update 语境下变成隐蔽的数据覆盖——前端不传该字段时,Pydantic 解析为默认值而非 None,下游 if value is not None 判断失效,执行了不该执行的更新。

规则:XxxUpdate 中所有可部分更新的字段都声明为 Optional[T] = None,不依赖继承。

asyncio 对象生命周期

asyncio.Lock / httpx.AsyncClient 禁止模块级创建:这些对象绑定创建时的 event loop。APScheduler 等调度器在独立线程创建新 loop 时,跨 loop 使用会报错。

统一模式:_get_xxx() 函数追踪 id(asyncio.get_running_loop()),loop 变化时重建。

异步陷阱

禁止 await 调用同步函数await sync_function() 不会报错但会阻塞 event loop,整个进程在该函数执行期间无法处理其他请求。同步数据库查询、文件 I/O 等耗时操作要么用 asyncio.to_thread() 包装,要么使用异步版本的库。

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 45 lines · 0 tokens per session scan A 8be61b8f4d9b

Subscribe to this mod's changes

Python编码风格 is a cursor rule published in the GitHub repository nongjun/awesome-harness-engineering (2 stars, last pushed 5mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 527 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.