[issue11015] Bring test.support docs up to date

Terry J. Reedy added the comment: Since Nick already merged and backported, at least a new PR is needed. Since this is an old issue with a long discussion and several inactives on the nosy list, I suggest a new issue starting from the merge result as a base: "More

[issue11015] Bring test.support docs up to date

Cheryl Sabella added the comment: Thanks Nick for merging. Should I open a new PR to address Serhiy's review or fix them on the original PR? -- ___ Python tracker

[issue11015] Bring test.support docs up to date

Nick Coghlan added the comment: New changeset a0b998df314370f00502efe7ad84206f5bb782ff by Nick Coghlan (Miss Islington (bot)) in branch '3.7': bpo-11015: Update test.support documentation (GH-5619)

[issue11015] Bring test.support docs up to date

Serhiy Storchaka added the comment: I have left comments to PR. -- nosy: +serhiy.storchaka ___ Python tracker ___

[issue11015] Bring test.support docs up to date

Nick Coghlan added the comment: I merged Cheryl's PR to the dev branch, and triggered the backport to 3.7. If nobody beats me to it, I'll merge the latter tomorrow :) -- assignee: docs@python -> ncoghlan resolution: -> fixed stage: patch review -> backport needed

[issue11015] Bring test.support docs up to date

Change by miss-islington : -- pull_requests: +5428 ___ Python tracker ___

[issue11015] Bring test.support docs up to date

Nick Coghlan added the comment: New changeset 988fb28431d3a3fc5dc6eb657c8a4baacc04d9ce by Nick Coghlan (Cheryl Sabella) in branch 'master': bpo-11015: Update test.support documentation (GH-5610)

[issue11015] Bring test.support docs up to date

Cheryl Sabella added the comment: I have created a pull request adding documentation for all of test.support, including script_helper.py. I hope this will be helpful. -- nosy: +csabella versions: +Python 3.8 ___ Python tracker

[issue11015] Bring test.support docs up to date

Change by Cheryl Sabella : -- pull_requests: +5420 ___ Python tracker ___ ___

[issue11015] Bring test.support docs up to date

Ezio Melotti added the comment: There are some other helper modules (such as test.script_helper) that could also stand to be made easier to find. Documenting script_helper.py would be good too. I seem to remember some discussion about merging it with support.py -- if that happens it can be

[issue11015] Bring test.support docs up to date

Eli Bendersky eli...@gmail.com added the comment: Ezio, you're right, there are still a lot of undocumented symbols (functions, classes, globals). I compiled a list of those I could not find in the .rst docs, excluding ones that are only used in regrtest.py itself:

[issue11015] Bring test.support docs up to date

Eli Bendersky eli...@gmail.com added the comment: Can this issue be closed? -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue11015 ___ ___

[issue11015] Bring test.support docs up to date

