This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Title: Update README documentation for IDLE tests.
Type: enhancement Stage: resolved
Components: IDLE Versions: Python 3.4, Python 3.5, Python 2.7
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: terry.reedy Nosy List: Al.Sweigart, python-dev, terry.reedy
Priority: normal Keywords: patch

Created on 2015-04-15 13:32 by Al.Sweigart, last changed 2022-04-11 14:58 by admin. This issue is now closed.

File name Uploaded Description Edit
idle_test_readme.patch Al.Sweigart, 2015-04-15 13:32 Patch for the changes review
idle_test_readme.2.patch Al.Sweigart, 2015-04-18 18:00 review
Messages (5)
msg241099 - (view) Author: Al Sweigart (Al.Sweigart) * Date: 2015-04-15 13:32
It took me a while to read through the idle_test documentation to figure out how to run the test. Similar to the Profiler documentation, I've added "Instant User's Manual" section at the top of the file, as well as edited the text and formatting a bit.
msg241311 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2015-04-17 04:36
Although the text is aimed at people writing tests, I agree with starting with a new short section "0. Running all Idle tests".  The sentence already there is specific to automated unittests.  There is also a separate human-mediated test system run with "python -m idlelib.idle_test.htest" (more below).  This command should be added in this section.

Retesting, "python -m test.test_idle" on the command line no longer works for me on installed 3.4.3, Win7.  Instead I get

c:\Programs\Python34\python.exe: Error while finding spec for 'test.test_idle' (<class 'AttributeError'>: 'module' object has no attribute '__path__')

Did you get this or is does my install have a problem?  Running from the Idle editor works fine.  ">python -m test -v test_idle" fails with no output.

Onward: I do not want to indent code because I want people, including myself, to be able to cut and paste.  Some of the other edits look good at first glance.  I may have questions on some.

Something needs to be added to README about human-mediated tests, beyond the bottom-line summary in section 0.  There is a page long docstring in  I am not sure how much to move to or duplicate in README (after further editing).  Any opinion, as a naive reader?
msg241436 - (view) Author: Al Sweigart (Al.Sweigart) * Date: 2015-04-18 18:00
I'll add a note about running the human-mediated tests to section 0.

Running "python -m test.test_idle" for 64-bit 3.4.3 on Windows 7 works fine for me ("Ran 142 tests in 0.605s OK")

I'll take out the indented code. You make a good point about copy/paste.

I've added section 4 on human-mediated tests. I'd like to take a crack at improving the documentation a bit in before figuring out what to add to section 4. This can be addressed in a later patch.
msg243349 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2015-05-16 18:24
New changeset 19e111891e39 by Terry Jan Reedy in branch '2.7':
Issue #23964: Update idlelib/idle_test/README.txt. first patch by Al Sweigart.

New changeset 35b84ba2f8b1 by Terry Jan Reedy in branch '3.4':
Issue #23964: Update idlelib/idle_test/README.txt. first patch by Al Sweigart.
msg243351 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2015-05-16 18:28
Thanks for the push. I incorporated most of your suggestions and added more changes.
Date User Action Args
2022-04-11 14:58:15adminsetgithub: 68152
2015-05-16 18:28:54terry.reedysetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2015-05-16 18:28:24terry.reedysetmessages: + msg243351
2015-05-16 18:24:33python-devsetnosy: + python-dev
messages: + msg243349
2015-04-18 18:00:54Al.Sweigartsetfiles: + idle_test_readme.2.patch

messages: + msg241436
2015-04-17 04:36:16terry.reedysetversions: + Python 2.7, Python 3.4
nosy: + terry.reedy

messages: + msg241311

assignee: terry.reedy
stage: patch review
2015-04-15 13:32:47Al.Sweigartsettype: enhancement
2015-04-15 13:32:33Al.Sweigartcreate