bpo-27200: Fix several doctests (GH-604)

diff --git a/Doc/library/email.compat32-message.rst b/Doc/library/email.compat32-message.rst
index b0707646e64ac656203055d036a2a03842dfe65d..2394e4d7077b4c484a05857905deb329db2fe39c 100644 (file)
--- a/Doc/library/email.compat32-message.rst
+++ b/Doc/library/email.compat32-message.rst
@@ -660,10 +660,14 @@ Here are the methods of the :class:`Message` class:
 
       .. testsetup::
 
-         >>> from email import message_from_binary_file
-         >>> with open('Lib/test/test_email/data/msg_16.txt', 'rb') as f:
-         ...     msg = message_from_binary_file(f)
-         >>> from email.iterators import _structure
+         import email
+         from email import message_from_binary_file
+         from os.path import join, dirname
+         lib_dir = dirname(dirname(email.__file__))
+         file_path = join(lib_dir, 'test/test_email/data/msg_16.txt')
+         with open(file_path, 'rb') as f:
+             msg = message_from_binary_file(f)
+         from email.iterators import _structure
 
       .. doctest::
 
@@ -686,7 +690,7 @@ Here are the methods of the :class:`Message` class:
       .. doctest::
 
          >>> for part in msg.walk():
-         ...     print(part.get_content_maintype() == 'multipart'),
+         ...     print(part.get_content_maintype() == 'multipart',
          ...           part.is_multipart())
          True True
          False False
@@ -698,11 +702,11 @@ Here are the methods of the :class:`Message` class:
          >>> _structure(msg)
          multipart/report
              text/plain
-         message/delivery-status
-             text/plain
-             text/plain
-         message/rfc822
-             text/plain
+             message/delivery-status
+                 text/plain
+                 text/plain
+             message/rfc822
+                 text/plain
 
       Here the ``message`` parts are not ``multiparts``, but they do contain
       subparts. ``is_multipart()`` returns ``True`` and ``walk`` descends

diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 6621f4aabf705877ff20b655fe9b7c81509249d0..925da5094c62c852978411c3c9cb852f09c469be 100644 (file)
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -331,7 +331,7 @@ are always available.  They are listed here in alphabetical order.
    The resulting list is sorted alphabetically.  For example:
 
       >>> import struct
