← Back
Editing: _parameterized.cpython-36.pyc
3 ���h\< � @ s d Z dZddlZddlZddlZddlZy ddlZW n ek rP ddlZY nX ddl Z ddl Z ej d�Z e j � jZe� Ze� Zdd� Zdd� Zd d � Zd d � ZG d d� de�Zdd� Zdd� Zdd� Zdd� Zdd� Z G dd� de �Z dd � Z G d d � d ej e d �Z!d d!� Z"dS )"a( Adds support for parameterized tests to Python's unittest TestCase class. A parameterized test is a method in a test case that is invoked with different argument tuples. A simple example: class AdditionExample(parameterized.ParameterizedTestCase): @parameterized.Parameters( (1, 2, 3), (4, 5, 9), (1, 1, 3)) def testAddition(self, op1, op2, result): self.assertEqual(result, op1 + op2) Each invocation is a separate test case and properly isolated just like a normal test method, with its own setUp/tearDown cycle. In the example above, there are three separate testcases, one of which will fail due to an assertion error (1 + 1 != 3). Parameters for invididual test cases can be tuples (with positional parameters) or dictionaries (with named parameters): class AdditionExample(parameterized.ParameterizedTestCase): @parameterized.Parameters( {'op1': 1, 'op2': 2, 'result': 3}, {'op1': 4, 'op2': 5, 'result': 9}, ) def testAddition(self, op1, op2, result): self.assertEqual(result, op1 + op2) If a parameterized test fails, the error message will show the original test name (which is modified internally) and the arguments for the specific invocation, which are part of the string returned by the shortDescription() method on test cases. The id method of the test, used internally by the unittest framework, is also modified to show the arguments. To make sure that test names stay the same across several invocations, object representations like >>> class Foo(object): ... pass >>> repr(Foo()) '<__main__.Foo object at 0x23d8610>' are turned into '<__main__.Foo>'. For even more descriptive names, especially in test logs, you can use the NamedParameters decorator. In this case, only tuples are supported, and the first parameters has to be a string (or an object that returns an apt name when converted via str()): class NamedExample(parameterized.ParameterizedTestCase): @parameterized.NamedParameters( ('Normal', 'aa', 'aaa', True), ('EmptyPrefix', '', 'abc', True), ('BothEmpty', '', '', True)) def testStartsWith(self, prefix, string, result): self.assertEqual(result, strings.startswith(prefix)) Named tests also have the benefit that they can be run individually from the command line: $ testmodule.py NamedExample.testStartsWithNormal . -------------------------------------------------------------------- Ran 1 test in 0.000s OK Parameterized Classes ===================== If invocation arguments are shared across test methods in a single ParameterizedTestCase class, instead of decorating all test methods individually, the class itself can be decorated: @parameterized.Parameters( (1, 2, 3) (4, 5, 9)) class ArithmeticTest(parameterized.ParameterizedTestCase): def testAdd(self, arg1, arg2, result): self.assertEqual(arg1 + arg2, result) def testSubtract(self, arg2, arg2, result): self.assertEqual(result - arg1, arg2) Inputs from Iterables ===================== If parameters should be shared across several test cases, or are dynamically created from other sources, a single non-tuple iterable can be passed into the decorator. This iterable will be used to obtain the test cases: class AdditionExample(parameterized.ParameterizedTestCase): @parameterized.Parameters( c.op1, c.op2, c.result for c in testcases ) def testAddition(self, op1, op2, result): self.assertEqual(result, op1 + op2) Single-Argument Test Methods ============================ If a test method takes only one argument, the single argument does not need to be wrapped into a tuple: class NegativeNumberExample(parameterized.ParameterizedTestCase): @parameterized.Parameters( -1, -3, -4, -5 ) def testIsNegative(self, arg): self.assertTrue(IsNegative(arg)) z!tmarek@google.com (Torsten Marek)� Nz0\<([a-zA-Z0-9_\-\.]+) object at 0x[a-fA-F0-9]+\>c C s t jdt| ��S )Nz<\1>)�ADDR_RE�sub�repr)�obj� r �$/usr/lib/python3.6/_parameterized.py� _CleanRepr� s r c C s d| j | jf S )Nz%s.%s)� __module__�__name__)�clsr r r � _StrClass� s r c C s t | tj�ot | tj� S )N)� isinstance� collections�Iterable�sixZ string_types)r r r r �_NonStringIterable� s r c C sN t | tj�r(djdd� t| j� �D ��S t| �r@djtt| ��S t | f�S d S )Nz, c s s" | ]\}}d |t |�f V qdS )z%s=%sN)r )�.0Zargname�valuer r r � <genexpr>� s z'_FormatParameterList.<locals>.<genexpr>) r r �Mapping�join�list�itemsr �mapr �_FormatParameterList)�testcase_paramsr r r r � s r c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �_ParameterizedTestIterz9Callable and iterable class for producing new test cases.c C s || _ || _|| _dS )a\ Returns concrete test functions for a test and a list of parameters. The naming_type is used to determine the name of the concrete functions as reported by the unittest framework. If naming_type is _FIRST_ARG, the testcases must be tuples, and the first element must have a string representation that is a valid Python identifier. Args: test_method: The decorated test method. testcases: (list of tuple/dict) A list of parameter tuples/dicts for individual test invocations. naming_type: The test naming type, either _NAMED or _ARGUMENT_REPR. N)� _test_method� testcases� _naming_type)�self� test_methodr � naming_typer r r �__init__� s z _ParameterizedTestIter.__init__c O s t d��d S )Nz�You appear to be running a parameterized test case without having inherited from parameterized.ParameterizedTestCase. This is bad because none of your test cases are actually being run.)� RuntimeError)r �args�kwargsr r r �__call__� s z _ParameterizedTestIter.__call__c s. | j �| j���fdd�� � fdd�| jD �S )Nc s� t j���� fdd��}�tkrJd|_| jt� d �7 _� dd � � n(�tkrddt� �f |_nt d�f ��d|jt� �f |_ �j r�| j d �j f 7 _ |S ) Nc s@ t �tj�r� | f�� n"t��r2� | f��� n � | �� d S )N)r r r r )r )r! r r r �BoundParamTest� s zS_ParameterizedTestIter.__iter__.<locals>.MakeBoundParamTest.<locals>.BoundParamTestTr � z(%s)z %s is not a valid naming type.z%s(%s)z %s) � functools�wraps� _FIRST_ARG�__x_use_name__r �str�_ARGUMENT_REPRr �__x_extra_id__r$ �__doc__)r r( )r" r! )r r �MakeBoundParamTest� s z;_ParameterizedTestIter.__iter__.<locals>.MakeBoundParamTestc 3 s | ]}� |�V qd S )Nr )r �c)r2 r r r � s z2_ParameterizedTestIter.__iter__.<locals>.<genexpr>)r r r )r r )r2 r" r! r �__iter__� s z _ParameterizedTestIter.__iter__N)r r � __qualname__r1 r# r' r4 r r r r r � s r c C s t | �dkot| d t� S )z<True iff testcases contains only a single non-tuple element.r) r )�lenr �tuple)r r r r �_IsSingletonList� s r8 c C s� t | dd � s td| f ��i | _}x�t| jj� j� �D ]l\}}|jtj j �r:t |t j �r:t| |� i }t|||t|||�� x$t|j� �D ]\}}t| ||� q�W q:W d S )N� _id_suffixzECannot add parameters to %s, which already has parameterized methods.)�getattr�AssertionErrorr9 r �__dict__�copyr � startswith�unittest� TestLoader�testMethodPrefixr �types� FunctionType�delattr� _UpdateClassDictForParamTestCaser �setattr)Z class_objectr r" � id_suffix�namer �methods�methr r r � _ModifyClass s rK c s6 � �fdd�}t ��r2t�d �s*td���d �|S )z�Implementation of the parameterization decorators. Args: naming_type: The naming type. testcases: Testcase parameters. Returns: A function for modifying the decorated object. c s> t | t�r.t| t �tj�s"t��n�� � | S t| �� �S d S )N)r �typerK r �Sequencer r )r )r" r r r �_Apply! s z#_ParameterDecorator.<locals>._Applyr z7Single parameter argument must be a non-string iterable)r8 r r; )r" r rN r )r" r r �_ParameterDecorator s rO c G s t t| �S )ai A decorator for creating parameterized tests. See the module docstring for a usage example. Args: *testcases: Parameters for the decorated method, either a single iterable, or a list of tuples/dicts/objects (for tests with only one argument). Returns: A test generator to be handled by TestGeneratorMetaclass. )rO r/ )r r r r � Parameters4 s rP c G s t t| �S )a� A decorator for creating parameterized tests. See the module docstring for a usage example. The first element of each parameter tuple should be a string and will be appended to the name of the test method. Args: *testcases: Parameters for the decorated method, either a single iterable, or a list of tuples. Returns: A test generator to be handled by TestGeneratorMetaclass. )rO r, )r r r r �NamedParametersC s rQ c @ s e Zd ZdZdd� ZdS )�TestGeneratorMetaclassa� Metaclass for test cases with test generators. A test generator is an iterable in a testcase that produces callables. These callables must be single-argument methods. These methods are injected into the class namespace and the original iterable is removed. If the name of the iterable conforms to the test pattern, the injected methods will be picked up as tests by the unittest framework. In general, it is supposed to be used in conjunction with the Parameters decorator. c C sl i |d< }xNt |j� �D ]>\}}|jtjj�rt|�rt|�}|j|� t ||||� qW t j | |||�S )Nr9 ) r r r> r? r@ rA r �iter�poprE rL �__new__)Zmcs� class_name�bases�dctrG rH r �iteratorr r r rU a s z TestGeneratorMetaclass.__new__N)r r r5 r1 rU r r r r rR T s rR c C s� xzt |�D ]n\}}t|�s(td|f ��t|dd�r<|j}nd|t|f }|| ks`td|f ��|| |< t|dd�||< q W dS ) a Adds individual test cases to a dictionary. Args: dct: The target dictionary. id_suffix: The dictionary for mapping names to test IDs. name: The original name of the test case. iterator: The iterator generating the individual test cases. z,Test generators must yield callables, got %rr- Fz%s%s%dz/Name of parameterized test case "%s" not uniquer0 � N)� enumerate�callabler; r: r � _SEPARATOR)rX rG rH rY �idx�func�new_namer r r rE m s rE c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �ParameterizedTestCasez9Base class for test cases using the Parameters decorator.c C s | j jt�d S )Nr )�_testMethodName�splitr] )r r r r � _OriginalName� s z#ParameterizedTestCase._OriginalNamec C s d| j � t| j�f S )Nz%s (%s))rd r � __class__)r r r r �__str__� s z ParameterizedTestCase.__str__c C s$ dt | j�| j� | jj| jd�f S )z�Returns the descriptive ID of the test. This is used internally by the unittesting framework to get a name for the test to be used in reports. Returns: The test id. z%s.%s%srZ )r re rd r9 �getrb )r r r r �id� s zParameterizedTestCase.idN)r r r5 r1 rd rf rh r r r r ra � s ra )� metaclassc C s" t d| jtfi �}|d| tfi �S )a; Returns a new base class with a cooperative metaclass base. This enables the ParameterizedTestCase to be used in combination with other base classes that have custom metaclasses, such as mox.MoxTestBase. Only works with metaclasses that do not override type.__new__. Example: import google3 import mox from google3.testing.pybase import parameterized class ExampleTest(parameterized.CoopParameterizedTestCase(mox.MoxTestBase)): ... Args: other_base_class: (class) A test case base class. Returns: A new class object. Z CoopMetaclass�CoopParameterizedTestCase)rL Z __metaclass__rR ra )Zother_base_classri r r r rj � s rj )#r1 � __author__r r* �rerB Z unittest2r? � ImportErrorZuuidr �compiler Zuuid1�hexr] �objectr, r/ r r r r r r8 rK rO rP rQ rL rR rE ZTestCasera rj r r r r �<module>� s: A
Save File
Cancel