Skip to content

bpo-39336: Allow packages to not let their child modules be set on them #18006

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DinoV merged 8 commits into from
Jan 23, 2020
Merged

bpo-39336: Allow packages to not let their child modules be set on them #18006

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
78a9631
bpo-39336: Allow setattr to fail on modules which aren't assignable
DinoV Jan 14, 2020
862b536
📜🤖 Added by blurb_it.
blurb-it[bot] Jan 15, 2020
f2cfb2f
Move test to data folder and improve error formatting
DinoV Jan 16, 2020
245fd87
move to using addCleanup, and import from test.test_import
DinoV Jan 22, 2020
d17e87a
Update Lib/test/test_import/__init__.py
DinoV Jan 23, 2020
98dba44
Update Misc/NEWS.d/next/Core and Builtins/2020-01-15-01-39-29.bpo-393…
DinoV Jan 23, 2020
bbf8a94
Update __init__.py
DinoV Jan 23, 2020
1808b98
Update __init__.py
DinoV Jan 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion Lib/importlib/_bootstrap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -978,7 +978,12 @@ def _find_and_load_unlocked(name, import_):
if parent:
# Set the module as an attribute on its parent.
parent_module = sys.modules[parent]
setattr(parent_module, name.rpartition('.')[2], module)
child = name.rpartition('.')[2]
try:
setattr(parent_module, child, module)
except AttributeError:
msg = f"Cannot set an attribute on {parent!r} for child module {child!r}"
_warnings.warn(msg, ImportWarning)
return module


Expand Down
22 changes: 21 additions & 1 deletion Lib/test/test_import/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import errno
import glob
import importlib.util
import inspect
Comment thread
DinoV marked this conversation as resolved.
Outdated
from importlib._bootstrap_external import _get_sourcefile
import marshal
import os
Expand All @@ -26,7 +27,7 @@
temp_dir, DirsOnSysPath)
from test.support import script_helper
from test.test_importlib.util import uncache

from types import ModuleType

skip_if_dont_write_bytecode = unittest.skipIf(
sys.dont_write_bytecode,
Expand All @@ -49,6 +50,8 @@ def _ready_to_import(name=None, source=""):
# reverts or removes the module when cleaning up
name = name or "spam"
with temp_dir() as tempdir:
if os.sep in name:
os.makedirs(os.path.join(tempdir, name.rpartition(os.sep)[0]))
path = script_helper.make_script(tempdir, name, source)
old_module = sys.modules.pop(name, None)
try:
Expand Down Expand Up @@ -1339,6 +1342,23 @@ def test_circular_from_import(self):
str(cm.exception),
)

def test_unwritable_module(self):
sys.path.insert(0, os.path.join(os.path.dirname(__file__), 'data'))

@brettcannon brettcannon Jan 17, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the path insertion instead of importing test.test_import.data.unwritable?

@DinoV DinoV Jan 22, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was actually just following the pattern I saw in test_concurrency but this is certainly much cleaner!

try:
try:
import unwritable
with self.assertWarns(ImportWarning):
from unwritable import x

self.assertNotEqual(type(unwritable), ModuleType)
self.assertEqual(type(x), ModuleType)
with self.assertRaises(AttributeError):
unwritable.x = 42
finally:
sys.modules['unwritable.x']

@brettcannon brettcannon Jan 17, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is delete the module then you can use a helper in test.support and register it with addCleanup().

@DinoV DinoV Jan 22, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, will do!

sys.modules['unwritable']
finally:
del sys.path[0]

if __name__ == '__main__':
# Test needs to be a package, so we can do relative imports.
Expand Down
12 changes: 12 additions & 0 deletions Lib/test/test_import/data/unwritable/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import sys

class MyMod(object):
__slots__ = ['__builtins__', '__cached__', '__doc__',
'__file__', '__loader__', '__name__',
'__package__', '__path__', '__spec__']
def __init__(self):
for attr in self.__slots__:
setattr(self, attr, globals()[attr])


sys.modules[__name__] = MyMod()
Empty file added Lib/test/test_import/data/unwritable/x.py
View file
Open in desktop
Empty file.
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Core and Builtins/2020-01-15-01-39-29.bpo-39336.nJ7W9I.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Import loaders which publish immutable module objects can now publish immutable packages in addition to individual modules
Comment thread
DinoV marked this conversation as resolved.
Outdated
Loading