概念
提高可读性
- 导入模块的时候,都是用
import module
的方式,确保所有模块的引用在代码中处于一个清晰可见的路径 __init__.py
内不包含任何业务代码,最好仅作为空白文件使用
提高壮健性
包的命名
- windows下,包的命名必须确保不与内置模块重名、冲突
- unix下,因为unix上目录是区分大小写的,所以建议包采用首字母大写的命名方式
代码风格
- pep8
- python-black
导入规则
- 不在没有明确定义`
__all__
的模块使用from xxx import *
注释规范
- 传统python
def test(param:int, param_list:list[str|int] = list()) -> int:
"""这一行简短的描述函数的作用
这里开始详细的描述函数的功能,注意事项、使用方法等
@example
```python
res = test(xxxx)
```
@return {int} 返回一个整数
"""
.../ 函数执行逻辑