Mailman 3 September 2004 - Python-checkins

python/dist/src Makefile.pre.in,1.147,1.148
by loewis＠users.sourceforge.net Sept. 26, 2004

Sept. 26, 2004

Update of /cvsroot/python/python/dist/src In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv8928 Modified Files: Makefile.pre.in Log Message: Replace -soname with -h for Solaris compatibility. Fixes #1034496. Backported to 2.3. Index: Makefile.pre.in =================================================================== RCS file: /cvsroot/python/python/dist/src/Makefile.pre.in,v retrieving revision 1.147 retrieving revision 1.148 diff -u -d -r1.147 -r1.148 --- Makefile.pre.in 16 Jul 2004 08:42:35 -0000 1.147 +++ Makefile.pre.in 26 Sep 2004 17:26:55 -0000 1.148 @@ -351,7 +351,7 @@ libpython$(VERSION).so: $(LIBRARY_OBJS) if test $(INSTSONAME) != $(LDLIBRARY); then \ - $(LDSHARED) -Wl,-soname=$(INSTSONAME) -o $(INSTSONAME) $(LIBRARY_OBJS) $(SHLIBS) $(LIBC) $(LIBM); \ + $(LDSHARED) -Wl,-h$(INSTSONAME) -o $(INSTSONAME) $(LIBRARY_OBJS) $(SHLIBS) $(LIBC) $(LIBM); \ $(LN) -f $(INSTSONAME) $@; \ else\ $(LDSHARED) -o $@ $(LIBRARY_OBJS) $(SHLIBS) $(LIBC) $(LIBM); \

1 0

python/dist/src Makefile.pre.in, 1.136.6.4, 1.136.6.5
by loewis＠users.sourceforge.net Sept. 26, 2004

Sept. 26, 2004

Update of /cvsroot/python/python/dist/src In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv8743 Modified Files: Tag: release23-maint Makefile.pre.in Log Message: Remove bogus = from -h option. Index: Makefile.pre.in =================================================================== RCS file: /cvsroot/python/python/dist/src/Makefile.pre.in,v retrieving revision 1.136.6.4 retrieving revision 1.136.6.5 diff -u -d -r1.136.6.4 -r1.136.6.5 --- Makefile.pre.in 26 Sep 2004 17:22:10 -0000 1.136.6.4 +++ Makefile.pre.in 26 Sep 2004 17:26:16 -0000 1.136.6.5 @@ -345,7 +345,7 @@ libpython$(VERSION).so: $(LIBRARY_OBJS) if test $(INSTSONAME) != $(LDLIBRARY); then \ - $(LDSHARED) -Wl,-h=$(INSTSONAME) -o $(INSTSONAME) $(LIBRARY_OBJS) $(SHLIBS) $(LIBC) $(LIBM); \ + $(LDSHARED) -Wl,-h$(INSTSONAME) -o $(INSTSONAME) $(LIBRARY_OBJS) $(SHLIBS) $(LIBC) $(LIBM); \ $(LN) -f $(INSTSONAME) $@; \ else\ $(LDSHARED) -o $@ $(LIBRARY_OBJS) $(SHLIBS) $(LIBC) $(LIBM); \

1 0

python/dist/src Makefile.pre.in, 1.136.6.3, 1.136.6.4
by loewis＠users.sourceforge.net Sept. 26, 2004

Sept. 26, 2004

