<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module telemetry.testing.page_test_test_case</title>
<meta charset="utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.testing.html"><font color="#ffffff">testing</font></a>.page_test_test_case</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/testing/page_test_test_case.py">telemetry/testing/page_test_test_case.py</a></font></td></tr></table>
<p><tt>Provide a <a href="unittest.case.html#TestCase">TestCase</a> base class for PageTest subclasses' unittests.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.benchmark.html">telemetry.benchmark</a><br>
<a href="telemetry.core.exceptions.html">telemetry.core.exceptions</a><br>
<a href="telemetry.testing.options_for_unittests.html">telemetry.testing.options_for_unittests</a><br>
</td><td width="25%" valign=top><a href="telemetry.page.page.html">telemetry.page.page</a><br>
<a href="telemetry.page.page_test.html">telemetry.page.page_test</a><br>
<a href="telemetry.internal.results.results_options.html">telemetry.internal.results.results_options</a><br>
</td><td width="25%" valign=top><a href="telemetry.story.html">telemetry.story</a><br>
<a href="telemetry.internal.story_runner.html">telemetry.internal.story_runner</a><br>
<a href="unittest.html">unittest</a><br>
</td><td width="25%" valign=top><a href="telemetry.core.util.html">telemetry.core.util</a><br>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="telemetry.benchmark.html#BenchmarkMetadata">telemetry.benchmark.BenchmarkMetadata</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="telemetry.testing.page_test_test_case.html#EmptyMetadataForTest">EmptyMetadataForTest</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="telemetry.page.html#Page">telemetry.page.Page</a>(<a href="telemetry.story.story.html#Story">telemetry.story.story.Story</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="telemetry.testing.page_test_test_case.html#BasicTestPage">BasicTestPage</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="unittest.case.html#TestCase">unittest.case.TestCase</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="telemetry.testing.page_test_test_case.html#PageTestTestCase">PageTestTestCase</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="BasicTestPage">class <strong>BasicTestPage</strong></a>(<a href="telemetry.page.html#Page">telemetry.page.Page</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="telemetry.testing.page_test_test_case.html#BasicTestPage">BasicTestPage</a></dd>
<dd><a href="telemetry.page.html#Page">telemetry.page.Page</a></dd>
<dd><a href="telemetry.story.story.html#Story">telemetry.story.story.Story</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="BasicTestPage-RunPageInteractions"><strong>RunPageInteractions</strong></a>(self, action_runner)</dt></dl>
<dl><dt><a name="BasicTestPage-__init__"><strong>__init__</strong></a>(self, url, story_set, base_dir)</dt></dl>
<hr>
Methods inherited from <a href="telemetry.page.html#Page">telemetry.page.Page</a>:<br>
<dl><dt><a name="BasicTestPage-AddCustomizeBrowserOptions"><strong>AddCustomizeBrowserOptions</strong></a>(self, options)</dt><dd><tt>Inherit page overrides this to add customized browser options.</tt></dd></dl>
<dl><dt><a name="BasicTestPage-AsDict"><strong>AsDict</strong></a>(self)</dt><dd><tt>Converts a page object to a dict suitable for JSON output.</tt></dd></dl>
<dl><dt><a name="BasicTestPage-GetSyntheticDelayCategories"><strong>GetSyntheticDelayCategories</strong></a>(self)</dt></dl>
<dl><dt><a name="BasicTestPage-Run"><strong>Run</strong></a>(self, shared_state)</dt></dl>
<dl><dt><a name="BasicTestPage-RunNavigateSteps"><strong>RunNavigateSteps</strong></a>(self, action_runner)</dt></dl>
<dl><dt><a name="BasicTestPage-__cmp__"><strong>__cmp__</strong></a>(self, other)</dt></dl>
<dl><dt><a name="BasicTestPage-__lt__"><strong>__lt__</strong></a>(self, other)</dt></dl>
<dl><dt><a name="BasicTestPage-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<hr>
Data descriptors inherited from <a href="telemetry.page.html#Page">telemetry.page.Page</a>:<br>
<dl><dt><strong>base_dir</strong></dt>
</dl>
<dl><dt><strong>credentials_path</strong></dt>
</dl>
<dl><dt><strong>display_name</strong></dt>
</dl>
<dl><dt><strong>file_path</strong></dt>
<dd><tt>Returns the path of the file, stripping the scheme and query string.</tt></dd>
</dl>
<dl><dt><strong>file_path_url</strong></dt>
<dd><tt>Returns the file path, including the params, query, and fragment.</tt></dd>
</dl>
<dl><dt><strong>file_path_url_with_scheme</strong></dt>
</dl>
<dl><dt><strong>is_file</strong></dt>
<dd><tt>Returns True iff this URL points to a file.</tt></dd>
</dl>
<dl><dt><strong>page_set</strong></dt>
</dl>
<dl><dt><strong>serving_dir</strong></dt>
</dl>
<dl><dt><strong>startup_url</strong></dt>
</dl>
<dl><dt><strong>story_set</strong></dt>
</dl>
<dl><dt><strong>url</strong></dt>
</dl>
<hr>
Data descriptors inherited from <a href="telemetry.story.story.html#Story">telemetry.story.story.Story</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<dl><dt><strong>file_safe_name</strong></dt>
<dd><tt>A version of display_name that's safe to use as a filename.<br>
<br>
The default implementation sanitizes special characters with underscores,<br>
but it's okay to override it with a more specific implementation in<br>
subclasses.</tt></dd>
</dl>
<dl><dt><strong>id</strong></dt>
</dl>
<dl><dt><strong>is_local</strong></dt>
<dd><tt>Returns True iff this story does not require network.</tt></dd>
</dl>
<dl><dt><strong>labels</strong></dt>
</dl>
<dl><dt><strong>make_javascript_deterministic</strong></dt>
</dl>
<dl><dt><strong>name</strong></dt>
</dl>
<dl><dt><strong>shared_state_class</strong></dt>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="EmptyMetadataForTest">class <strong>EmptyMetadataForTest</strong></a>(<a href="telemetry.benchmark.html#BenchmarkMetadata">telemetry.benchmark.BenchmarkMetadata</a>)</font></td></tr>
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="telemetry.testing.page_test_test_case.html#EmptyMetadataForTest">EmptyMetadataForTest</a></dd>
<dd><a href="telemetry.benchmark.html#BenchmarkMetadata">telemetry.benchmark.BenchmarkMetadata</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="EmptyMetadataForTest-__init__"><strong>__init__</strong></a>(self)</dt></dl>
<hr>
Methods inherited from <a href="telemetry.benchmark.html#BenchmarkMetadata">telemetry.benchmark.BenchmarkMetadata</a>:<br>
<dl><dt><a name="EmptyMetadataForTest-AsDict"><strong>AsDict</strong></a>(self)</dt></dl>
<hr>
Data descriptors inherited from <a href="telemetry.benchmark.html#BenchmarkMetadata">telemetry.benchmark.BenchmarkMetadata</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<dl><dt><strong>description</strong></dt>
</dl>
<dl><dt><strong>name</strong></dt>
</dl>
<dl><dt><strong>rerun_options</strong></dt>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="PageTestTestCase">class <strong>PageTestTestCase</strong></a>(<a href="unittest.case.html#TestCase">unittest.case.TestCase</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A base class to simplify writing unit tests for PageTest subclasses.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="telemetry.testing.page_test_test_case.html#PageTestTestCase">PageTestTestCase</a></dd>
<dd><a href="unittest.case.html#TestCase">unittest.case.TestCase</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="PageTestTestCase-CreateEmptyPageSet"><strong>CreateEmptyPageSet</strong></a>(self)</dt></dl>
<dl><dt><a name="PageTestTestCase-CreateStorySetFromFileInUnittestDataDir"><strong>CreateStorySetFromFileInUnittestDataDir</strong></a>(self, test_filename)</dt></dl>
<dl><dt><a name="PageTestTestCase-RunMeasurement"><strong>RunMeasurement</strong></a>(self, measurement, ps, options<font color="#909090">=None</font>)</dt><dd><tt>Runs a measurement against a pageset, returning the rows its outputs.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-TestTracingCleanedUp"><strong>TestTracingCleanedUp</strong></a>(self, measurement_class, options<font color="#909090">=None</font>)</dt></dl>
<hr>
Methods inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br>
<dl><dt><a name="PageTestTestCase-__call__"><strong>__call__</strong></a>(self, *args, **kwds)</dt></dl>
<dl><dt><a name="PageTestTestCase-__eq__"><strong>__eq__</strong></a>(self, other)</dt></dl>
<dl><dt><a name="PageTestTestCase-__hash__"><strong>__hash__</strong></a>(self)</dt></dl>
<dl><dt><a name="PageTestTestCase-__init__"><strong>__init__</strong></a>(self, methodName<font color="#909090">='runTest'</font>)</dt><dd><tt>Create an instance of the class that will use the named test<br>
method when executed. Raises a ValueError if the instance does<br>
not have a method with the specified name.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-__ne__"><strong>__ne__</strong></a>(self, other)</dt></dl>
<dl><dt><a name="PageTestTestCase-__repr__"><strong>__repr__</strong></a>(self)</dt></dl>
<dl><dt><a name="PageTestTestCase-__str__"><strong>__str__</strong></a>(self)</dt></dl>
<dl><dt><a name="PageTestTestCase-addCleanup"><strong>addCleanup</strong></a>(self, function, *args, **kwargs)</dt><dd><tt>Add a function, with arguments, to be called when the test is<br>
completed. Functions added are called on a LIFO basis and are<br>
called after tearDown on test failure or success.<br>
<br>
Cleanup items are called even if setUp fails (unlike tearDown).</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-addTypeEqualityFunc"><strong>addTypeEqualityFunc</strong></a>(self, typeobj, function)</dt><dd><tt>Add a type specific assertEqual style function to compare a type.<br>
<br>
This method is for use by <a href="unittest.case.html#TestCase">TestCase</a> subclasses that need to register<br>
their own type equality functions to provide nicer error messages.<br>
<br>
Args:<br>
typeobj: The data type to call this function on when both values<br>
are of the same type in <a href="#PageTestTestCase-assertEqual">assertEqual</a>().<br>
function: The callable taking two arguments and an optional<br>
msg= argument that raises self.<strong>failureException</strong> with a<br>
useful error message when the two arguments are not equal.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertAlmostEqual"><strong>assertAlmostEqual</strong></a>(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br>
difference rounded to the given number of decimal places<br>
(default 7) and comparing to zero, or by comparing that the<br>
between the two objects is more than the given delta.<br>
<br>
Note that decimal places (from zero) are usually not the same<br>
as significant digits (measured from the most signficant digit).<br>
<br>
If the two objects compare equal then they will automatically<br>
compare almost equal.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertAlmostEquals"><strong>assertAlmostEquals</strong></a> = assertAlmostEqual(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by their<br>
difference rounded to the given number of decimal places<br>
(default 7) and comparing to zero, or by comparing that the<br>
between the two objects is more than the given delta.<br>
<br>
Note that decimal places (from zero) are usually not the same<br>
as significant digits (measured from the most signficant digit).<br>
<br>
If the two objects compare equal then they will automatically<br>
compare almost equal.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertDictContainsSubset"><strong>assertDictContainsSubset</strong></a>(self, expected, actual, msg<font color="#909090">=None</font>)</dt><dd><tt>Checks whether actual is a superset of expected.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertDictEqual"><strong>assertDictEqual</strong></a>(self, d1, d2, msg<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="PageTestTestCase-assertEqual"><strong>assertEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br>
operator.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertEquals"><strong>assertEquals</strong></a> = assertEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are unequal as determined by the '=='<br>
operator.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertFalse"><strong>assertFalse</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Check that the expression is false.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertGreater"><strong>assertGreater</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#PageTestTestCase-assertTrue">assertTrue</a>(a > b), but with a nicer default message.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertGreaterEqual"><strong>assertGreaterEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#PageTestTestCase-assertTrue">assertTrue</a>(a >= b), but with a nicer default message.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertIn"><strong>assertIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#PageTestTestCase-assertTrue">assertTrue</a>(a in b), but with a nicer default message.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertIs"><strong>assertIs</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#PageTestTestCase-assertTrue">assertTrue</a>(a is b), but with a nicer default message.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertIsInstance"><strong>assertIsInstance</strong></a>(self, obj, cls, msg<font color="#909090">=None</font>)</dt><dd><tt>Same as <a href="#PageTestTestCase-assertTrue">assertTrue</a>(isinstance(obj, cls)), with a nicer<br>
default message.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertIsNone"><strong>assertIsNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Same as <a href="#PageTestTestCase-assertTrue">assertTrue</a>(obj is None), with a nicer default message.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertIsNot"><strong>assertIsNot</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#PageTestTestCase-assertTrue">assertTrue</a>(a is not b), but with a nicer default message.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertIsNotNone"><strong>assertIsNotNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Included for symmetry with assertIsNone.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertItemsEqual"><strong>assertItemsEqual</strong></a>(self, expected_seq, actual_seq, msg<font color="#909090">=None</font>)</dt><dd><tt>An unordered sequence specific comparison. It asserts that<br>
actual_seq and expected_seq have the same element counts.<br>
Equivalent to::<br>
<br>
<a href="#PageTestTestCase-assertEqual">assertEqual</a>(Counter(iter(actual_seq)),<br>
Counter(iter(expected_seq)))<br>
<br>
Asserts that each element has the same count in both sequences.<br>
Example:<br>
- [0, 1, 1] and [1, 0, 1] compare equal.<br>
- [0, 0, 1] and [0, 1] compare unequal.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertLess"><strong>assertLess</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#PageTestTestCase-assertTrue">assertTrue</a>(a < b), but with a nicer default message.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertLessEqual"><strong>assertLessEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#PageTestTestCase-assertTrue">assertTrue</a>(a <= b), but with a nicer default message.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertListEqual"><strong>assertListEqual</strong></a>(self, list1, list2, msg<font color="#909090">=None</font>)</dt><dd><tt>A list-specific equality assertion.<br>
<br>
Args:<br>
list1: The first list to compare.<br>
list2: The second list to compare.<br>
msg: Optional message to use on failure instead of a list of<br>
differences.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertMultiLineEqual"><strong>assertMultiLineEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Assert that two multi-line strings are equal.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertNotAlmostEqual"><strong>assertNotAlmostEqual</strong></a>(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br>
difference rounded to the given number of decimal places<br>
(default 7) and comparing to zero, or by comparing that the<br>
between the two objects is less than the given delta.<br>
<br>
Note that decimal places (from zero) are usually not the same<br>
as significant digits (measured from the most signficant digit).<br>
<br>
Objects that are equal automatically fail.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertNotAlmostEquals"><strong>assertNotAlmostEquals</strong></a> = assertNotAlmostEqual(self, first, second, places<font color="#909090">=None</font>, msg<font color="#909090">=None</font>, delta<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by their<br>
difference rounded to the given number of decimal places<br>
(default 7) and comparing to zero, or by comparing that the<br>
between the two objects is less than the given delta.<br>
<br>
Note that decimal places (from zero) are usually not the same<br>
as significant digits (measured from the most signficant digit).<br>
<br>
Objects that are equal automatically fail.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertNotEqual"><strong>assertNotEqual</strong></a>(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '!='<br>
operator.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertNotEquals"><strong>assertNotEquals</strong></a> = assertNotEqual(self, first, second, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail if the two objects are equal as determined by the '!='<br>
operator.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertNotIn"><strong>assertNotIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#PageTestTestCase-assertTrue">assertTrue</a>(a not in b), but with a nicer default message.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertNotIsInstance"><strong>assertNotIsInstance</strong></a>(self, obj, cls, msg<font color="#909090">=None</font>)</dt><dd><tt>Included for symmetry with assertIsInstance.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertNotRegexpMatches"><strong>assertNotRegexpMatches</strong></a>(self, text, unexpected_regexp, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test if the text matches the regular expression.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertRaises"><strong>assertRaises</strong></a>(self, excClass, callableObj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Fail unless an exception of class excClass is raised<br>
by callableObj when invoked with arguments args and keyword<br>
arguments kwargs. If a different type of exception is<br>
raised, it will not be caught, and the test case will be<br>
deemed to have suffered an error, exactly as for an<br>
unexpected exception.<br>
<br>
If called with callableObj omitted or None, will return a<br>
context object used like this::<br>
<br>
with <a href="#PageTestTestCase-assertRaises">assertRaises</a>(SomeException):<br>
do_something()<br>
<br>
The context manager keeps a reference to the exception as<br>
the 'exception' attribute. This allows you to inspect the<br>
exception after the assertion::<br>
<br>
with <a href="#PageTestTestCase-assertRaises">assertRaises</a>(SomeException) as cm:<br>
do_something()<br>
the_exception = cm.exception<br>
<a href="#PageTestTestCase-assertEqual">assertEqual</a>(the_exception.error_code, 3)</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertRaisesRegexp"><strong>assertRaisesRegexp</strong></a>(self, expected_exception, expected_regexp, callable_obj<font color="#909090">=None</font>, *args, **kwargs)</dt><dd><tt>Asserts that the message in a raised exception matches a regexp.<br>
<br>
Args:<br>
expected_exception: Exception class expected to be raised.<br>
expected_regexp: Regexp (re pattern object or string) expected<br>
to be found in error message.<br>
callable_obj: Function to be called.<br>
args: Extra args.<br>
kwargs: Extra kwargs.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertRegexpMatches"><strong>assertRegexpMatches</strong></a>(self, text, expected_regexp, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail the test unless the text matches the regular expression.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertSequenceEqual"><strong>assertSequenceEqual</strong></a>(self, seq1, seq2, msg<font color="#909090">=None</font>, seq_type<font color="#909090">=None</font>)</dt><dd><tt>An equality assertion for ordered sequences (like lists and tuples).<br>
<br>
For the purposes of this function, a valid ordered sequence type is one<br>
which can be indexed, has a length, and has an equality operator.<br>
<br>
Args:<br>
seq1: The first sequence to compare.<br>
seq2: The second sequence to compare.<br>
seq_type: The expected datatype of the sequences, or None if no<br>
datatype should be enforced.<br>
msg: Optional message to use on failure instead of a list of<br>
differences.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertSetEqual"><strong>assertSetEqual</strong></a>(self, set1, set2, msg<font color="#909090">=None</font>)</dt><dd><tt>A set-specific equality assertion.<br>
<br>
Args:<br>
set1: The first set to compare.<br>
set2: The second set to compare.<br>
msg: Optional message to use on failure instead of a list of<br>
differences.<br>
<br>
assertSetEqual uses ducktyping to support different types of sets, and<br>
is optimized for sets specifically (parameters must support a<br>
difference method).</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertTrue"><strong>assertTrue</strong></a>(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Check that the expression is true.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assertTupleEqual"><strong>assertTupleEqual</strong></a>(self, tuple1, tuple2, msg<font color="#909090">=None</font>)</dt><dd><tt>A tuple-specific equality assertion.<br>
<br>
Args:<br>
tuple1: The first tuple to compare.<br>
tuple2: The second tuple to compare.<br>
msg: Optional message to use on failure instead of a list of<br>
differences.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-assert_"><strong>assert_</strong></a> = assertTrue(self, expr, msg<font color="#909090">=None</font>)</dt><dd><tt>Check that the expression is true.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-countTestCases"><strong>countTestCases</strong></a>(self)</dt></dl>
<dl><dt><a name="PageTestTestCase-debug"><strong>debug</strong></a>(self)</dt><dd><tt>Run the test without collecting errors in a TestResult</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-defaultTestResult"><strong>defaultTestResult</strong></a>(self)</dt></dl>
<dl><dt><a name="PageTestTestCase-doCleanups"><strong>doCleanups</strong></a>(self)</dt><dd><tt>Execute all cleanup functions. Normally called for you after<br>
tearDown.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-fail"><strong>fail</strong></a>(self, msg<font color="#909090">=None</font>)</dt><dd><tt>Fail immediately, with the given message.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-failIf"><strong>failIf</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
<dl><dt><a name="PageTestTestCase-failIfAlmostEqual"><strong>failIfAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
<dl><dt><a name="PageTestTestCase-failIfEqual"><strong>failIfEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
<dl><dt><a name="PageTestTestCase-failUnless"><strong>failUnless</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
<dl><dt><a name="PageTestTestCase-failUnlessAlmostEqual"><strong>failUnlessAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
<dl><dt><a name="PageTestTestCase-failUnlessEqual"><strong>failUnlessEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
<dl><dt><a name="PageTestTestCase-failUnlessRaises"><strong>failUnlessRaises</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
<dl><dt><a name="PageTestTestCase-id"><strong>id</strong></a>(self)</dt></dl>
<dl><dt><a name="PageTestTestCase-run"><strong>run</strong></a>(self, result<font color="#909090">=None</font>)</dt></dl>
<dl><dt><a name="PageTestTestCase-setUp"><strong>setUp</strong></a>(self)</dt><dd><tt>Hook method for setting up the test fixture before exercising it.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-shortDescription"><strong>shortDescription</strong></a>(self)</dt><dd><tt>Returns a one-line description of the test, or None if no<br>
description has been provided.<br>
<br>
The default implementation of this method returns the first line of<br>
the specified test method's docstring.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-skipTest"><strong>skipTest</strong></a>(self, reason)</dt><dd><tt>Skip this test.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-tearDown"><strong>tearDown</strong></a>(self)</dt><dd><tt>Hook method for deconstructing the test fixture after testing it.</tt></dd></dl>
<hr>
Class methods inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br>
<dl><dt><a name="PageTestTestCase-setUpClass"><strong>setUpClass</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Hook method for setting up class fixture before running tests in the class.</tt></dd></dl>
<dl><dt><a name="PageTestTestCase-tearDownClass"><strong>tearDownClass</strong></a>(cls)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Hook method for deconstructing the class fixture after running all tests in the class.</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br>
<dl><dt><strong>failureException</strong> = <type 'exceptions.AssertionError'><dd><tt>Assertion failed.</tt></dl>
<dl><dt><strong>longMessage</strong> = False</dl>
<dl><dt><strong>maxDiff</strong> = 640</dl>
</td></tr></table></td></tr></table>
</body></html>