Python代码规范参考
2026-04-09 09:31:33作者:仰钰奇
命名约定
- 函数名: 使用snake_case
- 类名: 使用CamelCase
- 常量: 使用全大写SNAKE_CASE
代码风格
- 每行代码不超过79个字符
- 使用4个空格缩进
- 函数和类之间空两行
#### 完善SKILL.md
```markdown
---
name: 代码质量审查助手
description: 分析Python代码质量问题,提供规范检查和改进建议
---
# 代码质量审查助手
## 功能说明
自动检测Python代码中的常见问题,包括未使用变量、硬编码敏感信息等,并提供符合PEP8规范的改进建议。
## 使用方法
1. 接收用户提供的Python代码或文件路径
2. 执行代码分析: `python scripts/code_analyzer.py <file>`
3. 参考`references/code_standards.md`生成规范建议
4. 输出结构化审查报告
💡 元数据优化:name和description字段决定Claude何时使用该技能,应包含关键触发词如"代码审查"、"Python"等。
思考点:如果要支持多种编程语言,这个技能架构需要如何调整?资源组织方式会有什么变化?
测试与验证:确保技能质量
1. 运行验证脚本
scripts/package_skill.py code-review-assistant
2. 手动测试流程
- 准备测试代码文件
test_code.py - 调用技能分析代码
- 验证输出是否符合预期
- 检查是否遗漏重要代码问题
3. 完善错误处理
增强脚本健壮性:
# 添加到code_analyzer.py
def analyze_code(code):
issues = []
try:
# 原有分析逻辑...
except Exception as e:
issues.append(f"分析过程出错: {str(e)}")
return issues
💡 测试技巧:创建包含各种常见问题的测试代码库,确保技能能识别不同类型的代码问题。
思考点:如何设计自动化测试来验证技能的有效性?需要考虑哪些测试场景?
打包发布:分享你的技能
1. 最终打包
scripts/package_skill.py code-review-assistant ./dist
打包成功后生成dist/code-review-assistant.zip文件。
2. 发布准备
- 编写技能使用示例
- 准备技能截图(如有)
- 撰写提交说明
3. 贡献到社区
通过项目的Pull Request流程提交你的技能,确保:
- 技能功能完整
- 文档清晰
- 代码无明显错误
常见问题解决
1. 技能元数据验证失败 ★☆☆
问题:打包时提示"YAML metadata missing required fields" 解决方案:
- 检查SKILL.md开头的YAML块
- 确保包含
name和description字段 - 使用在线YAML验证工具检查格式
2. 脚本执行权限问题 ★☆☆
问题:运行脚本时提示"Permission denied" 解决方案:
chmod +x code-review-assistant/scripts/code_analyzer.py
登录后查看全文
热门项目推荐
相关项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0148- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
auto-devAutoDev 是一个 AI 驱动的辅助编程插件。AutoDev 支持一键生成测试、代码、提交信息等,还能够与您的需求管理系统(例如Jira、Trello、Github Issue 等)直接对接。 在IDE 中,您只需简单点击,AutoDev 会根据您的需求自动为您生成代码。Kotlin03
Intern-S2-PreviewIntern-S2-Preview,这是一款高效的350亿参数科学多模态基础模型。除了常规的参数与数据规模扩展外,Intern-S2-Preview探索了任务扩展:通过提升科学任务的难度、多样性与覆盖范围,进一步释放模型能力。Python00
skillhubopenJiuwen 生态的 Skill 托管与分发开源方案,支持自建与可选 ClawHub 兼容。Python0111
热门内容推荐
最新内容推荐
项目优选
收起
暂无描述
Dockerfile
731
4.73 K
Ascend Extension for PyTorch
Python
609
786
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
1 K
1.01 K
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
433
392
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
145
237
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed.
Get Started
Rust
1.15 K
148
暂无简介
Dart
983
250
Oohos_react_native
React Native鸿蒙化仓库
C++
347
401
昇腾LLM分布式训练框架
Python
166
197
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.67 K
985