Update of /cvsroot/python/python/dist/src In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv7630 Modified Files: Tag: release23-maint Makefile.pre.in Log Message: Replace -soname with -h for Solaris compatibility. Fixes #1034496. Index: Makefile.pre.in =================================================================== RCS file: /cvsroot/python/python/dist/src/Makefile.pre.in,v retrieving revision 1.136.6.3 retrieving revision 1.136.6.4 diff -u -d -r1.136.6.3 -r1.136.6.4 --- Makefile.pre.in 18 Nov 2003 19:54:00 -0000 1.136.6.3 +++ Makefile.pre.in 26 Sep 2004 17:22:10 -0000 1.136.6.4 @@ -345,7 +345,7 @@ libpython$(VERSION).so: $(LIBRARY_OBJS) if test $(INSTSONAME) != $(LDLIBRARY); then \ - $(LDSHARED) -Wl,-soname=$(INSTSONAME) -o $(INSTSONAME) $(LIBRARY_OBJS) $(SHLIBS) $(LIBC) $(LIBM); \ + $(LDSHARED) -Wl,-h=$(INSTSONAME) -o $(INSTSONAME) $(LIBRARY_OBJS) $(SHLIBS) $(LIBC) $(LIBM); \ $(LN) -f $(INSTSONAME) $@; \ else\ $(LDSHARED) -o $@ $(LIBRARY_OBJS) $(SHLIBS) $(LIBC) $(LIBM); \

1 0

python/dist/src/Misc NEWS, 1.831.4.151, 1.831.4.152
by loewis＠users.sourceforge.net Sept. 26, 2004

Sept. 26, 2004

Update of /cvsroot/python/python/dist/src/Misc In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv7630/Misc Modified Files: Tag: release23-maint NEWS Log Message: Replace -soname with -h for Solaris compatibility. Fixes #1034496. Index: NEWS =================================================================== RCS file: /cvsroot/python/python/dist/src/Misc/NEWS,v retrieving revision 1.831.4.151 retrieving revision 1.831.4.152 diff -u -d -r1.831.4.151 -r1.831.4.152 --- NEWS 18 Sep 2004 16:04:21 -0000 1.831.4.151 +++ NEWS 26 Sep 2004 17:22:11 -0000 1.831.4.152 @@ -123,6 +123,8 @@ Build ----- +- Bug #1034496: Use -h instead of -soname for Solaris compatibility. + - Patch #973204: Use -rpath instead of -R for runtime_library_dirs on Irix and True64.

1 0

python/dist/src/Misc NEWS,1.1144,1.1145
by tim_one＠users.sourceforge.net Sept. 26, 2004

Sept. 26, 2004

Update of /cvsroot/python/python/dist/src/Misc In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv1694/misc Modified Files: NEWS Log Message: Updated doctest doc news. Index: NEWS =================================================================== RCS file: /cvsroot/python/python/dist/src/Misc/NEWS,v retrieving revision 1.1144 retrieving revision 1.1145 diff -u -d -r1.1144 -r1.1145 --- NEWS 24 Sep 2004 03:40:57 -0000 1.1144 +++ NEWS 26 Sep 2004 05:13:18 -0000 1.1145 @@ -67,12 +67,15 @@ ``codecs.StreamReader.readlines()`` have a new argument ``keepends``. Trailing "\n"s will be stripped from the lines if ``keepends`` is false. +- The documentation for doctest is greatly expanded, and now covers all + the new public features (of which there are many). + - ``doctest.master`` was put back in, and ``doctest.testmod()`` once again updates it. This isn't good, because every ``testmod()`` call contributes to bloating the "hidden" state of ``doctest.master``, but some old code apparently relies on it. For now, all we can do is encourage people to stitch doctests together via doctest's unittest - integration features instead. It would help if those were documented. + integration features instead. - httplib now handles ipv6 address/port pairs.

1 0

python/dist/src/Doc/lib libdoctest.tex,1.55,1.56
by tim_one＠users.sourceforge.net Sept. 26, 2004

Sept. 26, 2004

