web-dev-qa-db-ja.com

pythonモジュールのargparse部分のテストをどのように記述しますか？

Argparseライブラリを使用するPythonモジュールがあります。コードベースのそのセクションのテストを作成するにはどうすればよいですか？

pythonunit-testingargparse
126
pydanny

コードをリファクタリングし、解析を関数に移動する必要があります。

def parse_args(args):
    parser = argparse.ArgumentParser(...)
    parser.add_argument...
    # ...Create your parser as you like...
    return parser.parse_args(args)

次に、main関数で次のように呼び出すだけです。

parser = parse_args(sys.argv[1:])

（スクリプト名を表すsys.argvの最初の要素は、CLI操作中に追加のスイッチとして送信しないように削除されます。）

テストでは、次のようにテストする引数のリストを指定してパーサー関数を呼び出すことができます。

def test_parser(self):
    parser = parse_args(['-l', '-m'])
    self.assertTrue(parser.long)
    # ...and so on.

これにより、パーサーをテストするためだけにアプリケーションのコードを実行する必要がなくなります。

アプリケーションの後半でパーサーのオプションを変更または追加する必要がある場合は、ファクトリメソッドを作成します。

def create_parser():
    parser = argparse.ArgumentParser(...)
    parser.add_argument...
    # ...Create your parser as you like...
    return parser

必要に応じて後で操作でき、テストは次のようになります。

class ParserTest(unittest.TestCase):
    def setUp(self):
        self.parser = create_parser()

    def test_something(self):
        parsed = self.parser.parse_args(['--something', 'test'])
        self.assertEqual(parsed.something, 'test')
169
Viktor Kerkez

「argparse portion」は少し曖昧なので、この答えはparse_argsメソッドという1つの部分に焦点を当てています。これは、コマンドラインとやり取りし、渡されたすべての値を取得するメソッドです。基本的に、parse_argsが返すものをモックすることができるので、コマンドラインから実際に値を取得する必要はありません。 mockpackage は、pythonバージョン2.6-3.2のpipを介してインストールできます。バージョン3.3以降のunittest.mockとして標準ライブラリの一部です。

import argparse
try:
    from unittest import mock  # python 3.3+
except ImportError:
    import mock  # python 2.6-3.2


@mock.patch('argparse.ArgumentParser.parse_args',
            return_value=argparse.Namespace(kwarg1=value, kwarg2=value))
def test_command(mock_args):
    pass

渡されなかった場合でも、Namespaceにすべてのコマンドメソッドの引数を含める必要があります。それらの引数にNoneの値を与えます。 （ docs を参照）このスタイルは、メソッド引数ごとに異なる値が渡される場合のテストを迅速に行うのに役立ちます。 Namespace自体を模擬して、テストで完全な引数解析に依存しない場合は、実際のNamespaceクラスと同様に動作することを確認してください。

以下は、argparseライブラリの最初のスニペットを使用した例です。

# test_mock_argparse.py
import argparse
try:
    from unittest import mock  # python 3.3+
except ImportError:
    import mock  # python 2.6-3.2


def main():
    parser = argparse.ArgumentParser(description='Process some integers.')
    parser.add_argument('integers', metavar='N', type=int, nargs='+',
                        help='an integer for the accumulator')
    parser.add_argument('--sum', dest='accumulate', action='store_const',
                        const=sum, default=max,
                        help='sum the integers (default: find the max)')

    args = parser.parse_args()
    print(args)  # NOTE: this is how you would check what the kwargs are if you're unsure
    return args.accumulate(args.integers)


@mock.patch('argparse.ArgumentParser.parse_args',
            return_value=argparse.Namespace(accumulate=sum, integers=[1,2,3]))
def test_command(mock_args):
    res = main()
    assert res == 6, "1 + 2 + 3 = 6"


if __== "__main__":
    print(main())
19
munsu