Ezio Melotti ezio.melo...@gmail.com added the comment: There are still functions that are not documented, so I think this should stay open until we documented them (unless they shouldn't be documented -- in that case it can be closed). -- ___

[issue11015] Bring test.support docs up to date

Eli Bendersky eli...@gmail.com added the comment: Terry, I've incorporated your suggestions except the new formulation for verbosity to doctest.testmod, since it's not really clear which one is more accurate. I think it's intelligible as it is now (especially given that test.support is for

[issue11015] Bring test.support docs up to date

Roundup Robot devnull@devnull added the comment: New changeset 2fd435ac3551 by Eli Bendersky in branch 'default': Issue #11015: bring test.support docs up to date http://hg.python.org/cpython/rev/2fd435ac3551 -- nosy: +python-dev ___ Python tracker

[issue11015] Bring test.support docs up to date

Ezio Melotti ezio.melo...@gmail.com added the comment: I left a few comments on rietveld for the testdoc and remove_fcmp patches. Unless I'm missing something, assertEqual works just fine in all the places where fcmp was used, so there's no need to use assertAlmostEqual. -- nosy:

[issue11015] Bring test.support docs up to date

Changes by Sandro Tosi sandro.t...@gmail.com: -- nosy: +sandro.tosi ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue11015 ___ ___ Python-bugs-list

[issue11015] Bring test.support docs up to date

Sandro Tosi sandro.t...@gmail.com added the comment: Hi all, IIUIC we are left with issue11015.py3k.testdoc.1.patch) since issue11015.py3k.remove_fcmp.{1,2}.patch has been already applied on default. I just gave a look to the doc patch and it seems fine (it also applies without any warning on

[issue11015] Bring test.support docs up to date

Terry J. Reedy tjre...@udel.edu added the comment: This is an improvement that I think should be committed before 3.2.1. Some comments: +.. function:: run_doctest(module, verbosity=None) + Run :mod:`doctest` on the given *module*. should be, I believe, + Run :func:`doctest.testmod` on the

[issue11015] Bring test.support docs up to date

Eli Bendersky eli...@gmail.com added the comment: Eli, do you want to expand this patch further (and how :) or do you think it's still the version you want to commit? Can a core devel, then, give this patch a deeper look? I will review this again in a couple of days and will commit.

[issue11015] Bring test.support docs up to date

Changes by Terry J. Reedy tjre...@udel.edu: Removed file: http://bugs.python.org/file21890/unnamed ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue11015 ___

[issue11015] Bring test.support docs up to date

Georg Brandl ge...@python.org added the comment: The divmod() part of the patch is wrong: assertAlmostEqual does not support tuple arguments. The test succeeds because it first does an exact equality check, which apparently is true on your platform. But if it wasn't, you'd get TypeErrors.

[issue11015] Bring test.support docs up to date

Eli Bendersky eli...@gmail.com added the comment: Georg, Good catch on the tuples in assertAlmostEqual, thanks! I see three methods of resolution: 1. Since the floats in this case are powers of 1/2, they could be tested for exact equality, or do you figure there are platforms where this is

[issue11015] Bring test.support docs up to date

Georg Brandl ge...@python.org added the comment: (2) would be my choice. (1) *should* be true, but this is a change in the test semantics. (3) would be feature creep and I don't think it's a good idea. -- ___ Python tracker rep...@bugs.python.org

[issue11015] Bring test.support docs up to date

Eli Bendersky eli...@gmail.com added the comment: Attaching a revised patch with (2) implemented. -- Added file: http://bugs.python.org/file20885/issue11015.py3k.remove_fcmp.2.patch ___ Python tracker rep...@bugs.python.org

[issue11015] Bring test.support docs up to date

Georg Brandl ge...@python.org added the comment: Yes, that looks good now. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue11015 ___ ___

[issue11015] Bring test.support docs up to date

Eli Bendersky eli...@gmail.com added the comment: Georg Brandl ge...@python.org added the comment: Yes, that looks good now. Thanks. fcmp FUZZ removal committed in revision 88558 -- ___ Python tracker rep...@bugs.python.org

[issue11015] Bring test.support docs up to date

Eli Bendersky eli...@gmail.com added the comment: Following the python-dev discussion, attaching a patch for removing fcmp and replacing its uses with assertAlmostEqual when needed. All tests pass and patchcheck is clean. Please review before I commit. -- nosy: +terry.reedy Added

[issue11015] Bring test.support docs up to date

Changes by Giampaolo Rodola' g.rod...@gmail.com: -- nosy: +giampaolo.rodola ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue11015 ___ ___

[issue11015] Bring test.support docs up to date

Nick Coghlan ncogh...@gmail.com added the comment: verbose isn't a boolean at all - it's an integer. You can supply it multiple times to bump the logging level up even higher than normal. ~/devel/py3k/Lib/test$ grep verbose *.py regrtest.py:if self.verbose 1:

[issue11015] Bring test.support docs up to date

Eli Bendersky eli...@gmail.com added the comment: Nick, agreed regarding verbose. Somehow I didn't think it would be used in other modules like that, and only looked in regrtest where I didn't see anything meaningful about verbose not being binary. It's a good thing to document it, then :)

[issue11015] Bring test.support docs up to date

Changes by Eli Bendersky eli...@gmail.com: Removed file: http://bugs.python.org/file20564/issue11015.py3k.1.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue11015 ___

[issue11015] Bring test.support docs up to date

Changes by Eli Bendersky eli...@gmail.com: -- nosy: +eli.bendersky ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue11015 ___ ___ Python-bugs-list

[issue11015] Bring test.support docs up to date

Eli Bendersky eli...@gmail.com added the comment: I don't know if it matters much, but there's a slight mismatch in the description of test.support.verbose. The documentation says it's a boolean, while it's 0 or 1 in reality. Can it just be changed to True/False in the code of test.support

[issue11015] Bring test.support docs up to date

Eli Bendersky eli...@gmail.com added the comment: Here's a patch fixing the 0/1 to True/False in a couple of places in test.support and test.regrtest I ran the test suite and it passes. A review is needed to commit. I'll keep working on the documentation itself in the meantime. --

[issue11015] Bring test.support docs up to date

Eli Bendersky eli...@gmail.com added the comment: Here's a patch to Doc/library/test.rst with additional several exported functions documented. These are the ones I found most important and clear. fcmp() is currently not documented (pending discussion in pydev). -- stage: needs patch

[issue11015] Bring test.support docs up to date

New submission from Nick Coghlan ncogh...@gmail.com: The test.support docs are there to help CPython devs with writing good unit tests more easily. There are a few additions we've made in recent years that haven't made it into the .rst file, so it is easy to miss useful tools if you don't go