Update of /cvsroot/python/python/dist/src/Doc/lib In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv848/doc/lib Modified Files: libdoctest.tex Log Message: Added a lot of new stuff to the debugging section. Index: libdoctest.tex =================================================================== RCS file: /cvsroot/python/python/dist/src/Doc/lib/libdoctest.tex,v retrieving revision 1.55 retrieving revision 1.56 diff -u -d -r1.55 -r1.56 --- libdoctest.tex 26 Sep 2004 02:38:41 -0000 1.55 +++ libdoctest.tex 26 Sep 2004 05:09:59 -0000 1.56 @@ -1547,34 +1547,174 @@ \subsection{Debugging\label{doctest-debugging}} -Doctest provides three mechanisms for debugging doctest examples: +Doctest provides several mechanisms for debugging doctest examples: -\begin{enumerate} -\item The \function{debug()} function converts a specified doctest - to a Python script, and executes that script using \module{pdb}. +\begin{itemize} +\item Several functions convert doctests to executable Python + programs, which can be run under the Python debugger, \refmodule{pdb}. \item The \class{DebugRunner} class is a subclass of \class{DocTestRunner} that raises an exception for the first failing example, containing information about that example. This information can be used to perform post-mortem debugging on the example. -\item The unittest cases generated by \function{DocTestSuite()} - support the \method{debug} method defined by +\item The \module{unittest} cases generated by \function{DocTestSuite()} + support the \method{debug()} method defined by \class{unittest.TestCase}. -\end{enumerate} +\item You can add a call to \function{pdb.set_trace()} in a doctest + example, and you'll drop into the Python debugger when that + line is executed. Then you can inspect current values of variables, + and so on. For example, suppose \file{a.py} contains just this + module docstring: -\begin{funcdesc}{debug}{module, name} - Debug a single doctest docstring. +\begin{verbatim} +""" +>>> def f(x): +... g(x*2) +>>> def g(x): +... print x+3 +... import pdb; pdb.set_trace() +>>> f(3) +9 +""" +\end{verbatim} - Provide the \var{module} (or dotted name of the module) containing - the docstring to be debugged and the fully qualified dotted - \var{name} of the object with the docstring to be debugged. + Then an interactive Python session may look like this: + +\begin{verbatim} +>>> import a, doctest +>>> doctest.testmod(a) +--Return-- +> <doctest a[1]>(3)g()->None +-> import pdb; pdb.set_trace() +(Pdb) list + 1 def g(x): + 2 print x+3 + 3 -> import pdb; pdb.set_trace() +[EOF] +(Pdb) print x +6 +(Pdb) step +--Return-- +> <doctest a[0]>(2)f()->None +-> g(x*2) +(Pdb) list + 1 def f(x): + 2 -> g(x*2) +[EOF] +(Pdb) print x +3 +(Pdb) step +--Return-- +> <doctest a[2]>(1)?()->None +-> f(3) +(Pdb) cont +(0, 3) +>>> +\end{verbatim} + + \versionchanged[The ability to use \code{pdb.set_trace()} usefully + inside doctests was added]{2.4} +\end{itemize} + +Functions that convert doctests to Python code, and possibly run +the synthesized code under the debugger: + +\begin{funcdesc}{script_from_examples}{s} + Convert text with examples to a script. + + Argument \var{s} is a string containing doctest examples. The string + is converted to a Python script, where doctest examples in \var{s} + are converted to regular code, and everything else is converted to + Python comments. The generated script is returned as a string. + For example, given file \file{a.py} as above, + + \begin{verbatim} + >>> print doctest.script_from_examples(open("a.py").read()) + # """ + def f(x): + g(x*2) + def g(x): + print x+3 + import pdb; pdb.set_trace() + f(3) + # Expected: + ## 9 + ## """ + \end{verbatim} + + \versionadded{2.4} +\end{funcdesc} + +\begin{funcdesc}{testsource}{module, name} + Convert the doctest for an object to a script. + + Argument \var{module} is a module object, or dotted name of a module, + containing the object whose doctests are of interest. Argument + \var{name} is the name (within the module) of the object with the + doctests of interest. The result is a string, containing the + object's docstring converted to a Python script, as described for + \function{script_from_examples()} above. For example, if module + \file{a.py} contains a top-level function \function{f()}, then + + \begin{verbatim} + import a, doctest + print doctest.testsource(a, "a.f") + \end{verbatim} + + prints a script version of function \function{f()}'s docstring, + with doctests converted to code, and the rest placed in comments. + + \versionadded{2.3} +\end{funcdesc} + +\begin{funcdesc}{debug}{module, name\optional{, pm}} + Debug the doctests for an object. + + The \var{module} and \var{name} arguments are the same as for function + \function{testsource()} above. The synthesized Python script for the + named object's docstring is written to a temporary file, and then that + file is run under the control of the Python debugger, \refmodule{pdb}. + + A shallow copy of \code{\var{module}.__dict__} is used for both local + and global execution context. + + Optional argument \var{pm} controls whether post-mortem debugging is + used. If \var{pm} has a true value, the script file is run directly, + and the debugger gets involved only if the script terminates via raising + an unhandled exception. If it does, then post-mortem debugging is + invoked, via \code{pdb.post_mortem()}, passing the traceback object + from the unhandled exception. If \var{pm} is not specified, or is false, + the script is run under the debugger from the start, via passing an + appropriate \function{execfile()} call to \code{pdb.run()}. - The doctest examples are extracted (see function \function{testsource()}), - and written to a temporary file. The Python debugger, \refmodule{pdb}, - is then invoked on that file. \versionadded{2.3} + + \versionchanged[The \var{pm} argument was added]{2.4} +\end{funcdesc} + +\begin{funcdesc}{debug_src}{src\optional{, pm}\optional{, globs}} + Debug the doctests in a string. + + This is like function \function{debug()} above, except that + a string containing doctest examples is specified directly, via + the \var{src} argument. + + Optional argument \var{pm} has the same meaning as in function + \function{debug()} above. + + Optional argument \var{globs} gives a dictionary to use as both + local and global execution context. If not specified, or \code{None}, + an empty dictionary is used. If specified, a shallow copy of the + dictionary is used. + + \versionadded{2.4} \end{funcdesc} +The \class{DebugRunner} class, and the special exceptions it may raise, +are of most interest to testing framework authors, and will only be +sketched here. See the source code, and especially \class{DebugRunner}'s +docstring (which is a doctest!) for more details: + \begin{classdesc}{DebugRunner}{\optional{checker}\optional{, verbose}\optional{, optionflags}} @@ -1591,6 +1731,9 @@ section~\ref{doctest-advanced-api}. \end{classdesc} +There are two exceptions that may be raised by \class{DebugRunner} +instances: + \begin{excclassdesc}{DocTestFailure}{test, example, got} An exception thrown by \class{DocTestRunner} to signal that a doctest example's actual output did not match its expected output. @@ -1608,20 +1751,7 @@ The example's actual output. \end{memberdesc} -\begin{funcdesc}{testsource}{module, name} - Extract the doctest examples from a docstring. - - Provide the \var{module} (or dotted name of the module) containing the - tests to be extracted and the \var{name} (within the module) of the object - with the docstring containing the tests to be extracted. - - The doctest examples are returned as a string containing Python - code. The expected output blocks in the examples are converted - to Python comments. - \versionadded{2.3} -\end{funcdesc} - -\begin{excclassdesc}{UnexpectedException}{test, example, got} +\begin{excclassdesc}{UnexpectedException}{test, example, exc_info} An exception thrown by \class{DocTestRunner} to signal that a doctest example raised an unexpected exception. The constructor arguments are used to initialize the member variables of the same

