File tree Expand file tree Collapse file tree 1 file changed +43
-5
lines changed Expand file tree Collapse file tree 1 file changed +43
-5
lines changed Original file line number Diff line number Diff line change @@ -24,21 +24,37 @@ Discord 社区与我们分享吧 🤗
24
24
文件名:` python-code-standards.mdc `
25
25
26
26
``` mdc
27
+ # Python 3.10+
28
+
29
+ 您是 Python 3.10+ 方面的专家,请遵循以下原则
30
+
27
31
## 类型注解规范
28
32
29
- - 使用 Python 3.10+ 的类型注解语法
33
+ - 使用 Python 3.10+ 的类型/注解语法
30
34
- 只在必要时使用 `Any` 类型,如果使用了则必须保留
31
- - 为所有函数参数和返回值添加类型注解
35
+ - 为所有函数参数和返回值添加类型注解,args, kwargs 参数直接忽略注解
32
36
- 为字典返回值添加具体的类型注解(如 `dict[str, Any]`)
33
37
- 为列表返回值添加具体的类型注解(如 `list[dict[str, str]]`)
34
38
35
39
## 文档注释规范
36
40
37
- - 只包含 `:param` 和 `:return`
38
- - `:return:` 后面不添加注释
41
+ - 不要在文件开头添加注释
42
+ - 函数文档格式如下
43
+ - 当函数存在参数时
44
+ `:return:` 后面不写内容
45
+ """
46
+ 函数描述
47
+
48
+ :param xxx: 参数说明
49
+ :return:
50
+ """
51
+ - 当函数没有参数时
52
+ """函数描述"""
53
+ - 函数描述要简洁明了,不需要进行举例说明
39
54
- 保持中英文之间的空格
40
55
- 参数说明要具体和清晰
41
- - 函数描述要简洁明了
56
+ - 如果函数没有入参且描述只有简短文字,那么引号和内容写在同一行
57
+ - 如果函数被 model_validator 或 field_validator 注释,则只需添加函数描述即可
42
58
43
59
## 代码逻辑规范
44
60
@@ -61,6 +77,13 @@ Discord 社区与我们分享吧 🤗
61
77
- 使用括号进行换行
62
78
- 保持一致的缩进
63
79
80
+ ## 代码注释规范
81
+
82
+ - 合理的注释,避免不必要的注释
83
+ - 中英文之间应包加空格
84
+ - 注释文字描述应具体和清晰
85
+ - 注释要让人视觉上更清晰
86
+
64
87
## 命名规范
65
88
66
89
- 变量名要具有描述性
@@ -84,15 +107,30 @@ Discord 社区与我们分享吧 🤗
84
107
文件名:` fastapi-specific-standards-for-fba.mdc `
85
108
86
109
``` mdc
110
+ # FastAPI Best Architecture
111
+
112
+ 您是 FastAPI 和可扩展 API 开发方面的专家,请遵循以下原则
113
+
87
114
## 依赖管理
88
115
89
116
- 使用 FastAPI 的依赖注入系统管理状态和共享资源
90
117
- 遵循项目的依赖版本要求:
118
+ - Python 3.10+
91
119
- FastAPI
92
120
- Pydantic v2
121
+ - Pydantic Settings @backend\core\conf.py
93
122
- SQLAlchemy 2.0(如果使用 ORM 功能)
94
123
- SQLAlchemy 配置: @backend\database\db.py
95
124
125
+ ## SQLAlchemy 规范
126
+
127
+ - 模型类文档只需描述它是什么表
128
+
129
+ ## Schema 规范
130
+
131
+ - schema 类文档只需描述简短几个字
132
+ - 为 schema 属性添加 Field
133
+
96
134
## 路由处理规范
97
135
98
136
- 同步操作使用 `def`
You can’t perform that action at this time.
0 commit comments