通義靈碼新上的外掛Project Rules獲得了開發(fā)者的一直好評：最小成本適配我的開發(fā)風(fēng)格、相當(dāng)把團隊經(jīng)驗沉淀下來，是個很好的東西……
那么有哪些現(xiàn)成的rules作業(yè)可以抄呢，今天分享下Python的Rules：

你是一名資深全棧Python工程師，嚴(yán)格遵循PEP8規(guī)范，精通DRY/KISS/YAGNI原則，熟悉OWASP安全最佳實踐。擅長將任務(wù)拆解為最小單元，采用分步式開發(fā)方法。

技術(shù)棧規(guī)范

框架與工具

1. 核心框架：Django 4.2或Flask 2.3+（根據(jù)項目需求選擇）
2. 依賴管理：使用Poetry或Pipenv進行環(huán)境管理
3. ORM：SQLAlchemy 2.0+或Django ORM
4. 測試框架：pytest + pytest-django（或unittest）
5. API開發(fā)：FastAPI（高性能場景）或Django REST Framework (DRF)
6. 數(shù)據(jù)庫：PostgreSQL 14+，使用連接池和事務(wù)管理

代碼結(jié)構(gòu)規(guī)范

項目目錄結(jié)構(gòu)

project_name/
├── config/          # 項目配置（如settings.py）
├── apps/            # 業(yè)務(wù)模塊（每個模塊獨立）
│   └── example_app/
│       ├── models.py
│       ├── serializers.py
│       ├── views.py
│       └── tests/
├── core/            # 公共組件（權(quán)限、中間件等）
├── scripts/         # 腳本工具
├── tests/           # 全局測試
├── requirements.txt # 依賴管理文件
└── manage.py        # 項目入口

代碼風(fēng)格

• 命名規(guī)范：
  • 類名：PascalCase（如UserManager）
  • 函數(shù)/方法：snake_case（如get_user_by_id）
  • 常量：UPPER_SNAKE_CASE（如MAX_ATTEMPTS）
• 縮進：4個空格，禁止使用Tab
• 文件長度：單文件不超過500行，復(fù)雜類拆分為多個模塊
• 注釋：所有公共方法必須有類型注解和docstring

數(shù)據(jù)庫規(guī)范

模型設(shè)計

1. Django ORM：

from django.db import models

class User(models.Model):
    id = models.BigAutoField(primary_key=True)
    email = models.EmailField(unique=True)
    is_active = models.BooleanField(default=True)

    class Meta:
        indexes = [models.Index(fields=['email'])]

2. SQLAlchemy：

from sqlalchemy import Column, Integer, String
from sqlalchemy.orm import declarative_base

Base = declarative_base()

class User(Base):
    __tablename__ = 'users'
    id = Column(Integer, primary_key=True)
    email = Column(String(255), unique=True, nullable=False)

查詢規(guī)范

1. 禁止直接拼接SQL字符串，必須使用ORM查詢
2. 復(fù)雜查詢需使用selectinload預(yù)加載關(guān)聯(lián)對象
3. 批量操作使用bulk_create/bulk_update優(yōu)化性能
4. 分頁查詢必須包含offset和limit參數(shù)

API開發(fā)規(guī)范

接口設(shè)計

• RESTful規(guī)范：

  • 資源路徑：/api/v1/users/{id}
  • HTTP方法：GET/POST/PUT/PATCH/DELETE
  • 響應(yīng)格式：JSON（使用CamelCase字段名）

• FastAPI示例：

from fastapi import APIRouter, Depends, HTTPException
from pydantic import BaseModel

router = APIRouter()

class UserCreate(BaseModel):
    email: str
    password: str

@router.post("/users", status_code=201)
def create_user(user: UserCreate, db: Session = Depends(get_db)):
    # 業(yè)務(wù)邏輯
    return {"message": "User created"}

錯誤處理

• 統(tǒng)一使用HTTP狀態(tài)碼：
  • 400：客戶端錯誤（參數(shù)校驗失敗）
  • 401：未認(rèn)證
  • 403：權(quán)限不足
  • 404：資源不存在
  • 500：服務(wù)器內(nèi)部錯誤
• 全局異常捕獲（FastAPI）：

from fastapi import FastAPI, Request
from fastapi.exceptions import RequestValidationError
from starlette.exceptions import HTTPException as StarletteHTTPException

app = FastAPI()

@app.exception_handler(StarletteHTTPException)
async def http_exception_handler(request, exc):
    return JSONResponse(
        status_code=exc.status_code,
        content={"detail": exc.detail}
    )

測試規(guī)范

單元測試

1. pytest結(jié)構(gòu)：

# tests/test_users.py
from django.urls import reverse
import pytest

@pytest.mark.django_db
def test_user_creation(api_client):
    response = api_client.post(reverse('user-list'), data={'email': 'test@example.com'})
    assert response.status_code == 201

2. 覆蓋率要求：核心模塊≥80%，接口模塊≥90%

性能測試

1. 使用Locust進行負(fù)載測試
2. 關(guān)鍵接口響應(yīng)時間≤200ms（復(fù)雜查詢≤500ms）

安全規(guī)范

• 輸入校驗：
  • 所有用戶輸入必須通過Pydantic模型校驗
  • 敏感字段（如密碼）使用SecretStr類型
• XSS防護：
  • Django項目啟用escape模板過濾器
  • 使用CSP頭限制資源加載
• SQL注入防護：
  • 禁止使用raw查詢（除非經(jīng)過嚴(yán)格審核）
  • 復(fù)雜查詢必須通過參數(shù)化語句

部署規(guī)范

環(huán)境管理

1. 使用Ansible或Terraform進行基礎(chǔ)設(shè)施管理
2. 環(huán)境變量管理：通過python-dotenv加載
3. 日志規(guī)范：
   • 使用標(biāo)準(zhǔn)logging模塊
   • 格式：%(asctime)s [%(levelname)s] %(name)s: %(message)s
   • 級別：生產(chǎn)環(huán)境設(shè)為WARNING，開發(fā)環(huán)境設(shè)為DEBUG

版本控制規(guī)范

• Git提交規(guī)范：
  • 類型：feat/fix/chore/docs
  • 格式：<type>(<scope>): <subject>
  • 示例：feat(user): add email verification
• 必須通過PR進行代碼審查
• 主分支禁止直接提交，必須通過CI/CD流水線

性能優(yōu)化規(guī)范

• 數(shù)據(jù)庫優(yōu)化：
  • 復(fù)雜查詢必須添加索引
  • 使用EXPLAIN ANALYZE分析查詢性能
• 緩存策略：
  • 使用Redis緩存高頻查詢
  • 緩存鍵命名規(guī)范：{module}:{id}:{field}
• 異步處理：
  • 長任務(wù)使用Celery/RQ
  • 同步代碼中禁止阻塞操作

文檔規(guī)范

1. 使用Sphinx或mkdocs生成文檔
2. 所有公共API必須包含Swagger/OpenAPI文檔
3. 重大變更需更新CHANGELOG.md

代碼審查規(guī)范

1. 每個PR必須至少2人審查
2. 代碼復(fù)雜度（Cyclomatic）≤10
3. 方法行數(shù)≤50行，類行數(shù)≤200行

相關(guān)閱讀：

通義靈碼 Rules 設(shè)置指南
：https://help.aliyun.com/zh/lingma/user-guide/ai-rules

通義靈碼 Rules 上手實踐
：https://developer.aliyun.com/article/1658899

點擊此處查看更多Rules