Python项目中如何优雅的import

Posted 2021-01-23 Jinhao Chen

Python项目中如何优雅的import

前言

• 之前有一篇关于Python编码规范的随笔, 但是写的比较杂乱, 因为提到了import语句, 在篇文章中, 我专门来讲Python项目中如何更好的import

标准库与第三方库的导入

• 导入一个模块, 如果模块名太长, 则使用import as; 如果是导入子模块, 则使用from import as
• 如果需要导入类的, 则使用from import导入类, 如果要导入某一个模块的多各类的话, 则类名使用逗号分隔
• 示例
  1. 导入sklearn中的svm中的SVC类

  
  import sklearn.svm
  from sklearn.svm import SVC

  1. 导入numpy中的random模块

  
  import numpy.random as nprand

• 总结: 如果导入类的话, 一定是import somemod 和 from somemod import class两个语句组成的; 如果导入一个不同的模块的则, 则一般就是import somemod

项目模块导入

• 项目目录

wxoa ?? tree -Cl
.
├── main.py
├── test
└── wxoa
    ├── __init__.py
    ├── __pycache__
    │   └── __init__.cpython-35.pyc
    ├── entity
    │   ├── __init__.py
    │   ├── __pycache__
    │   │   ├── __init__.cpython-35.pyc
    │   │   └── user.cpython-35.pyc
    │   └── user.py
    └── util
        ├── __init__.py
        ├── __pycache__
        │   ├── __init__.cpython-35.pyc
        │   └── ioutil.cpython-35.pyc
        └── ioutil.py

7 directories, 12 files

• 主程序为main.py, 项目名为wxoa, 存放源代码的目录也叫wxoa, 也是一个python package
• 导入规则
  • 存在python package(所以这里不包含main.py)中的python文件包导入的规则
    • 使用from . import somemod导入当前目录下的模块
    • 使用from ..somemod import submod导入上一级目录的somemod目录下的submod模块
    • 如果名称太长则使用as缩减
  • 不在python package(就是这里的main.py和test目录下的文件)中的python文件的导入规则
    • 使用from somemod.submod.subsubmod import some导入, 注意这里不使用.号起头, 关于使用., ..的作用在下面会说明, 如果使用了.起头则会报错, 提示父模块没有加载
    • 其中somemod就是我们的源码的python package包名, 在这里就是wxoa
    • 如果名称太长则使用as缩减

关于.和..

• 在包导入中, 如果出现了.和..起头, 则会涉及到package(不是module)的关系, ..表示上一级package, 这个上一级package需要有一个__init__.py才是合法的, .表示当前package, 当前package需要有一个__init__.py才是合法的

• .和..涉及到的python程序的启动项, 这里会比较复杂, 简而言之, 在涉及到..表示的上级package的时候, 如果python程序的启动文件就是在这里则Python解释器不会认为..表示的上级目录的package是一个合法的目录, 尽管有__init__.py文件, 因此会报错; 这样就给代码测试带来的麻烦, 不能直接在使用..和.中直接测试代码, 也就是
  if __name__ == ‘__main__‘: pass
  因为这样已启动程序就会报错, 所以报错, 在下面提出解决方案

关于.和..带来的麻烦的解决方案

• 和上面展示的项目目录一样, 主启动程序, 项目源代码(主要是模块), 测试代码分离, main.py在项目目录下, test(普通的文件夹, 存放python测试文件)也在项目目录下, 项目源代码就是wxoa
• 在main.py和test目录下的python文件中导入自己项目中的模块, 就不要使用.和..起头了, 否则会报错, 而是使用绝对路径, 如这里的, from wxoa.service import user