mirror of
https://github.com/jlengrand/Tippy.git
synced 2026-03-10 08:51:16 +00:00
Modifies Ant file to run all commands from base dir.
base dir is set to be . (Tippy root folder). Every compilation/test/... should be run from here. Updates doc Reported-by: Julien Lengrand-Lambert Signed-off-by: Julien Lengrand-Lambert <julien@lengrandlambert.fr>
This commit is contained in:
Julien Lengrand-Lambert
@@ -14,13 +14,13 @@
|
||||
</target>
|
||||
<!--Compiling sources -->
|
||||
<target name="compile all">
|
||||
<py-compile dir="${src.dir}" pythonpath="${src.dir}" optimize="0"/>
|
||||
<py-compile dir="${base.dir}" pythonpath="${src.dir}" optimize="0"/>
|
||||
</target>
|
||||
<target name="compile examples">
|
||||
<py-compile dir="${ex.dir}" pythonpath="${ex.dir}" optimize="0"/>
|
||||
<py-compile dir="${base.dir}" pythonpath="${ex.dir}" optimize="0"/>
|
||||
</target>
|
||||
<target name="compile tests">
|
||||
<py-compile dir="${tests.dir}" pythonpath="${tests.dir}" optimize="0"/>
|
||||
<py-compile dir="${base.dir}" pythonpath="${tests.dir}" optimize="0"/>
|
||||
</target>
|
||||
<!--Run all tests -->
|
||||
<target name="tests">
|
||||
|
||||
@@ -17,6 +17,7 @@
|
||||
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</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="examples.region_growing.html">region_growing</a><br>
|
||||
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table>
|
||||
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="examples.histogram_display.html">histogram_display</a><br>
|
||||
</td><td width="25%" valign=top><a href="examples.region_growing.html">region_growing</a><br>
|
||||
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table>
|
||||
</body></html>
|
||||
@@ -18,8 +18,9 @@
|
||||
|
||||
<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="tippy.basic_operations.html">basic_operations</a><br>
|
||||
</td><td width="25%" valign=top><a href="tippy.display_operations.html">display_operations</a><br>
|
||||
<a href="tippy.display_operations.html">display_operations</a><br>
|
||||
</td><td width="25%" valign=top><a href="tippy.segmentations.html">segmentations</a><br>
|
||||
<a href="tippy.statistics.html">statistics</a><br>
|
||||
</td><td width="25%" valign=top><a href="tippy.tests.html"><strong>tests</strong> (package)</a><br>
|
||||
</td></tr></table></td></tr></table>
|
||||
</td><td width="25%" valign=top></td></tr></table></td></tr></table>
|
||||
</body></html>
|
||||
81
doc/tippy.statistics.html
Normal file
81
doc/tippy.statistics.html
Normal file
@@ -0,0 +1,81 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: module tippy.statistics</title>
|
||||
</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="tippy.html"><font color="#ffffff">tippy</font></a>.statistics</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jlengrand/git/Tippy/tippy/statistics.py">/home/jlengrand/git/Tippy/tippy/statistics.py</a></font></td></tr></table>
|
||||
<p><tt>Contains functions related to statistics processing. <br>
|
||||
<br>
|
||||
Created on Dec 11, 2011<br>
|
||||
<br>
|
||||
@author: Julien Lengrand-Lambert<br>
|
||||
@email: julien@lengrand.fr</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="cv.html">cv</a><br>
|
||||
</td><td width="25%" valign=top><a href="sys.html">sys</a><br>
|
||||
</td><td width="25%" valign=top></td><td width="25%" valign=top></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="tippy.statistics.html#Histogram">Histogram</a>
|
||||
</font></dt></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="Histogram">class <strong>Histogram</strong></a></font></td></tr>
|
||||
|
||||
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||||
<td colspan=2><tt>This class is designed to contain an openCV class plus some more information<br>
|
||||
to ease further operations.<br>
|
||||
<br>
|
||||
NOTE : Supports only 8 bits images for now. <br>
|
||||
More should be added soon.<br> </tt></td></tr>
|
||||
<tr><td> </td>
|
||||
<td width="100%">Methods defined here:<br>
|
||||
<dl><dt><a name="Histogram-__init__"><strong>__init__</strong></a>(self, img, bin_fact<font color="#909090">=8L</font>, min_range<font color="#909090">=0</font>)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Histogram-channel_to_image"><strong>channel_to_image</strong></a>(self, chan, scale_x<font color="#909090">=3</font>, scale_y<font color="#909090">=3</font>, y_range<font color="#909090">=64</font>)</dt><dd><tt>Creates an iplimage displaying histogram results after its computation</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Histogram-compute_histogram"><strong>compute_histogram</strong></a>(self, img, bin_fact<font color="#909090">=8L</font>, min_range<font color="#909090">=0</font>)</dt><dd><tt>Creates the histogram of the input image<br>
|
||||
<br>
|
||||
Returns a Tippy histogram, with one item by channel of input image.<br>
|
||||
The number of bins is 2^bin_fact (256 by default)<br>
|
||||
min_range is the value of the lowest bin<br>
|
||||
max_range is automatically calculated using the input image depth. <br>
|
||||
max_range = (2^img_depth)<br>
|
||||
<br>
|
||||
NOTE : Supports only 8 bits images for now. <br>
|
||||
More should be added soon.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Histogram-to_images"><strong>to_images</strong></a>(self, scale_x<font color="#909090">=3</font>, scale_y<font color="#909090">=3</font>, y_range<font color="#909090">=64</font>)</dt><dd><tt>Creates a graphical representation of an histogram.<br>
|
||||
Outputs a list of nChannels iplimages, one for each channel of the <br>
|
||||
histogram. <br>
|
||||
The images should have the same depth as the image used to create the <br>
|
||||
histogram.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Histogram-to_tables"><strong>to_tables</strong></a>(self)</dt><dd><tt>Transforms an histogram into a list of values.<br>
|
||||
This way, it is easier to process for calculations.<br>
|
||||
<br>
|
||||
Returns a list of nChannels items.<br>
|
||||
<br>
|
||||
NOTE : Supports only 8 bits images for now. <br>
|
||||
More should be added soon.</tt></dd></dl>
|
||||
|
||||
</td></tr></table></td></tr></table>
|
||||
</body></html>
|
||||
@@ -20,5 +20,6 @@
|
||||
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="tippy.tests.test_basic_operations.html">test_basic_operations</a><br>
|
||||
</td><td width="25%" valign=top><a href="tippy.tests.test_display_operations.html">test_display_operations</a><br>
|
||||
</td><td width="25%" valign=top><a href="tippy.tests.test_segmentation.html">test_segmentation</a><br>
|
||||
</td><td width="25%" valign=top></td></tr></table></td></tr></table>
|
||||
</td><td width="25%" valign=top><a href="tippy.tests.test_statistics.html">test_statistics</a><br>
|
||||
</td></tr></table></td></tr></table>
|
||||
</body></html>
|
||||
344
doc/tippy.tests.test_statistics.html
Normal file
344
doc/tippy.tests.test_statistics.html
Normal file
@@ -0,0 +1,344 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html><head><title>Python: module tippy.tests.test_statistics</title>
|
||||
</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="tippy.html"><font color="#ffffff">tippy</font></a>.<a href="tippy.tests.html"><font color="#ffffff">tests</font></a>.test_statistics</strong></big></big></font></td
|
||||
><td align=right valign=bottom
|
||||
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jlengrand/git/Tippy/tippy/tests/test_statistics.py">/home/jlengrand/git/Tippy/tippy/tests/test_statistics.py</a></font></td></tr></table>
|
||||
<p><tt>Created on Dec 11, 2011<br>
|
||||
<br>
|
||||
@author: Julien Lengrand-Lambert<br>
|
||||
@email: julien@lengrand.fr</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="cv.html">cv</a><br>
|
||||
</td><td width="25%" valign=top><a href="tippy.statistics.html">tippy.statistics</a><br>
|
||||
</td><td width="25%" valign=top><a href="unittest.html">unittest</a><br>
|
||||
</td><td width="25%" valign=top></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="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="tippy.tests.test_statistics.html#Test">Test</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="Test">class <strong>Test</strong></a>(<a href="unittest.case.html#TestCase">unittest.case.TestCase</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="tippy.tests.test_statistics.html#Test">Test</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="Test-setUp"><strong>setUp</strong></a>(self)</dt><dd><tt>This method is called before each test</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Test-tearDown"><strong>tearDown</strong></a>(self)</dt><dd><tt>This method is called after each test</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Test-test_channel_to_image"><strong>test_channel_to_image</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-test_compute_histogram"><strong>test_compute_histogram</strong></a>(self)</dt><dd><tt>#--- <br>
|
||||
## TESTS</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Test-test_to_images"><strong>test_to_images</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-test_to_tables"><strong>test_to_tables</strong></a>(self)</dt></dl>
|
||||
|
||||
<hr>
|
||||
Methods inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br>
|
||||
<dl><dt><a name="Test-__call__"><strong>__call__</strong></a>(self, *args, **kwds)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-__eq__"><strong>__eq__</strong></a>(self, other)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-__hash__"><strong>__hash__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-__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="Test-__ne__"><strong>__ne__</strong></a>(self, other)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-__repr__"><strong>__repr__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-__str__"><strong>__str__</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-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="Test-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="#Test-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="Test-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="Test-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="Test-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="Test-assertDictEqual"><strong>assertDictEqual</strong></a>(self, d1, d2, msg<font color="#909090">=None</font>)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-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="Test-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="Test-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="Test-assertGreater"><strong>assertGreater</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a > b), but with a nicer default message.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Test-assertGreaterEqual"><strong>assertGreaterEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a >= b), but with a nicer default message.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Test-assertIn"><strong>assertIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a in b), but with a nicer default message.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Test-assertIs"><strong>assertIs</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a is b), but with a nicer default message.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Test-assertIsInstance"><strong>assertIsInstance</strong></a>(self, obj, cls, msg<font color="#909090">=None</font>)</dt><dd><tt>Same as <a href="#Test-assertTrue">assertTrue</a>(isinstance(obj, cls)), with a nicer<br>
|
||||
default message.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Test-assertIsNone"><strong>assertIsNone</strong></a>(self, obj, msg<font color="#909090">=None</font>)</dt><dd><tt>Same as <a href="#Test-assertTrue">assertTrue</a>(obj is None), with a nicer default message.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Test-assertIsNot"><strong>assertIsNot</strong></a>(self, expr1, expr2, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a is not b), but with a nicer default message.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Test-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="Test-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="#Test-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="Test-assertLess"><strong>assertLess</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a < b), but with a nicer default message.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Test-assertLessEqual"><strong>assertLessEqual</strong></a>(self, a, b, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a <= b), but with a nicer default message.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Test-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="Test-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="Test-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="Test-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="Test-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="Test-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="Test-assertNotIn"><strong>assertNotIn</strong></a>(self, member, container, msg<font color="#909090">=None</font>)</dt><dd><tt>Just like <a href="#Test-assertTrue">assertTrue</a>(a not in b), but with a nicer default message.</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Test-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="Test-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="Test-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 thrown<br>
|
||||
by callableObj when invoked with arguments args and keyword<br>
|
||||
arguments kwargs. If a different type of exception is<br>
|
||||
thrown, 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="#Test-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="#Test-assertRaises">assertRaises</a>(SomeException) as cm:<br>
|
||||
do_something()<br>
|
||||
the_exception = cm.exception<br>
|
||||
<a href="#Test-assertEqual">assertEqual</a>(the_exception.error_code, 3)</tt></dd></dl>
|
||||
|
||||
<dl><dt><a name="Test-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="Test-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="Test-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="Test-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="Test-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="Test-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="Test-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="Test-countTestCases"><strong>countTestCases</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-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="Test-defaultTestResult"><strong>defaultTestResult</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-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="Test-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="Test-failIf"><strong>failIf</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-failIfAlmostEqual"><strong>failIfAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-failIfEqual"><strong>failIfEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-failUnless"><strong>failUnless</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-failUnlessAlmostEqual"><strong>failUnlessAlmostEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-failUnlessEqual"><strong>failUnlessEqual</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-failUnlessRaises"><strong>failUnlessRaises</strong></a> = deprecated_func(*args, **kwargs)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-id"><strong>id</strong></a>(self)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-run"><strong>run</strong></a>(self, result<font color="#909090">=None</font>)</dt></dl>
|
||||
|
||||
<dl><dt><a name="Test-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="Test-skipTest"><strong>skipTest</strong></a>(self, reason)</dt><dd><tt>Skip this test.</tt></dd></dl>
|
||||
|
||||
<hr>
|
||||
Class methods inherited from <a href="unittest.case.html#TestCase">unittest.case.TestCase</a>:<br>
|
||||
<dl><dt><a name="Test-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="Test-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>
|
||||
Reference in New Issue
Block a user