1 0

python/dist/src/Lib doctest.py,1.112,1.113
by tim_one＠users.sourceforge.net Sept. 26, 2004

Sept. 26, 2004

Update of /cvsroot/python/python/dist/src/Lib In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv18696/Lib Modified Files: doctest.py Log Message: Removed debug_script from the public API: no docs, not public. I'm in the process of writing docs for the other "missing" debug support functions. Index: doctest.py =================================================================== RCS file: /cvsroot/python/python/dist/src/Lib/doctest.py,v retrieving revision 1.112 retrieving revision 1.113 diff -u -d -r1.112 -r1.113 --- doctest.py 26 Sep 2004 01:50:24 -0000 1.112 +++ doctest.py 26 Sep 2004 03:50:06 -0000 1.113 @@ -90,7 +90,6 @@ 'script_from_examples', 'testsource', 'debug_src', - 'debug_script', 'debug', ]

1 0

python/dist/src/Doc/lib libdoctest.tex,1.54,1.55
by tim_one＠users.sourceforge.net Sept. 26, 2004

Sept. 26, 2004

Update of /cvsroot/python/python/dist/src/Doc/lib In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv3828/Doc/lib Modified Files: libdoctest.tex Log Message: register_optionflag(): Moved from the Debugging section to the section on option flags; added a versionadded decoration. Index: libdoctest.tex =================================================================== RCS file: /cvsroot/python/python/dist/src/Doc/lib/libdoctest.tex,v retrieving revision 1.54 retrieving revision 1.55 diff -u -d -r1.54 -r1.55 --- libdoctest.tex 26 Sep 2004 02:12:40 -0000 1.54 +++ libdoctest.tex 26 Sep 2004 02:38:41 -0000 1.55 @@ -710,6 +710,25 @@ matches an empty line in actual output; and doctest directives were added]{2.4} +There's also a way to register new option flag names, although this +isn't useful unless you intend to extend \module{doctest} internals +via subclassing: + +\begin{funcdesc}{register_optionflag}{name} + Create a new option flag with a given name, and return the new + flag's integer value. \function{register_optionflag()} can be + used when subclassing \class{OutputChecker} or + \class{DocTestRunner} to create new options that are supported by + your subclasses. \function{register_optionflag} should always be + called using the following idiom: + +\begin{verbatim} + MY_FLAG = register_optionflag('MY_FLAG') +\end{verbatim} + + \versionadded{2.4} +\end{funcdesc} + \subsubsection{Warnings\label{doctest-warnings}} \module{doctest} is serious about requiring exact matches in expected @@ -1620,18 +1639,6 @@ returned by \function{sys.exc_info()}. \end{memberdesc} -\begin{funcdesc}{register_optionflag}{name} - Create a new option flag with a given name, and return the new - flag's integer value. \function{register_optionflag()} can be - used when subclassing \class{OutputChecker} or - \class{DocTestRunner} to create new options that are supported by - your subclasses. \function{register_optionflag} should always be - called using the following idiom: -\begin{verbatim} - MY_FLAG = register_optionflag('MY_FLAG') -\end{verbatim} -\end{funcdesc} - \subsection{Soapbox\label{doctest-soapbox}} As mentioned in the introduction, \module{doctest} has grown to have