main()関数が引数としてargvを受け取るのではなく、引数を取るようにします デフォルトでsys.argvから読み取る ：

# mymodule.py
import argparse
import sys


def main(args):
    parser = argparse.ArgumentParser()
    parser.add_argument('-a')
    process(**vars(parser.parse_args(args)))
    return 0


def process(a=None):
    pass

if __== "__main__":
    sys.exit(main(sys.argv[1:]))

その後、正常にテストできます。

import mock

from mymodule import main


@mock.patch('mymodule.process')
def test_main(process):
    main([])
    process.assert_call_once_with(a=None)


@mock.patch('foo.process')
def test_main_a(process):
    main(['-a', '1'])
    process.assert_call_once_with(a='1')
11
Ceasar Bautista
  1. sys.argv.append()を使用して引数リストを作成し、parse()を呼び出して、結果を確認して繰り返します。
  2. フラグとdump argsフラグを使用して、バッチ/ bashファイルから呼び出します。
  3. 解析するすべての引数を別のファイルに配置し、if __== "__main__":呼び出しで解析し、結果をダンプ/評価してから、これをバッチ/ bashファイルからテストします。
6
Steve Barnes

元の提供スクリプトを変更したくなかったので、argparseのsys.argv部分をモックアウトしました。

from unittest.mock import patch

with patch('argparse._sys.argv', ['python', 'serve.py']):
    ...  # your test code here

Argparseの実装が変更されても、簡単なテストスクリプトで十分な場合、これは壊れます。とにかく、テストスクリプトの感度よりも感度の方がはるかに重要です。

5
김민준

パーサーをテストする簡単な方法は次のとおりです。

parser = ...
parser.add_argument('-a',type=int)
...
argv = '-a 1 foo'.split()  # or ['-a','1','foo']
args = parser.parse_args(argv)
assert(args.a == 1)
...

別の方法は、sys.argvを変更し、args = parser.parse_args()を呼び出すことです

lib/test/test_argparse.pyでargparseをテストする例はたくさんあります

4
hpaulj

結果をargparse.ArgumentParser.parse_argsから関数に渡すとき、テストのためにnamedtupleを使用して引数をモックすることがあります。

import unittest
from collections import namedtuple
from my_module import main

class TestMyModule(TestCase):

    args_Tuple = namedtuple('args', 'arg1 arg2 arg3 arg4')

    def test_arg1(self):
        args = TestMyModule.args_Tuple("age > 85", None, None, None)
        res = main(args)
        assert res == ["55289-0524", "00591-3496"], 'arg1 failed'

    def test_arg2(self):
        args = TestMyModule.args_Tuple(None, [42, 69], None, None)
        res = main(args)
        assert res == [], 'arg2 failed'

if __== '__main__':
    unittest.main()
2
guest

parse_argsはSystemExitをスローし、stderrに出力します。これらの両方をキャッチできます。

import contextlib
import io
import sys

@contextlib.contextmanager
def captured_output():
    new_out, new_err = io.StringIO(), io.StringIO()
    old_out, old_err = sys.stdout, sys.stderr
    try:
        sys.stdout, sys.stderr = new_out, new_err
        yield sys.stdout, sys.stderr
    finally:
        sys.stdout, sys.stderr = old_out, old_err

def validate_args(args):
    with captured_output() as (out, err):
        try:
            parser.parse_args(args)
            return True
        except SystemExit as e:
            return False

stderrを検査します（err.seek(0); err.read()を使用しますが、通常、粒度は必要ありません。

これで assertTrue または任意のテストを使用できます：

assertTrue(validate_args(["-l", "-m"]))

または、（SystemExitの代わりに）別のエラーをキャッチして再スローすることもできます。

def validate_args(args):
    with captured_output() as (out, err):
        try:
            return parser.parse_args(args)
        except SystemExit as e:
            err.seek(0)
            raise argparse.ArgumentError(err.read())
1
Andy Hayden