Commit Graph

76 Commits

Author SHA1 Message Date
Tim Peters bf0400abe9 Remove doctest.testmod's deprecated (in 2.4) `isprivate`
argument.  A lot of hair went into supporting that!
2006-06-05 01:43:03 +00:00
George Yoshida f3c65de460 Patch #1080727: add "encoding" parameter to doctest.DocFileSuite
Contributed by Bjorn Tillenius.
2006-05-28 16:39:09 +00:00
George Yoshida ce5933f582 Use \versionchanged for the feature change 2006-05-06 14:16:51 +00:00
George Yoshida d3d8ecda15 describe optional arguments for DocFileSuite 2006-05-06 13:09:45 +00:00
Fred Drake f25fa6ddb9 avoid ugly markup based on the unfortunate conversions of ">>" and "<<" to
guillemets; no need for magic here
2006-05-03 02:04:40 +00:00
Neal Norwitz 327ea38cc4 Revert previous change, SKIP had a versionadded elsewhere 2006-04-25 05:49:42 +00:00
Neal Norwitz 85c767ac87 versionadded for SKIP 2006-04-25 05:04:35 +00:00
Tim Peters 711bf30b89 Patch #1475231: add a new SKIP doctest option, thanks to
Edward Loper.
2006-04-25 03:31:36 +00:00
Tim Peters 8dc73d2dc6 Bug #1337990: clarified that `doctest` does not support examples
requiring both expected output and an exception.

I'll backport to 2.4 next.
2006-04-24 02:03:16 +00:00
Raymond Hettinger 68804315e0 SF Patch #1093896: miscellaneous doc typos 2005-01-01 00:28:46 +00:00
Fred Drake 7c404a4bf7 add __file__ to the globals available for tests loaded via DocFileSuite;
this is useful for locating supporting data files, just as it is in Python
modules
2004-12-21 23:46:34 +00:00
Tim Peters 29978aedcb The docs claimed a test would pass that actually wouldn't pass. Repaired
the example so it does pass.
2004-10-04 03:34:32 +00:00
Edward Loper 0fe00aafc3 Added 2 notes about the complexities of testing SyntaxErrors. 2004-09-30 17:18:18 +00:00
Edward Loper 7d88a58e85 Reverted the addition of a NORMALIZE_NUMBERS option, per Tim Peter's
request.  Tim says that "correct 'fuzzy' comparison of floats cannot
be automated."  (The motivation behind adding the new option
was verifying interactive examples in Python's latex documentation;
several such examples use numbers that don't print consistently on
different platforms.)
2004-09-28 05:50:57 +00:00
Edward Loper aec3c9b54f Added a new NORMALIZE_NUMBERS option, which causes number literals in
the expected output to match corresponding number literals in the
actual output if their values are equal (to ten digits of precision).
2004-09-28 04:29:57 +00:00
Edward Loper a4c6a8522c - Added a "parser" option to testfile() and DocFileTest(). 2004-09-27 04:08:20 +00:00
Edward Loper 456ff91664 - Fixed typo in multi-line exception example
- Fixed indentation for a verbatim block
2004-09-27 03:30:44 +00:00
Tim Peters 36ee8ce373 Give a saner example for script_from_examples(); also mention an intended
but not entirely obvious use case.
2004-09-26 21:51:25 +00:00
Tim Peters 9463d8761b Made most module references "clickable". 2004-09-26 21:05:03 +00:00
Tim Peters 0041121c25 Docs for run_docstring_examples(). 2004-09-26 20:45:04 +00:00
Tim Peters 05b05febad Added a lot of new stuff to the debugging section. 2004-09-26 05:09:59 +00:00
Tim Peters 16be62f054 register_optionflag(): Moved from the Debugging section to the section
on option flags; added a versionadded decoration.
2004-09-26 02:38:41 +00:00
Tim Peters 6a0a64b7ad Document set_unittest_reportflags(). 2004-09-26 02:12:40 +00:00
Raymond Hettinger c90ea82302 Fix double word error. 2004-09-25 08:09:23 +00:00
Tim Peters 3f7912521d Assorted minor changes, plus a lot more soap. 2004-09-25 03:50:35 +00:00
Tim Peters 8c0a2cf938 Explain the motivation for the unittest functions, and beef up the
example.  Squash repeated argument descriptions.  Minor rewordings.
2004-09-25 03:02:23 +00:00
Tim Peters b2b26aca13 Repaired mistakes in the descriptions of testmod()/testfile(), and
squashed massive duplication of common argument descriptions.
2004-09-25 01:51:49 +00:00
Tim Peters 2dc820599b Since the doctest warnings section was reduced to one bullet point,
get rid of the itemize structure.
2004-09-25 01:30:16 +00:00
Tim Peters 39c5de0376 In the "doctest warnings" section, removed obsolete info, and noted that
ELLIPSIS can be used to deal with examples that embed object addresses.
2004-09-25 01:22:29 +00:00
Tim Peters 06cc847cee Beef up the section on testfile(), giving a complete example in
reStructuredText format.  Remove words describing the return value of
testmod() and testfile() in the intro sections, since it's never
useful in such simple cases.
2004-09-25 00:49:53 +00:00
Tim Peters cac5e7b81d Typo. 2004-09-25 00:11:43 +00:00
Tim Peters 7a082142d8 Since the LaTeX isn't doctest'ed, examples are always wrong <wink>. 2004-09-25 00:10:53 +00:00
Edward Loper b3666a3da2 - Updated docs to reflect changes in 2.4.
- Reorganized the documentation
  - Shifted focus a little more towards "literate testing"
  - Documented new functions and classes:
    - testfile()
    - Example, DocTest
    - DocTestParser, DocTestFinder, DocTestRunner, OutputChecker
    - DocFileSuite
    - DebugRunner, DocTestFailure, UnexpectedException
    - register_optionflag()
