[Epydoc-commits] SF.net SVN: epydoc: [1293] trunk/epydoc/src/epydoc/test
Brought to you by:
edloper
Menu
▾
▴
[Epydoc-commits] SF.net SVN: epydoc: [1293] trunk/epydoc/src/epydoc/test
|
From: <ed...@us...> - 2006-08-22 16:43:12
|
Revision: 1293 Author: edloper Date: 2006-08-22 09:43:07 -0700 (Tue, 22 Aug 2006) ViewCVS: http://svn.sourceforge.net/epydoc/?rev=1293&view=rev Log Message: ----------- - Changed page title formatting to make rst happy. - Updated docparser tests to reflect the fact that the parse_repr field now uses normal (not tight) spacing. - Updated the encoding examples. Modified Paths: -------------- trunk/epydoc/src/epydoc/test/apidoc.doctest trunk/epydoc/src/epydoc/test/docintrospecter.doctest trunk/epydoc/src/epydoc/test/docparser.doctest trunk/epydoc/src/epydoc/test/encoding.doctest trunk/epydoc/src/epydoc/test/epytext.doctest Modified: trunk/epydoc/src/epydoc/test/apidoc.doctest =================================================================== --- trunk/epydoc/src/epydoc/test/apidoc.doctest 2006-08-22 15:11:17 UTC (rev 1292) +++ trunk/epydoc/src/epydoc/test/apidoc.doctest 2006-08-22 16:43:07 UTC (rev 1293) @@ -1,5 +1,5 @@ - Regression Testing for epydoc.apidoc - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Regression Testing for epydoc.apidoc +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This file serves to provide both documentation and regression tests for the epydoc.apidoc module. The main purpose of this module is to define the `APIDoc` class hierarchy, which is used to encode API Modified: trunk/epydoc/src/epydoc/test/docintrospecter.doctest =================================================================== --- trunk/epydoc/src/epydoc/test/docintrospecter.doctest 2006-08-22 15:11:17 UTC (rev 1292) +++ trunk/epydoc/src/epydoc/test/docintrospecter.doctest 2006-08-22 16:43:07 UTC (rev 1293) @@ -1,5 +1,5 @@ - Regression Testing for epydoc.docintrospecter - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Regression Testing for epydoc.docintrospecter +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The `epydoc.docintrospecter` module is used to extract API documentation by introspecting Python objects directy. Its primary interface is `introspect_docs()`, which takes a Python object, and returns a Modified: trunk/epydoc/src/epydoc/test/docparser.doctest =================================================================== --- trunk/epydoc/src/epydoc/test/docparser.doctest 2006-08-22 15:11:17 UTC (rev 1292) +++ trunk/epydoc/src/epydoc/test/docparser.doctest 2006-08-22 16:43:07 UTC (rev 1293) @@ -1,5 +1,5 @@ - Regression Testing for epydoc.docparser - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Regression Testing for epydoc.docparser +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The `epydoc.docparser` module is used to extract API documentation by parsing the source code of Python files. Its primary interface is `parse_docs()`, which takes a module's filename, and returns a @@ -101,7 +101,7 @@ | +- defining_module | | +- ModuleDoc for test [0] (defined above) | +- docs_extracted_by = 'parser' - | +- parse_repr = u'[1,2,3]+ [4,5]' + | +- parse_repr = u'[1, 2, 3]+ [4, 5]' | +- toktree = [[(51, u'['), (2, u'1'), (51, u','), ... +- z => VariableDoc for test.z [5] +- container @@ -117,7 +117,7 @@ +- defining_module | +- ModuleDoc for test [0] (defined above) +- docs_extracted_by = 'parser' - +- parse_repr = u'f(x,y)' + +- parse_repr = u'f(x, y)' +- toktree = [(1, u'f'), [(51, u'('), (1, u'x'), (... In this example, DocParser decides that the assignment to y is @@ -136,7 +136,7 @@ | +- name = u'x' | +- value | +- GenericValueDoc [2] - | +- parse_repr = u'[1,2]' + | +- parse_repr = u'[1, 2]' +- y => VariableDoc for test.y [3] +- is_alias = True +- name = u'y' @@ -233,17 +233,19 @@ ===================== DocParser will look inside certain types of module-level control blocks. By default, DocParser looks inside the following block types: - - if blocks - - elif blocks - - else blocks - - try blocks - - except blocks - - finally blocks +- if blocks +- elif blocks +- else blocks +- try blocks +- except blocks +- finally blocks + By default, DocParse does not look inside the following block types: - - while blocks - - for blocks +- while blocks +- for blocks + >>> # DocParser looks inside if/elif/else blocks. >>> runparser(s=""" ... if condition: @@ -409,6 +411,7 @@ ... """, show="f", exclude='defining_module') RoutineDoc for test.f [0] +- canonical_name = DottedName('test', u'f') + +- decorators = [] +- docs_extracted_by = 'parser' +- docstring = u'docstring for f' +- docstring_lineno = 3 @@ -433,6 +436,7 @@ ... """, show="f", exclude='defining_module') RoutineDoc for test.f [0] +- canonical_name = DottedName('test', u'f') + +- decorators = [] +- docs_extracted_by = 'parser' +- docstring = u'docstring for f' +- docstring_lineno = 3 @@ -448,6 +452,7 @@ ... """, show="f", exclude='defining_module') RoutineDoc for test.f [0] +- canonical_name = DottedName('test', u'f') + +- decorators = [] +- docs_extracted_by = 'parser' +- kwarg = None +- lineno = 2 Modified: trunk/epydoc/src/epydoc/test/encoding.doctest =================================================================== --- trunk/epydoc/src/epydoc/test/encoding.doctest 2006-08-22 15:11:17 UTC (rev 1292) +++ trunk/epydoc/src/epydoc/test/encoding.doctest 2006-08-22 16:43:07 UTC (rev 1293) @@ -1,5 +1,5 @@ - End-to-end Tests for Unicode Encoding - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +End-to-end Tests for Unicode Encoding +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Test Function ============= The following function is used as an end-to-end test for unicode @@ -115,23 +115,23 @@ >>> # UTF-8 with a coding directive: >>> test("# -*- coding: utf-8 -*-\n"+utf8_test) <p>abc ABC 123</p> - <p>0x80-0x7ff range: €  ߾ ߿</p> - <p>0x800-0xffff range: ࠀ ࠁ  </p> - 0x10000-0x10ffff range: 𐀀 𐀁   + <p>0x80-0x7ff range: €  ߾ ߿</p> + <p>0x800-0xffff range: ࠀ ࠁ  </p> + 0x10000-0x10ffff range: 𐀀 𐀁   >>> # UTF-8 with a BOM & a coding directive: >>> test(utf8_bom+"# -*- coding: utf-8 -*-\n"+utf8_test) <p>abc ABC 123</p> - <p>0x80-0x7ff range: €  ߾ ߿</p> - <p>0x800-0xffff range: ࠀ ࠁ  </p> - 0x10000-0x10ffff range: 𐀀 𐀁   + <p>0x80-0x7ff range: €  ߾ ߿</p> + <p>0x800-0xffff range: ࠀ ࠁ  </p> + 0x10000-0x10ffff range: 𐀀 𐀁   >>> # UTF-8 with a BOM & no coding directive: >>> test(utf8_bom+utf8_test) <p>abc ABC 123</p> - <p>0x80-0x7ff range: €  ߾ ߿</p> - <p>0x800-0xffff range: ࠀ ࠁ  </p> - 0x10000-0x10ffff range: 𐀀 𐀁   + <p>0x80-0x7ff range: €  ߾ ߿</p> + <p>0x800-0xffff range: ࠀ ࠁ  </p> + 0x10000-0x10ffff range: 𐀀 𐀁   Tests for KOI8-R: @@ -154,15 +154,15 @@ >>> test("\n# -*- coding: utf-8 -*-\n"+utf8_test) <p>abc ABC 123</p> - <p>0x80-0x7ff range: €  ߾ ߿</p> - <p>0x800-0xffff range: ࠀ ࠁ  </p> - 0x10000-0x10ffff range: 𐀀 𐀁   + <p>0x80-0x7ff range: €  ߾ ߿</p> + <p>0x800-0xffff range: ࠀ ࠁ  </p> + 0x10000-0x10ffff range: 𐀀 𐀁   >>> test("# comment\n# -*- coding: utf-8 -*-\n"+utf8_test) <p>abc ABC 123</p> - <p>0x80-0x7ff range: €  ߾ ߿</p> - <p>0x800-0xffff range: ࠀ ࠁ  </p> - 0x10000-0x10ffff range: 𐀀 𐀁   + <p>0x80-0x7ff range: €  ߾ ߿</p> + <p>0x800-0xffff range: ࠀ ࠁ  </p> + 0x10000-0x10ffff range: 𐀀 𐀁   Tests for shift-jis @@ -187,11 +187,12 @@ Under special circumstances, we may not be able to tell what the proper encoding for a docstring is. This happens if: - 1. the docstring is only available via introspection. - 2. we are unable to determine what module the object that owns - the docstring came from. - 3. the docstring contains non-ascii characters +1. the docstring is only available via introspection. +2. we are unable to determine what module the object that owns + the docstring came from. +3. the docstring contains non-ascii characters + Under these circumstances, we issue a warning, and treat the docstring as latin-1. An example of this is a non-unicode docstring for properties: @@ -210,35 +211,35 @@ >>> test("# -*- coding: utf-8 -*-\n"+utf8_test, introspect=False) <p>abc ABC 123</p> - <p>0x80-0x7ff range: €  ߾ ߿</p> - <p>0x800-0xffff range: ࠀ ࠁ  </p> - 0x10000-0x10ffff range: 𐀀 𐀁   + <p>0x80-0x7ff range: €  ߾ ߿</p> + <p>0x800-0xffff range: ࠀ ࠁ  </p> + 0x10000-0x10ffff range: 𐀀 𐀁   >>> test(utf8_bom+"# -*- coding: utf-8 -*-\n"+utf8_test, introspect=False) <p>abc ABC 123</p> - <p>0x80-0x7ff range: €  ߾ ߿</p> - <p>0x800-0xffff range: ࠀ ࠁ  </p> - 0x10000-0x10ffff range: 𐀀 𐀁   + <p>0x80-0x7ff range: €  ߾ ߿</p> + <p>0x800-0xffff range: ࠀ ࠁ  </p> + 0x10000-0x10ffff range: 𐀀 𐀁   >>> test(utf8_bom+utf8_test, introspect=False) <p>abc ABC 123</p> - <p>0x80-0x7ff range: €  ߾ ߿</p> - <p>0x800-0xffff range: ࠀ ࠁ  </p> - 0x10000-0x10ffff range: 𐀀 𐀁   + <p>0x80-0x7ff range: €  ߾ ߿</p> + <p>0x800-0xffff range: ࠀ ࠁ  </p> + 0x10000-0x10ffff range: 𐀀 𐀁   >>> test("# -*- coding: utf-8 -*-\n"+utf8_test, parse=False) <p>abc ABC 123</p> - <p>0x80-0x7ff range: €  ߾ ߿</p> - <p>0x800-0xffff range: ࠀ ࠁ  </p> - 0x10000-0x10ffff range: 𐀀 𐀁   + <p>0x80-0x7ff range: €  ߾ ߿</p> + <p>0x800-0xffff range: ࠀ ࠁ  </p> + 0x10000-0x10ffff range: 𐀀 𐀁   >>> test(utf8_bom+"# -*- coding: utf-8 -*-\n"+utf8_test, parse=False) <p>abc ABC 123</p> - <p>0x80-0x7ff range: €  ߾ ߿</p> - <p>0x800-0xffff range: ࠀ ࠁ  </p> - 0x10000-0x10ffff range: 𐀀 𐀁   + <p>0x80-0x7ff range: €  ߾ ߿</p> + <p>0x800-0xffff range: ࠀ ࠁ  </p> + 0x10000-0x10ffff range: 𐀀 𐀁   >>> test(utf8_bom+utf8_test, parse=False) <p>abc ABC 123</p> - <p>0x80-0x7ff range: €  ߾ ߿</p> - <p>0x800-0xffff range: ࠀ ࠁ  </p> - 0x10000-0x10ffff range: 𐀀 𐀁   + <p>0x80-0x7ff range: €  ߾ ߿</p> + <p>0x800-0xffff range: ࠀ ࠁ  </p> + 0x10000-0x10ffff range: 𐀀 𐀁   Context checks ============== Modified: trunk/epydoc/src/epydoc/test/epytext.doctest =================================================================== --- trunk/epydoc/src/epydoc/test/epytext.doctest 2006-08-22 15:11:17 UTC (rev 1292) +++ trunk/epydoc/src/epydoc/test/epytext.doctest 2006-08-22 16:43:07 UTC (rev 1293) @@ -1,5 +1,5 @@ - Regression Testing for epytext - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Regression Testing for epytext +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ These tests were taken pretty much verbatim out of the old unittests from epydoc 2.1. They could use some serious updating, when I get the time, esp. given that it's so much easier to write tests with doctest This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |