[issue18576] Rename and document test.script_helper as test.support.script_helper

[Eric Snow]

Changes by Eric Snow :


--
nosy: +eric.snow

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18576] Rename and document test.script_helper as test.support.script_helper

[Nick Coghlan]

Nick Coghlan added the comment:

The attached patch just moves the file without leaving an alias behind. It 
turns out we use this one in a fair few places (mostly for "assert_python_ok").

I'm going to sit on this change for the moment - after reading the docs, it's 
quite clear that the last couple of functions don't really belong in 
script_helper, but rather in the pkg_helper module discussed in issue 15376.

So my current plan is to factor that helper out *first*, then when this one 
lands, the intent of grouping more of the support code that folks working on 
the test suite might be interested in using together will hopefully be clearer.

--
dependencies: +Refactor the test_runpy walk_package support code into a common 
location
Added file: 
http://bugs.python.org/file33188/issue18576_move_and_document_script_helper.diff

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18576] Rename and document test.script_helper as test.support.script_helper

[Nick Coghlan]

Nick Coghlan added the comment:

Note that the test.* namespace has long been declared as unstable, so we
don't worry about breaking third party code when rearranging the test suite
(as far as I am aware, most Linux distros don't even include the test suite
in their Python packages).

I'll see how Mercurial goes tracking the file move when the alias is left
behind, and decide which way to do the initial change based on whether or
not the alias breaks the history tracking.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18576] Rename and document test.script_helper as test.support.script_helper

[Fotis Koutoulakis]

Fotis Koutoulakis added the comment:

Taking the feedback during code review, this is a patch that has the points 
raised by Serhiy Storchaka fixed.

As always, please do note omission or mistakes from my part. Thanks for your 
help.

--
Added file: http://bugs.python.org/file33057/issue18576_third_try.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18576] Rename and document test.script_helper as test.support.script_helper

[Serhiy Storchaka]

Serhiy Storchaka added the comment:

> Does the last patch meet your expectations, or would you rather see all these 
> changes implemented at once?

I left this for Nick.

I have added comments on Rietveld.

--
stage: needs patch -> patch review

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18576] Rename and document test.script_helper as test.support.script_helper

[Fotis Koutoulakis]

Fotis Koutoulakis added the comment:

Oh, I see. Does the last patch meet your expectations, or would you rather see 
all these changes implemented at once?

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18576] Rename and document test.script_helper as test.support.script_helper

[Serhiy Storchaka]

Serhiy Storchaka added the comment:

Third party code can use tests.script_helper.

I prefer to do these changes in several steps:

1) Move script_helper.py to Lib/test/support/, document it, and create an alias 
(with deprecation warning).
2) Ensure that this doesn't break any buildbot.
3) Change tests to use test.support.script_helper instead of test.script_helper.
4) One or two versions later remove an alias.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18576] Rename and document test.script_helper as test.support.script_helper

[Fotis Koutoulakis]

Fotis Koutoulakis added the comment:

Ok, here is the second (modified patch) which contains a script so that no 
modifications are required to existing tests.

I am uploading it as a second patch, so that the first one is left as a 
reference.

As a sidenote, I fail to see convincing reasons for why we would want the 
second solution more than the first. The first one looks cleaner to my eyes. 
The only downside I can see to the original approach is breaking a couple of 
tests, which is something that can be fixed easily without even making it to 
the repo (running the tests in 2-3 could help find all possible broken tests 
beforehand).

Could someone explain to me why the second solution is more desirable?

--
Added file: http://bugs.python.org/file33055/issue_18576_second.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18576] Rename and document test.script_helper as test.support.script_helper

[Serhiy Storchaka]

Serhiy Storchaka added the comment:

Please left test.script_helper as alias to test.support.script_helper.

I.e. test/script_helper.py should contains something like:

from test.support.script_helper import *

And test this with unmodifiable other tests.

--
nosy: +serhiy.storchaka

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18576] Rename and document test.script_helper as test.support.script_helper

[Fotis Koutoulakis]

Fotis Koutoulakis added the comment:

Hello again.

Is everything ok with the patch? Is there something not working as expected? 
Perhaps an omission or something? Do I need to do something more to get it 
accepted?

Thanks for your time.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18576] Rename and document test.script_helper as test.support.script_helper

[Nick Coghlan]

Changes by Nick Coghlan :


--
assignee: docs@python -> ncoghlan

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18576] Rename and document test.script_helper as test.support.script_helper

[Nick Coghlan]

Nick Coghlan added the comment:

I wouldn't worry about 3.3 at this point - the 3.3 test suite isn't going to 
see major changes for its final release, so the risk of merge conflicts is low.

--
versions:  -Python 3.3

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18576] Rename and document test.script_helper as test.support.script_helper

[Fotis Koutoulakis]

Fotis Koutoulakis added the comment:

I have finished the changes needed to move script_helper from Lib/test to 
Lib/test/support, and I have also documented it. Tests run gracefully (but be 
sure to check out if it works as intended on your machines too)

Two notes though:

1. I have only made the changes on the default branch. Will do 3.3 tomorrow.

2. When it came to the documentation, I had to break the 80 characters limit, 
as going by it was resulting in weird rendering or wrong information depicted 
from sphinx (for example, when showing that script_helper functions belonged to 
test.support instead of the correct location, test.support.script_helper).

Last but not least, this is one of my first contributions to Python, so I would 
appreciate your input.

--
keywords: +patch
nosy: +Fotis.Koutoulakis
Added file: http://bugs.python.org/file33049/script_helper-default.patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18576] Rename and document test.script_helper as test.support.script_helper

[Seydou Dia]

Seydou Dia added the comment:

Since I am already on bugs.python.org/issue18578 I will tackle this issue, if 
you don't mind.

--
nosy: +seydou

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18576] Rename and document test.script_helper as test.support.script_helper

[Ezio Melotti]

Changes by Ezio Melotti :


--
keywords: +easy
nosy: +ezio.melotti
stage:  -> needs patch

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue18576] Rename and document test.script_helper as test.support.script_helper

[Nick Coghlan]

New submission from Nick Coghlan:

tests.script_helper provides various utilities for sensibly testing scripts in 
a subprocess. It isn't easy for CPython developers to discover, since it is 
isn't documented and the file is mixed in with actual tests in the main test 
directory.

As discussed in #15494, it should be:

1. Moved from Lib/test/ to Lib/test/support (and imports in tests adjusted 
accordingly)
2. Documented in Doc/library/test.rst

These changes should be made on both the 3.3 and default branches to avoid 
spurious merge conflicts.

--
assignee: docs@python
components: Documentation, Tests
messages: 193819
nosy: docs@python, ncoghlan
priority: normal
severity: normal
status: open
title: Rename and document test.script_helper as test.support.script_helper
type: enhancement
versions: Python 3.3, Python 3.4

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com