遇到的问题

最近使用pytest+python+selenium编写自动化测试用例，使用pytest命令执行自动化用例时总是会遇到import自己写的模块失败的问题，尝试使用了一些办法倒是可以运行了，但是一旦切换到不同的目录下执行还是会报找不到模块，比如下面这个例子。

目录结构如下：

说明：以下目录中只有test_import_example.py有代码，其他都是空文件

├─graphic
│  │  __init__.py
│  │
│  ├─formats
│  │      jpg.py
│  │      png.py
│  │      __init__.py
│  │
│  └─primitive
│          fill.py
│          line.py
│          text.py
│          __init__.py
│
└─testcases
        test_import_example.py

test_import_example.py代码示例

import pytest
from graphic.primitive import line     # 这是我们测试的import语句

def test_case01():
    print("demo test case")

此时在示例的根目录（testcases文件夹所在的目录）下执行pytest命令会报找不到模块的错误

问题的根因

import找不到模块的根本原因是graphic这个目录不在系统的环境变量中，python导入模块时会从系统环境变量中查找模块，另外python会把要执行的.py文件所在的目录自动加入到环境变量中，可以通过sys模块中的sys.path查看加入了哪些环境变量

蹩脚的解决方案

知道了import找不到模块的根本原因，解决的办法就是把模块所在路径（示例中为graphic文件夹所在的路径）加入到环境变量中，修改后的代码如下

import pytest
import sys
# 这里的绝对路径是graphic文件夹所在的路径，需要根据实际情况修改
sys.path.insert(0, "C:\项目\练习项目\import-demo")
# 打印下环境变量的信息
print(sys.path)
from graphic.primitive import line

def test_case01():
    print("demo test case")

再次执行pytest命令（这次加了-vs参数以便查看到打印信息），可以正常导入模块了，划线的记录是加入的环境变量记录

直接将绝对路径以硬编码的方法加入到代码中有一个很明显的问题，一旦项目目录变化了就得重新修改代码，因此最好不要采用这种方式。

还有个加入环境变量的方法，把绝对目录改成相对目录

import pytest
import sys
from os.path import abspath, join, dirname
sys.path.insert(0, abspath('.'))     # 把当前目录加入到环境变量中
print(sys.path)
from graphic.primitive import line

def test_case01():
    print("demo test case")

正常情况下在项目根目录下执行pytest没有问题，但是如果我改变了pytest命令的执行目录还是会找不到模块，查看加入的环境变量我们发现sys.path.insert(0, abspath('.'))这条语句实际上就是把pytest命令所在的目录加入到了环境变量，这也就是为什么切换目录之后就找不到模块的原因，这也是我在自动化测试中遇到的问题，虽然凑合能运行但是一直让我心里有个疙瘩。

正确的打开方式

是时候解开这个疙瘩了，为了彻底解决这个问题，思路就是想办法构造一个绝对路径出来，把这个路径加入到环境变量（说明：这里构造的绝对目录需要根据自己的项目目录结构来设计）。示例代码如下

import pytest
import sys
from os.path import abspath, join, dirname
# __file__就代表这个文件本身， join(abspath(dirname(__file__)), '../') 这个语句
# 就是获取__file__所表示文件的上一级目录的绝对路径
sys.path.insert(0, join(abspath(dirname(__file__)), '../'))
print(sys.path)
from graphic.primitive import line

def test_case01():
    print("demo test case")

接下来，不管在哪个目录下运行pytest（这里需要你对pytest单元测试框架的使用有一定了解）都能正确的找到模块了，通过截图中打印的环境变量信息可以看到graphic所在目录已经被加入到环境变量中了，当然也就能够正常导入所需的模块了。