bpo-27200: fix pathlib, ssl, turtle and weakref doctests by marco-buttu · Pull Request #616 · python/cpython

marco-buttu · 2017-03-11T15:10:55Z

This PR is the last but one in the series bpo-27200. The first one was #240, the second one #401, and the third #604. To run the doctests (from the Doc directory):

$ sphinx-build -b doctest . build/doctest \
library/pathlib.rst \
library/ssl.rst \
library/turtle.rst \
library/weakref.rst

mention-bot · 2017-03-11T15:10:58Z

@marco-buttu, thanks for your PR! By analyzing the history of the files in this pull request, we identified @eliben, @birkenfeld, @vsajip, @tiran and @loewis to be potential reviewers.

The setcontext(Context()) in testsetup does not guarantee that the tests outside this file have a clean context. We need to clean the context at the end of the tests.

marco-buttu · 2017-03-12T16:55:20Z

Doc/library/decimal.rst

+
+   # make sure other tests (also outside this file) get a fresh context
+   setcontext(Context())
+


The setcontext(Context()) in testsetup does not guarantee that the tests outside this file get a fresh context. We need to clean the context at the end of the tests.

Please leave decimal.rst changes out of this PR and open a separate PR and then ping Stefan Krah.

berkerpeksag

I think we also need to following change to ssl examples:

diff --git a/Doc/library/ssl.rst b/Doc/library/ssl.rst
index 01dbecd..02a0c79 100644
--- a/Doc/library/ssl.rst
+++ b/Doc/library/ssl.rst
@@ -2262,7 +2262,7 @@ SSL versions 2 and 3 are considered insecure and are therefore dangerous to
 use.  If you want maximum compatibility between clients and servers, it is
 recommended to use :const:`PROTOCOL_TLS_CLIENT` or
 :const:`PROTOCOL_TLS_SERVER` as the protocol version. SSLv2 and SSLv3 are
-disabled by default.
+disabled by default. ::
 
    >>> client_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
    >>> client_context.options |= ssl.OP_NO_TLSv1

And there are the other failures:

**********************************************************************
File "library/ssl.rst", line 421, in newcontext
Failed example:
    timestamp
Expected:
    1515144883
Got:
    1515134083.0
**********************************************************************
File "library/ssl.rst", line 424, in newcontext
Failed example:
    print(datetime.utcfromtimestamp(timestamp))
Expected:
    2018-01-05 09:34:43
Got:
    2018-01-05 06:34:43

berkerpeksag · 2017-04-12T13:09:32Z

Doc/library/decimal.rst

+
+   # make sure other tests (also outside this file) get a fresh context
+   setcontext(Context())
+


Please leave decimal.rst changes out of this PR and open a separate PR and then ping Stefan Krah.

berkerpeksag · 2017-04-12T13:21:38Z

Doc/library/shlex.rst

   cases where you cannot use a list.

-   This idiom would be unsafe::
+   This idiom would be unsafe:


You have already modified this file in #604.

berkerpeksag · 2017-04-12T13:22:47Z

Doc/library/pathlib.rst

 ---------

-Importing the main class::
+Importing the main class:


Please revert this change. The current version looks correct to me and the tests passed when I revert it to use ::.

marco-buttu · 2017-04-12T16:59:03Z

Thank you very much for your time @berkerpeksag! I made all changes you requested me. Just one question: you got a float from ssl.cert_time_to_seconds(). Is it not a bug in the code? Is it supposed to return both floats and ints?

berkerpeksag · 2017-04-12T21:38:31Z

I don't know, it's probably worth doing some VCS archaeology :) I built and ran tests in Python 3.4 with an ancient OpenSSL so this might be the culprit.

berkerpeksag · 2017-04-12T21:40:43Z

Doc/library/ssl.rst

 recommended to use :const:`PROTOCOL_TLS_CLIENT` or
 :const:`PROTOCOL_TLS_SERVER` as the protocol version. SSLv2 and SSLv3 are
-disabled by default.
+disabled by default. ::


I know I suggested this style in my earlier comment, but could you move :: to a new line so we don't lose git blame information? This also applies to the changes in Doc/library/pathlib.rst.

Ok, done :-) Thanks againt @berkerpeksag

berkerpeksag · 2017-04-13T14:18:07Z

Thanks!

marco-buttu added 5 commits March 11, 2017 12:58

bpo-27200: fix pathlib.rst doctests.

ef73f53

bpo-27200: fix shlex.rst doctests.

8332ecf

bpo-27200: fix ssl.rst doctests.

b88124b

bpo-27200: fix turtle.rst doctests.

9708d8e

bpo-27200: fix weakref.rst doctests.

52351e1

the-knights-who-say-ni added the CLA signed label Mar 11, 2017

marco-buttu changed the title ~~bpo-27200: fix~~ bpo-27200: fix pathlib, shlex, ssl, turtle and weakref doctests Mar 11, 2017

bpo-27200: at the end of the tests the context has to be left clean.

6ca705b

The setcontext(Context()) in testsetup does not guarantee that the tests outside this file have a clean context. We need to clean the context at the end of the tests.

marco-buttu commented Mar 12, 2017

View reviewed changes

marco-buttu mentioned this pull request Mar 26, 2017

bpo-27200: fix unittest.mock doctests. #821

Closed

berkerpeksag requested changes Apr 12, 2017

View reviewed changes

marco-buttu mentioned this pull request Apr 12, 2017

Fix bpo-30055: add testcleanup to leave a fresh context #1094

Merged

marco-buttu added 4 commits April 12, 2017 17:44

Remove decimal.rst from this PR

864b0b7

bpo-27200: revert change in pathlib.rst

989fd6c

bpo-27200: revert change in shlex.rst

43744f3

bpo-27200: skip more tests in ssl.rst

40a3875

marco-buttu changed the title ~~bpo-27200: fix pathlib, shlex, ssl, turtle and weakref doctests~~ bpo-27200: fix pathlib, ssl, turtle and weakref doctests Apr 12, 2017

berkerpeksag reviewed Apr 12, 2017

View reviewed changes

bpo-27200: move the :: on a new line.

4d63142

berkerpeksag approved these changes Apr 13, 2017

View reviewed changes

berkerpeksag merged commit 7b2491a into python:master Apr 13, 2017


		# make sure other tests (also outside this file) get a fresh context
		setcontext(Context())

Uh oh!

Comments

Conversation

marco-buttu commented Mar 11, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mention-bot commented Mar 11, 2017

Uh oh!

marco-buttu Mar 12, 2017

Choose a reason for hiding this comment

Uh oh!

berkerpeksag Apr 12, 2017

Choose a reason for hiding this comment

Uh oh!

berkerpeksag left a comment

Choose a reason for hiding this comment

Uh oh!

berkerpeksag Apr 12, 2017

Choose a reason for hiding this comment

Uh oh!

berkerpeksag Apr 12, 2017

Choose a reason for hiding this comment

Uh oh!

berkerpeksag Apr 12, 2017

Choose a reason for hiding this comment

Uh oh!

marco-buttu commented Apr 12, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

berkerpeksag commented Apr 12, 2017

Uh oh!

berkerpeksag Apr 12, 2017

Choose a reason for hiding this comment

Uh oh!

marco-buttu Apr 13, 2017

Choose a reason for hiding this comment

Uh oh!

berkerpeksag commented Apr 13, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

marco-buttu commented Mar 11, 2017 •

edited

Loading

marco-buttu commented Apr 12, 2017 •

edited

Loading