pytest使う際のフォルダ構成とそれに伴うpath設定について

初めに

(project)
├── (project)  ............ プログラムのソースコードディレクトリ
│  ├── __init__.py
│  └── *.py
└── tests  ................ 単体テストのソースコードディレクトリ
   ├── __init__.py
   └── *.py

環境

• windows 10
• vscode
• Python 3.11.0
• pipenv version 2022.12.19
• ソースコード

お試し用プロジェクト

+---pyapp
       calc.py
       data.py
       __init__.py
       __main__.py

from typing import Self

class Data:
    def __init__(self, value: float) -> None:
        self.value = value
    
    def add(self, other: Self):
        val = self.value + other.value
        return self.__class__(val)

from data import Data

def func(d1: Data, d2: Data) -> Data:
    return d1.add(d2)

pytest準備

+---pyapp
|       calc.py
|       data.py
|       __init__.py
|       __main__.py
|
\---tests
        test_calc.py
        __init__.py

from pyapp.data import Data
from pyapp.calc import func

def test_calc1():
    d1 = Data(1)
    d2 = Data(2)
    d3 = func(d1, d2)
    assert d3.value == 3

pytest実行

三角形のアイコンをクリックすれば実行できる。今回はエラー詳細も出したいので虫アイコンの方を押して、Debug Testを実行する。

分析

def func(d1, d2):
    return d1.add(d2)

• test_calc.pyからpyapp.calcの読み込みはできている。
• pyapp.calcを読み込む際に、その先のdataを読み込めていない。

解決方法(pathの設定)

1. conftest.pyで指定する
2. .envファイルを作る

1. conftest.pyで指定する。

フィクスチャはテストの実行前後で行いたい前処理・後処理を記述するために使用する関数のことです。各テストで同じ前処理・後処理を行う必要がある場合に暗黙的にそれが実行できるようになります。

複数のファイルをまたいで共通のフィクスチャを使用したいこともあると思います。そのような時はフィクスチャを conftest.py というファイルに定義しましょう。conftest.py 内のフィクスチャは pytest によって自動的にインポートされ、conftest.py があるディレクトリ配下で暗黙的に参照できるようになります。

import sys 
import os

sys.path.append(os.path.abspath(os.path.dirname(os.path.abspath(__file__)) + "/../pyapp"))

2. .envファイルを作る

PYTHONPATH=./pyapp

参考

• https://rinatz.github.io/python-book/ch08-02-pytest
• https://www.magata.net/memo/index.php?pytest%C6%FE%CC%E7#y2046859
• https://zenn.dev/panyoriokome/articles/f34ae72cc33150