Python编码规范杂记(很乱:))

Posted 2021-01-23 Jinhao Chen

Python编码规范

导入模块

• 每一个(第三方)模块的导入都需要两个import语句, 如下

  1. 使用import some的方式导入模块, 如果有还有子模块的话, 则from father.son import son, as看情况用
  2. 使用from some import class的方式导入类
• 导入自己的模块
  1. 不使用import, 使用from . import 后者 from .some import foo

• 在import的时候加了.或者..的py文件是不能直接运行的, 因为这个涉及到模块加载, 在情况下我们不能使用传统的def __main__测试而是使用一个测试文件, 先导入这个模块, 在项目中应该常见一个test目录

• Others:
  • 到导入Python库中的模块时, from import语句导入类的时候使用绝对路径(绝对路径的当前目录是主py文件所在的目录)
  • 导入自己项目中的模块的时候, 使用from import语句导入类的时候使用相对路径(相对路径的是相对于使用了from import语句的文件所在的目录), 就算是就在当前的目录下也是用from . import mod
  • import sys,os # 不建议
  • from some import foo, bar # 是推荐的
  • 只要是导入的使用没有使用.或者..的, 则查找的起点都是启动python虚拟机的目录， 这个对理解sys.path.insert(0, ‘..‘)失效后很大的帮助, 但是这个方式不建议使用
  • 关于Python的相对导入, 相对导入描述的是包之间的关系, 所以要实现相对导入就需要有对应的package关系(__init__.py)

# 需要使用SVC类
import sklearn.svm as sksvm
from sklearn.svm import SVC

文档编写

def foo():
"""brief description of the function

details of the function

Parameters
----------
Arg1 : int
    description

Arg2 : int
    description
    
Returns
-------
description

Examples:
---------
name : type
description
"""