代码风格

写作 社区

技能解读

当前原文的自动摘译,尚未人工审校。

何时使用此技能

为新项目设置 linting 和格式设置 编写或审查文档字符串 建立团队编码标准 配置 ruff、mypy 或 Pyright 审查代码以确保风格一致性

1. 自动格式化

让工具处理格式争论。配置一次,自动执行。

2. 一致的命名

遵循 PEP 8 约定,使用有意义的描述性名称。

3. 文档即代码

文档字符串应该与它们描述的代码一起维护。

4. 类型注释

现代 Python 代码应包含所有公共 API 的类型提示。

流狐档案 运行与权限由流狐静态检查推断,不代表作者声明或实际测试结果。
领域
写作
作者声明的智能体
未找到明确声明;不据此推断已兼容或已测试
静态检查
88 / 100 · 启发式扫描,不代表运行安全
运行环境证据
未执行;当前没有隔离运行测试证据
作者 / 版本 / 许可证
@wshobson · 未声明许可证
上下文用量评级
低消耗
接入复杂程度
需简单配置
是否需要外部接口密钥
需要 · Vendor-specific
兼容的系统
未声明(默认跨平台)
运行环境要求
Python >=3.10
检测到的文件与系统行为
  • 只读
  • 允许写入 / 修改
  • 读取环境变量
网络行为
允许外网请求
安装命令数
无(仅作为资料)

需要注意: 未声明工具权限范围;实际权限由运行环境决定。

输出预览 python-code-style.preview
# Install modern tooling
pip install ruff mypy

# Configure in pyproject.toml
[tool.ruff]
line-length = 120
target-version = "py312"  # Adjust based on your project's minimum Python version

[tool.mypy]
strict = true

讨论

基于 GitHub Discussions。登录 GitHub 即可参与讨论、点赞、订阅更新。