如何测试依赖于 argparse 的 Python 类？

Question

下面的粘贴包含来自三个单独的 Python 文件的相关片段。第一个是从命令行调用的脚本，它在给定特定参数的情况下实例化 CIPuller。发生的情况是脚本被调用为： script.py ci（其他参数将被 argparse 吞没）。

第二个是名为 Puller 的子类的一部分。第三个是 Puller 子类的一部分，称为 CIPuller.

这非常有效，因为调用了正确的子类，任何使用错误的其他参数的用户都可以看到其给定子类的正确参数，以及来自超类的通用参数。（虽然我在离线时意识到也许我应该为此使用 argparse sub-commands。）

我一直在尝试为这些类编写测试。目前，我需要一个 ArgumentParser 来实例化类，但在测试中我没有从命令行实例化东西，因此我的 ArgumentParser 没用。

我尝试在测试工具中创建一个 ArgumentParser 以传递给测试代码中的 CIPuller's 构造函数，但是如果我在那里使用 add_argument，argparse 可以理解地抱怨双重（重复) 在 CIPuller 构造函数中调用 add_argument 时的参数。

用参数测试这些类的合适设计是什么？

#!/usr/bin/env python                                                             

from ci_puller import CIPuller                                                    
import argparse                                                                   
import sys                                                                        

# Using sys.argv[1] for the argument here, as we don't want to pass that onto     
# the subclasses, which should receive a vanilla ArgumentParser                   
puller_type = sys.argv.pop(1)                                                     

parser = argparse.ArgumentParser(                                                 
    description='Throw data into Elasticsearch.'                                  
)                                                                                 

if puller_type == 'ci':                                                           
    puller = CIPuller(parser, 'single')                                         
else:                                                                             
    raise ValueError("First parameter must be a supported puller. Exiting.")      

puller.run()                                                                      


class Puller(object):                                                             

    def __init__(self, parser, insert_type):                                      
        self.add_arguments(parser)                                                
        self.args = parser.parse_args()                                           

        self.insert_type = insert_type                                            

    def add_arguments(self,parser):
        parser.add_argument(                                                      
            "-d", "--debug",                                                      
            help="print debug info to stdout",                                    
            action="store_true"                                                   
        )                                                                         

        parser.add_argument(                                                      
            "--dontsend",                                                         
            help="don't actually send anything to Elasticsearch",                 
            action="store_true"                                                   
        )                                                                         

        parser.add_argument(                                                      
            "--host",                                                             
            help="override the default host that the data is sent to",            
            action='store',                                                       
            default='kibana.munged.tld'                                     
        )                             

class CIPuller(Puller):                                                           

    def __init__(self, parser, insert_type):                                      
        self.add_arguments(parser)

        self.index_prefix = "code"                                                
        self.doc_type = "cirun"                                                   

        self.build_url = ""                                                       
        self.json_url = ""                                                        
        self.result = []                                                          

        super(CIPuller, self).__init__(parser, insert_type)                       

    def add_arguments(self, parser):                                              
        parser.add_argument(                                                      
            '--buildnumber',                                                      
            help='CI build number',                                               
            action='store',                                                       
            required=True                                                         
        )                                                                         

        parser.add_argument(                                                      
            '--testtype',                                                         
            help='Job type per CI e.g. minitest / feature',                       
            choices=['minitest', 'feature'],                                      
            required=True                                                         
        )                                                                         

        parser.add_argument(                                                      
            '--app',                                                              
            help='App e.g. sapi / stats',                                         
            choices=['sapi', 'stats'],                                            
            required=True                                                         
        )

Answer 1

argparse 的单元测试很棘手。有一个 test/test_argparse.py 文件是运行作为整个 Python 单元测试的一部分。但它有一个复杂的自定义测试工具来处理大多数情况。

存在三个基本问题，1) 使用测试值调用 parse_args，2) 测试生成的参数，3) 测试错误。

测试结果 args 相对容易。 argparse.Namespace class 具有简单的 __eq__ 方法，因此您可以针对另一个命名空间进行测试。

有两种测试输入的方法。一种是修改sys.argv。最初 sys.argv 具有用于测试人员的字符串。

self.args = parser.parse_args()

默认测试 sys.argv[1:]。因此，如果您更改 sys.argv，您可以测试自定义值。

但您也可以给 parse_args 自定义列表。 argparse 文档在其大多数示例中都使用了它。

self.args = parser.parse_args(argv=myargv)

如果 myarg 是 None，则使用 sys.argv[1:]。否则它使用该自定义列表。

测试错误需要自定义 parse.error 方法（请参阅文档）或将 parse_args 包装在可以捕获 sys.exit 异常的 try/except 块中。

How do you write tests for the argparse portion of a python module?

python unittest for argparse

Argparse unit tests: Suppress the help message

Unittest with command-line arguments

如何测试依赖于 argparse 的 Python 类？

How to test Python classes that depend on argparse?

python

pytest

argparse