【Python】オプションを受け取れるconftest | Udemyのセールを活用してほしかったあのスキルを手に入れよう！【非公式】

Python学習【365日チャレンジ！】181日目のマスターU（@Udemy11）です。

気づけば目標としていた180日（6ヶ月）を過ぎていました。

1年間365日の継続学習が最終目標なので、181日目なので、まだ折り返していませんが、これだけの期間を毎日継続できたのは、あとにも先にも記憶にございません！

最近の学習は、Pythonでプログラムを書く上での付随的な内容が多いので、基本的なPythonのコードの書き方も復習しつつレクチャーを進めていかないと、忘れてしまうことが増えてきそうです。

次の目標は、300日（10ヶ月）に設定してPython学習を継続したいと思います。

それでは、今日もPython学習をはじめましょう。

昨日の復習

昨日は、pytestでテストをスキップする方法を学習しました。

unittestと同じように、普通にテストをスキップする方法と条件をつけてスキップする方法がありました。

コードの書き方もほぼunittestのときと同じで、少し記述が変わる程度で、非常に簡単にテストのスキップをすることができました。

pytestによるテストのスキップの詳細については、昨日の記事を参考にしてください。

Udemyのセールを活用してほしかったあのスキルを手に入れよう！【非公式】

2020.08.09

【Python】pytestでテストをスキップする方法

https://udemyfun.com/python-pytest-skip

Python学習【365日チャレンジ！】180日目のマスターU（@Udemy11）です。2017年にバブルが弾けたビットコインが、知らない間に100万円を超えてじわりじわりと価格が上がっていることはあまり知られていないかもしれませんが、まだ仮想通貨バブルの頃まで戻ってはいません。投資というより、投機に近い仮想通貨ですが、今が投資するチャンスかも知れませんね。なくなってもいい余剰資金で仮想通貨を購入しておけば、数年後にはちょっとしたお小遣いになっているかもしれませんよ。昨日の復習昨日は、pytestでsetupとteardownを使う方法を...

今日は、pytestを実行する際に、オプションを渡して実行することができるconftestを学習します。

conftestの利用シーン

オプションを渡すといっても、私のようにいまいちよくわからない方もいるかと思うで、具体的にどのようなことをするのか考えてみましょう。

ターミナルでPythonを実行するときは、python ファイル名とコマンド入力しますが、この後に--をつけたオプションと一緒に実行することで追加の処理を行うことができます。

たとえばターミナルの操作に関連して、subprocessを使ってコマンドを渡す場合、Macならディレクトリを表示するコマンドはlsでWindowsならdirなので受け取る値によって、引き渡す値を変更してテストを実行することができます。

os_name = "mac"
if os_name == 'mac':
   print('ls')
elif os_name == 'windows':
   print('dir')

このようなコードをtest_calculation.pyに加えていきます。

calculation.py

今回のテストもテストするメインのファイルはcalculation.pyです。

class Cal(object):
   def add_and_double(self, x, y):
       if type(x) is not int or type(y) is not int:
           raise ValueError
       result = x + y
       result *= 2
       return result

conftest.py

これまでのテストで利用してきたtest_calculation.pyも使用しますが、まずconftest.pyを作成します。

pytestでテストファイル（test_calculation.pyを実行する場合、同じディレクトリにconftest.pyがあれば、先にconftest.pyを自動的に読み込みます。

その読み込まれるconftest.pyのコードを書いてみます。

def pytest_addoption(parser):
   parser.addoption('--os-name', default='linux', help='os name')

このファイル（conftest.pyをtest_calculation.pyと同じディレクトリに置けば、pytestを実行するとコマンドから--os-nameをオプションで受け取れるようになります。

コマンドにオプションが入力されていなければ、--os-nameにはデフォルトでlinuxが代入されます。

この状態で、ターミナルからpytestコマンドでtest_calculation.pyを--helpオプションを加えて実行すると、カスタムオプションに--os-opition、os nameが付け加えられているのが確認できます。

test_calculation.py

次にテストを実行するtest_calculation.pyを書いていきましょう。

import calculation

class TestCal(object):
    def test_add_and_double(self, request):
        os_name = request.config.getoption('--os-name')
        print(os_name)
        if os_name == 'mac':
            print('ls')
        elif os_name == 'windows':
            print('dir')
        cal = calculation.Cal()
        assert cal.add_and_double(1, 3) == 8

今回のtest_calculation.pyは、1つだけのテストでコードを書いています。

4行目でテストの関数を定義するときに、引数にrequestを加えて、5行目で、config.getoptionによって、指定した引数の値をos_nameで受け取ります。

6行目でわかりやすいようにprint出力していますが、本来はこの出力は不要です。

7行目から10行目で、最初に解説したように、MacとWindowsで出力するコマンドを分けています。

その後、テストを実行するコードですが、今回は出番なしみたいなものですね。