Raise an ImportWarning when __spec__.parent/__package__ isn't defined for a relative import

[brettcannon]

BPO	25791
Nosy	@brettcannon, @ncoghlan, @pitrou, @scoder, @ericsnowcurrently
Files	issue25791.patch issue25791_2.patch

^{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 = 'https://github.com/brettcannon'
closed_at = <Date 2016-01-22.23:27:30.158>
created_at = <Date 2015-12-03.20:48:12.375>
labels = ['interpreter-core', 'type-feature']
title = "Raise an ImportWarning when __spec__.parent/__package__ isn't defined for a relative import"
updated_at = <Date 2017-06-26.21:50:10.205>
user = 'https://github.com/brettcannon'

bugs.python.org fields:

activity = <Date 2017-06-26.21:50:10.205>
actor = 'scoder'
assignee = 'brett.cannon'
closed = True
closed_date = <Date 2016-01-22.23:27:30.158>
closer = 'brett.cannon'
components = ['Interpreter Core']
creation = <Date 2015-12-03.20:48:12.375>
creator = 'brett.cannon'
dependencies = []
files = ['41609', '41611']
hgrepos = []
issue_num = 25791
keywords = ['patch']
message_count = 19.0
messages = ['255838', '258171', '258172', '258173', '258178', '258329', '258330', '258354', '258400', '258842', '294632', '294652', '294653', '294656', '294657', '294668', '294677', '294678', '296951']
nosy_count = 7.0
nosy_names = ['brett.cannon', 'ncoghlan', 'pitrou', 'scoder', 'python-dev', 'eric.snow', 'superluser']
pr_nums = []
priority = 'low'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue25791'
versions = ['Python 3.6']

[brettcannon]

When you do a relative import, package is used to help resolve it, but if it isn't defined we fall back on using name and path. We should probably consider raising an ImportWarning if package isn't defined so that some day we can consider cleaning up import and its call signature to be a bit more sane and drop the globals argument. It would also help people catch errors where they went overboard deleting attributes off a module.

We should probably even extend it to start using __spec__.parent and then falling back to __package__, and only after both are found missing do we raise the ImportWarning about needing to use __name__ and __path__. That way __import__ can simply start taking in the spec of the calling module to do all of its work instead of having to pass all of globals().

[superluser]

Patch with tests. Not sure if importlib.h should be included?

[brettcannon]

Including importlib.h doesn't hurt.

[superluser]

that's what I figured.

[superluser]

Thanks for the quick review, new patch uploaded.

[python-dev]

New changeset 6908b2c9a404 by Brett Cannon in branch 'default':
Issue bpo-25791: Raise an ImportWarning when __spec__ or __package__ are
https://hg.python.org/cpython/rev/6908b2c9a404

[brettcannon]

Thanks for the patch, Rose! I did notice your review comments about the missing goto and the stacklevel and I simply added them myself.

[ncoghlan]

Favouring __spec__.parent over __package__ will break the documented workaround in PEP-366 for enabling explicit relative imports from __main__ even when a module is run directly instead of via -m:

    if __name__ == "__main__" and __package__ is None:
        __package__ = "expected.package.name"

It may be that workaround is something we *want* to break (as per http://bugs.python.org/issue21762#msg258332 ), but if so, it's at least worthy of a porting note in the What's New document.

[brettcannon]

As I commented on another issue, I think I'm going to tweak the change to continue to prefer __package__, but raise ImportWarning when it doesn't match __spec__.parent. Once we do that for all attributes we can wait until Python 2.7 is done and then swap priority to __spec__ and raise a DeprecationWarning if __spec__ is missing. That way post-Python 2.7 we can move entirely to a spec-based import system.

[python-dev]

New changeset 219c44fe8968 by Brett Cannon in branch 'default':
Issue bpo-25791: Warn when __package__ != __spec__.parent.
https://hg.python.org/cpython/rev/219c44fe8968