test.support method for dual-testing accelerated code (fixes test_exceptions and other's pickle testing)

[abalkin]

BPO	9104
Nosy	@mdickinson, @abalkin, @pitrou, @avassalotti, @benjaminp, @ezio-melotti, @bitdancer
Files	test_exceptions.diff issue9104.diff

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2010-06-28.16:18:10.812>
labels = ['type-feature', 'library']
title = "test.support method for dual-testing accelerated code (fixes test_exceptions and other's pickle testing)"
updated_at = <Date 2014-09-29.14:23:39.728>
user = 'https://github.com/abalkin'

bugs.python.org fields:

activity = <Date 2014-09-29.14:23:39.728>
actor = 'belopolsky'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Library (Lib)']
creation = <Date 2010-06-28.16:18:10.812>
creator = 'belopolsky'
dependencies = []
files = ['17791', '17794']
hgrepos = []
issue_num = 9104
keywords = ['patch']
message_count = 15.0
messages = ['108840', '108843', '108854', '108860', '108881', '108941', '109026', '109032', '109053', '109059', '109060', '109062', '109082', '184150', '227710']
nosy_count = 7.0
nosy_names = ['mark.dickinson', 'belopolsky', 'pitrou', 'alexandre.vassalotti', 'benjamin.peterson', 'ezio.melotti', 'r.david.murray']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue9104'
versions = ['Python 3.5']

[abalkin]

This is probably one example of many where pickling is only tested with _pickle module if it is available rather than separately with C and Python implementation. I am attaching a patch which implements one possible testing strategy. If this is acceptable, I think the machinery of retrieving multiple module implementations should be moved to test.support and reused in other test modules.

[pitrou]

It looks good on the principle. As you say, factoring out this kind of machinery in test.support is probably the way to go.

[abalkin]

In the new patch, bpo-9104.diff, I factored out import machinery into test.support.import_module_implementations and added it to a a couple of other test modules. I did not attempt to improve all pickle tests.

The availability of import_module_implementations raises an interesting question of what to do in cases like heapq where one can potentially test 4 combinations of heapq/_heapq with pickle/_pickle. Given that currently pickling of heapq objects is either not supported or not tested, we don't need to worry about it, but as parallel optimized/pure python module implementations proliferate, we may face exponential explosion of potential test cases.

[avassalotti]

The code for import_module_implementations seems a bit fragile. Prefixing the module name with an underscore might not always yield the name of the optimized implementation. An explicit dictionary to map the Python and C implementations may be a better approach.

Otherwise, the code looks good. Feel free to commit it.

[pitrou]

An explicit dictionary to map the Python and C implementations may be a
better approach.

+1.

[abalkin]

An explicit dictionary to map the Python and C implementations may be a
better approach.

Do you mean a global

optimized_module = {'pickle': '_pickle'}

in test/support.py?

I don't think I like this idea. Even with an explicit dictionary like that, support.import_module_implementations() will not support all possible ways that alternative implementations of a given module may be provided in cpython. It works for pickle/_pickle and heapq/_heapq, but won't work for io/_io/_pyio. I would like import_module_implementations() to promote uniformity in the way parallel pure/native modules are designed. Test suites for modules that want more flexibility can always call import_fresh_module() directly.

[abalkin]

I would like to commit this as written. If a better mechanism for associating native implementation with a pure python module is found, it can easily be added in the future. Any objections? The patch only adds more test cases, no code is changed.

[avassalotti]

It works for pickle/_pickle and heapq/_heapq, but won't work for io/_io/_pyio.

You can make the dictionary values as lists for the 'blocked' argument for import_fresh_module(). That would work.

And, can you add documentation for import_module_implementations()? A description how it finds the optimized implementation of a module would be helpful too.

[abalkin]

You can make the dictionary values as lists for the 'blocked'
argument for import_fresh_module(). That would work [for io].

I don't understand how having multiple modules in the blocked list will help in io case. io.py will simply not work if _io is blocked. It does not use "define in Python, override with native if available" strategy. Instead, io.py and _pyio.py are independent complete implementations.

I don't like that approach because it makes pure python code hard to discover. In the recent discussions, some people were in fact surprised to learn that pure python io implementation is still available. The io/_pyio approach also prevents io.py from bring used by alternative python implementations unmodified.

What I can do, is to add an optional "blocked" argument import_module_implementations() along the lines of

def import_module_implementations(name, blocked=None):
    if blocked is None:
        blocked = ('_' + name,)
    ...

This will not solve the io issue, but will add some flexibility.

Note that import_module_implementations() as designed is not very useful for tests of the named module itself. In that case you need the implementations individually rather than as a list. This is mostly useful in situations like pickle where other modules are tested for interoperability with alternative pickle implementations.

Of course, I should document the mechanism once we agree on what it should be. :-) (I did not know that test.support had a reST document, but will update it for this patch.)

[pitrou]

> You can make the dictionary values as lists for the 'blocked'
> argument for import_fresh_module(). That would work [for io].

I don't understand how having multiple modules in the blocked list
will help in io case. io.py will simply not work if _io is blocked.

Which you avoid by giving an empty list of blocked modules, using
Alexandre's suggestion.

I don't like that approach because it makes pure python code hard to
discover.

Ok, but this code exists and it would be much better if it were
supported.

The io/_pyio approach also prevents io.py from bring used by
alternative python implementations unmodified.

It would be foolish to use it unmodified anyway, unless you like
low-speed I/O (and a JIT isn't a magic bullet).

The reason this was done like this is that the io module is imported at
startup: we want to avoid unnecessary parsing of extraneous code (and
unnecessary importing additional dependencies), and we also want to
reduce opportunities for failing to initialize the standard I/O streams
(especially stderr...).

This will not solve the io issue, but will add some flexibility.

Which is pointless unless such flexibility is needed by someone.

[bitdancer]

Please don't update the reST document. The support module should never have been documented outside the module itself, because now we are pretty much committed to otherwise needless backward compatibility for the stuff that is documented.

[abalkin]

On Thu, Jul 1, 2010 at 12:18 PM, Antoine Pitrou <report@bugs.python.org> wrote:
..

> I don't understand how having multiple modules in the blocked list
> will help in io case.  io.py will simply not work if _io is blocked.

Which you avoid by giving an empty list of blocked modules, using
Alexandre's suggestion.

Yes, you can make import_module_implementations('io') return [io] this way, but what the user is likely to expect would be [io, _pyio].

I understand that there are reasons to keep io the way it is, but most of the other modules should probably follow pickle approach. In any case, testing alternative io implementations is easy. No import block trickery is needed - just import io and _pyio separately.

I just don't like the idea of having test.support know details about other modules and would like to have a clear use case before doing anything more sophisticated than blocking '_' + name.

If we end up with a central registry of native optimizations, it should probably not be in test.support.