1 0

python/dist/src/Doc/lib libdoctest.tex,1.53,1.54
by tim_one＠users.sourceforge.net Sept. 26, 2004

Sept. 26, 2004

Update of /cvsroot/python/python/dist/src/Doc/lib In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv30898/Doc/lib Modified Files: libdoctest.tex Log Message: Document set_unittest_reportflags(). Index: libdoctest.tex =================================================================== RCS file: /cvsroot/python/python/dist/src/Doc/lib/libdoctest.tex,v retrieving revision 1.53 retrieving revision 1.54 diff -u -d -r1.53 -r1.54 --- libdoctest.tex 25 Sep 2004 08:09:23 -0000 1.53 +++ libdoctest.tex 26 Sep 2004 02:12:40 -0000 1.54 @@ -933,8 +933,8 @@ way to combine doctests from multiple modules. \class{Tester} was feeble, and in practice most serious Python testing frameworks build on the \module{unittest} module, which supplies many flexible ways to combine -tests from multiple sources. So, in Python 2.4, module{doctest}'s -\class{Tester} class is deprecated, and \module{doctest} provides several +tests from multiple sources. So, in Python 2.4, \module{doctest}'s +\class{Tester} class is deprecated, and \module{doctest} provides two functions that can be used to create \module{unittest} test suites from modules and text files containing doctests. These test suites can then be run using \module{unittest} test runners: @@ -951,6 +951,9 @@ runner.run(suite) \end{verbatim} +There are two main functions for creating \class{unittest.TestSuite} +instances from text files and modules with doctests: + \begin{funcdesc}{DocFileSuite}{*paths, **kw} Convert doctest tests from one or more text files to a \class{\refmodule{unittest}.TestSuite}. @@ -1011,6 +1014,8 @@ Optional argument \var{optionflags} specifies the default doctest options for the tests, created by or-ing together individual option flags. See section~\ref{doctest-options}. + See function \function{set_unittest_reportflags()} below for + a better way to set reporting options. \versionadded{2.4} \end{funcdesc} @@ -1049,12 +1054,64 @@ are the same as for function \function{DocFileSuite()} above. \versionadded{2.3} + \versionchanged[The parameters \var{globs}, \var{extraglobs}, \var{test_finder}, \var{setUp}, \var{tearDown}, and \var{optionflags} were added; this function now uses the same search technique as \function{testmod()}]{2.4} \end{funcdesc} +Under the covers, \function{DocTestSuite()} creates a +\class{unittest.TestSuite} out of \class{doctest.DocTestCase} instances, +and \class{DocTestCase} is a subclass of \class{unittest.TestCase}. +\class{DocTestCase} isn't documented here (it's an internal detail), but +studying its code can answer questions about the exact details of +\module{unittest} integration. + +Similarly, \function{DocFileSuite()} creates a \class{unittest.TestSuite} +out of \class{doctest.DocFileCase} instances, and \class{DocFileCase} +is a subclass of \class{DocTestCase}. + +So both ways of creating a \class{unittest.TestSuite} run instances of +\class{DocTestCase}. This is important for a subtle reason: when you +run \module{doctest} functions yourself, you can control the +\module{doctest} options in use directly, by passing option flags to +\module{doctest} functions. However, if you're writing a \module{unittest} +framework, \module{unittest} ultimately controls when and how tests +get run. The framework author typically wants to control \module{doctest} +reporting options (perhaps, e.g., specified by command line options), +but there's no way to pass options through \module{unittest} to +\module{doctest} test runners. + +For this reason, \module{doctest} also supports a notion of +\module{doctest} reporting flags specific to \module{unittest} support, +via this function: + +\begin{funcdesc}{set_unittest_reportflags}{flags} + Set the \module{doctest} reporting flags to use. + + Argument \var{flags} or's together option flags. See + section~\ref{doctest-options}. Only "reporting flags" can be used. + + This is a module-global setting, and affects all future doctests run + by module \module{unittest}: the \method{runTest()} method of + \class{DocTestCase} looks at the option flags specified for the test + case when the \class{DocTestCase} instance was constructed. If no + reporting flags were specified (which is the typical and expected case), + \module{doctest}'s \module{unittest} reporting flags are or'ed into the + option flags, and the option flags so augmented are passed to the + \class{DocTestRunner} instance created to run the doctest. If any + reporting flags were specified when the \class{DocTestCase} instance + was constructed, \module{doctest}'s \module{unittest} reporting flags + are ignored. + + The value of the \module{unittest} reporting flags in effect before the + function was called is returned by the function. + + \versionadded{2.4} +\end{funcdesc} + + \subsection{Advanced API\label{doctest-advanced-api}} The basic API is a simple wrapper that's intended to make doctest easy

1 0

python/dist/src/Lib doctest.py,1.111,1.112
by tim_one＠users.sourceforge.net Sept. 26, 2004

Sept. 26, 2004

Update of /cvsroot/python/python/dist/src/Lib In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv25940/Lib Modified Files: doctest.py Log Message: Add set_unittest_reportflags() to the public API. Docs will follow "soon", after I repair the LaTeX I somehow damaged. Index: doctest.py =================================================================== RCS file: /cvsroot/python/python/dist/src/Lib/doctest.py,v retrieving revision 1.111 retrieving revision 1.112 diff -u -d -r1.111 -r1.112 --- doctest.py 26 Sep 2004 01:24:23 -0000 1.111 +++ doctest.py 26 Sep 2004 01:50:24 -0000 1.112 @@ -85,6 +85,7 @@ # 8. Unittest Support 'DocTestSuite', 'DocFileSuite', + 'set_unittest_reportflags', # 9. Debugging Support 'script_from_examples', 'testsource',

1 0