-      >>> dir()   # show the names in the module namespace
+      >>> dir()   # show the names in the module namespace  # doctest: +SKIP
       ['__builtins__', '__name__', 'struct']
       >>> dir(struct)   # show the names in the struct module # doctest: +SKIP
       ['Struct', '__all__', '__builtins__', '__cached__', '__doc__', '__file__',

diff --git a/Doc/library/ipaddress.rst b/Doc/library/ipaddress.rst
index 90dfd461190a967f658d4beb07bc96b81ecd2286..36c6859d7016ccc7850b5276eac025d4b878e4e9 100644 (file)
--- a/Doc/library/ipaddress.rst
+++ b/Doc/library/ipaddress.rst
@@ -25,9 +25,11 @@ This is the full module API reference—for an overview and introduction, see
 .. versionadded:: 3.3
 
 .. testsetup::
-   >>> import ipaddress
-   >>> from ipaddress import (ip_network, IPv4Address, IPv4Interface,
-   ...                        IPv4Network)
+
+   import ipaddress
+   from ipaddress import (
+       ip_network, IPv4Address, IPv4Interface, IPv4Network,
+   )
 
 Convenience factory functions
 -----------------------------

diff --git a/Doc/library/reprlib.rst b/Doc/library/reprlib.rst
index 0905b982cd830a2f9de448da9c6dba2f93d3bddb..5149bcf10f662a460d462d7d283e58e7c3fcc728 100644 (file)
--- a/Doc/library/reprlib.rst
+++ b/Doc/library/reprlib.rst
@@ -48,6 +48,7 @@ string instead.
    same thread.  If a recursive call is made, the *fillvalue* is returned,
    otherwise, the usual :meth:`__repr__` call is made.  For example:
 
+        >>> from reprlib import recursive_repr
         >>> class MyList(list):
         ...     @recursive_repr()
         ...     def __repr__(self):

diff --git a/Doc/library/shlex.rst b/Doc/library/shlex.rst
index 55012f80e8f923f368b1f597283ecf77309e9514..fb335c690068165e1d34b69e0780b193c4c7ecbb 100644 (file)
--- a/Doc/library/shlex.rst
+++ b/Doc/library/shlex.rst
@@ -43,15 +43,16 @@ The :mod:`shlex` module defines the following functions:
    string that can safely be used as one token in a shell command line, for
    cases where you cannot use a list.
 
-   This idiom would be unsafe::
+   This idiom would be unsafe:
 
       >>> filename = 'somefile; rm -rf ~'
       >>> command = 'ls -l {}'.format(filename)
       >>> print(command)  # executed by a shell: boom!
       ls -l somefile; rm -rf ~
 
-   :func:`quote` lets you plug the security hole::
+   :func:`quote` lets you plug the security hole:
 
+      >>> from shlex import quote
       >>> command = 'ls -l {}'.format(quote(filename))
       >>> print(command)
       ls -l 'somefile; rm -rf ~'
@@ -61,6 +62,7 @@ The :mod:`shlex` module defines the following functions:
 
    The quoting is compatible with UNIX shells and with :func:`split`:
 
+      >>> from shlex import split
       >>> remote_command = split(remote_command)
       >>> remote_command
       ['ssh', 'home', "ls -l 'somefile; rm -rf ~'"]

diff --git a/Doc/library/urllib.parse.rst b/Doc/library/urllib.parse.rst
index 7a5b56f5da69b1ede67327f18a111219bc60437a..6754e263878b72ab106163308189574071601f65 100644 (file)
--- a/Doc/library/urllib.parse.rst
+++ b/Doc/library/urllib.parse.rst
@@ -64,6 +64,9 @@ or on combining URL components into a URL string.
    input is presumed to be a relative URL and thus to start with
    a path component.
 
+   .. doctest::
+      :options: +NORMALIZE_WHITESPACE
+
        >>> from urllib.parse import urlparse
        >>> urlparse('//www.cwi.nl:80/%7Eguido/Python.html')
        ParseResult(scheme='', netloc='www.cwi.nl:80', path='/%7Eguido/Python.html',

diff --git a/Doc/whatsnew/3.2.rst b/Doc/whatsnew/3.2.rst
index b900e7733f0f3e6f1348f2e45e5c30933dc145c4..78d3105a5a410b1948dffe16a7eeabb07b7b2aaf 100644 (file)
--- a/Doc/whatsnew/3.2.rst
+++ b/Doc/whatsnew/3.2.rst
@@ -1062,13 +1062,16 @@ The :func:`~math.erf` function computes a probability integral or `Gaussian
 error function <https://en.wikipedia.org/wiki/Error_function>`_.  The
 complementary error function, :func:`~math.erfc`, is ``1 - erf(x)``:
 
->>> from math import erf, erfc, sqrt
->>> erf(1.0/sqrt(2.0))   # portion of normal distribution within 1 standard deviation
-0.682689492137086
->>> erfc(1.0/sqrt(2.0))  # portion of normal distribution outside 1 standard deviation
-0.31731050786291404
->>> erf(1.0/sqrt(2.0)) + erfc(1.0/sqrt(2.0))
-1.0
+.. doctest::
+   :options: +SKIP
+
+   >>> from math import erf, erfc, sqrt
+   >>> erf(1.0/sqrt(2.0))   # portion of normal distribution within 1 standard deviation
+   0.682689492137086
+   >>> erfc(1.0/sqrt(2.0))  # portion of normal distribution outside 1 standard deviation
+   0.31731050786291404
+   >>> erf(1.0/sqrt(2.0)) + erfc(1.0/sqrt(2.0))
+   1.0
 
 The :func:`~math.gamma` function is a continuous extension of the factorial
 function.  See https://en.wikipedia.org/wiki/Gamma_function for details.  Because
@@ -1384,7 +1387,7 @@ guaranteed not to block when :func:`select.select` says a pipe is ready
 for writing.
 
 >>> import select
->>> select.PIPE_BUF
+>>> select.PIPE_BUF  # doctest: +SKIP
 512
 
 (Available on Unix systems. Patch by Sébastien Sablé in :issue:`9862`)