2004-09-21 03:00:51 +00:00
Edward Loper 6cc1350807 - Updated example output to match actual output
- Minor wording changes
- Changed the docs to reflect the fact that multiple option directives
  can be specified on a single line (and updated the directive
  production list, as well).
2004-09-19 01:16:44 +00:00
Tim Peters 8278860e52 Document testmod's new exclude_empty argument. 2004-09-13 15:03:17 +00:00
Tim Peters 1fbf9c5ec1 Added IGNORE_EXCEPTION_DETAIL comparison option. The need is explained
in the new docs.

DocTestRunner.__run:  Separate the determination of the example outcome
from reporting that outcome, to squash brittle code duplication and
excessive nesting.
2004-09-04 17:21:02 +00:00
Tim Peters 38330fe5ef The distinction between comparison flags and reporting flags isn't unique
to unittest, so make it official:  new module constants COMPARISON_FLAGS
and REPORTING_FLAGS, which are bitmasks or'ing together the relevant
individual option flags.

set_unittest_reportflags():  Reworked to use REPORTING_FLAGS, and
simplified overly complicated flag logic.

class FakeModule:  Removed this; neither documented nor used.
2004-08-30 16:19:24 +00:00
Tim Peters f33683fd40 Fine tune a word. 2004-08-26 04:52:46 +00:00
Tim Peters cf53355fcf Thinko repair. 2004-08-26 04:50:38 +00:00
Tim Peters a07bcd46f3 Reorg of exception section. Now that there are fewer details needing
explanation, it's easier to push the remaining insufferably anal details
into a "fine print" section at the bottom.
2004-08-26 04:47:31 +00:00
Edward Loper a89f88d53f Added REPORT_ONLY_FIRST_FAILURE flag, which supresses output after the
first failing example in each test.
2004-08-26 02:45:51 +00:00
Edward Loper 71f55af826 Renamed UNIFIED_DIFF->REPORT_UDIFF; CONTEXT_DIFF->REPORT_CDIFF; and
NDIFF_DIFF->REPORT_NDIFF.  This establishes the naming convention that
all reporting options should begin with "REPORT_" (since reporting
options are a different class from output comparison options; but they
are both set in optionflags).
2004-08-26 01:41:51 +00:00
Tim Peters 0e448073d6 Restored half of a \versionadded only half of which should have been
deleted.
2004-08-26 01:02:08 +00:00
Edward Loper 19b1958730 Only recognize the expected output as an exception if it *starts* with
a traceback message.  I.e., examples that raise exceptions may no
longer generate pre-exception output.  This restores the behavior of
doctest in python 2.3.  The ability to check pre-exception output is
being removed because it makes the documentation simpler; and because
there are very few use cases for it.
2004-08-25 23:07:03 +00:00
Tim Peters 656f7e4b40 Removed redundant versionadded{} for NDIFF_DIFF. Virtually everything
in this section is new in 2.4, and that's all mentioned already in
versionadded{} thingies at the end of the section.  It hurts readability
to have them after every line <wink>.
2004-08-23 00:26:42 +00:00
Neal Norwitz 8bd5cb342c Add version info 2004-08-22 21:48:37 +00:00
Tim Peters c6cbab0db4 Added NDIFF_DIFF option. 2004-08-22 19:43:28 +00:00
Johannes Gijsbers c89061817b Quote # as \# to make lib compile again. 2004-08-20 14:37:05 +00:00
Tim Peters 026f8dc103 Now that they've settled down, document doctest directives. 2004-08-19 16:38:58 +00:00
Tim Peters 83e259a2c2 Another microburst of snail-like progress. 2004-08-13 21:55:21 +00:00