Skip to content

Immutable module type can't be used as package in custom loader #83517

Closed

Description

@DinoV
BPO 39336
Nosy @brettcannon, @vstinner, @DinoV, @corona10
PRs
  • bpo-39336: Allow packages to not let their child modules be set on them #18006
  • 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/DinoV'
    closed_at = <Date 2020-01-23.00:57:27.184>
    created_at = <Date 2020-01-14.21:33:31.500>
    labels = ['interpreter-core', 'type-bug']
    title = "Immutable module type can't be used as package in custom loader"
    updated_at = <Date 2020-01-28.02:21:01.711>
    user = 'https://github.com/DinoV'

    bugs.python.org fields:

    activity = <Date 2020-01-28.02:21:01.711>
    actor = 'vstinner'
    assignee = 'dino.viehland'
    closed = True
    closed_date = <Date 2020-01-23.00:57:27.184>
    closer = 'dino.viehland'
    components = ['Interpreter Core']
    creation = <Date 2020-01-14.21:33:31.500>
    creator = 'dino.viehland'
    dependencies = []
    files = []
    hgrepos = []
    issue_num = 39336
    keywords = ['patch']
    message_count = 7.0
    messages = ['360000', '360006', '360014', '360164', '360525', '360745', '360832']
    nosy_count = 4.0
    nosy_names = ['brett.cannon', 'vstinner', 'dino.viehland', 'corona10']
    pr_nums = ['18006']
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = 'behavior'
    url = 'https://bugs.python.org/issue39336'
    versions = []

    Activity

    1. DinoV commented on Jan 14, 2020

      @DinoV
      ContributorAuthor

      I'm trying to create a custom module type for a custom loader where the returned modules are immutable. But I'm running into an issue where the immutable module type can't be used as a module for a package. That's because the import machinery calls setattr to set the module as an attribute on it's parent in _boostrap.py

              # Set the module as an attribute on its parent.
              parent_module = sys.modules[parent]
              setattr(parent_module, name.rpartition('.')[2], module)

      I'd be okay if for these immutable module types they simply didn't have their children packages published on them.

      A simple simulation of this is a package which replaces its self with an object which doesn't support adding arbitrary attributes:

      x/init.py:
      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['x'] = MyMod()

      x/y.py:
      # Empty file

      >>> from x import y
      Traceback (most recent call last):
        File "<stdin>", line 1, in <module>
        File "<frozen importlib._bootstrap>", line 983, in _find_and_load
        File "<frozen importlib._bootstrap>", line 971, in _find_and_load_unlocked
      AttributeError: 'MyMod' object has no attribute 'y'

      There's a few different options I could see on how this could be supported:
      1) Simply handle the attribute error and allow things to continue
      2) Add ability for the modules loader to perform the set, and fallback to setattr if one isn't available. Such as:
      getattr(parent_module, 'add_child_module', setattr)(parent_module, name.rpartition('.')[2], module)
      3) Add the ability for the module type to handle the setattr:
      getattr(type(parent_module), 'add_child_module', fallback)(parent_module,
      , name.rpartition('.')[2], module)

    2. self-assigned this
      on Jan 14, 2020
    3. added
      interpreter-core(Objects, Python, Grammar, and Parser dirs)
      type-bugAn unexpected behavior, bug, or error
      on Jan 14, 2020
    4. self-assigned this
      on Jan 14, 2020
    5. added
      interpreter-core(Objects, Python, Grammar, and Parser dirs)
      type-bugAn unexpected behavior, bug, or error
      on Jan 14, 2020
    6. brettcannon commented on Jan 14, 2020

      @brettcannon
      Member

      So I think this is way too marginal a use-case to expand the API to let loaders inject themselves into the semantics of it.

      I assume going with option 1 but raising an ImportWarning would be too noisy for your use-case? If not I'm totally fine with that solution.

    7. DinoV commented on Jan 14, 2020

      @DinoV
      ContributorAuthor

      I think the warning shouldn't be too bad. It looks like ImportWarnings are filtered by default already, and the extra overhead of raising a warning in this case probably is nothing compared to the actual work in loading the module.

    8. corona10 commented on Jan 17, 2020

      @corona10
      Member

      I apologize for the noise caused by the wrong PR connection.

    9. DinoV commented on Jan 23, 2020

      @DinoV
      ContributorAuthor

      New changeset 9b6fec4 by Dino Viehland in branch 'master':
      bpo-39336: Allow packages to not let their child modules be set on them (bpo-18006)
      9b6fec4

    10. vstinner commented on Jan 27, 2020

      @vstinner
      Member

      test_unwritable_module() fails on AMD64 Fedora Stable Clang Installed 3.x: bpo-39459.

    11. vstinner commented on Jan 28, 2020

      @vstinner
      Member

      commit 2528a6c
      Author: Dino Viehland <dinoviehland@gmail.com>
      Date: Mon Jan 27 14:04:56 2020 -0800

      Add test.test_import.data.unwritable package to makefile (bpo-18211)
      
    12. transferred this issue fromon Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Metadata

    Metadata

    Assignees

    Labels

    interpreter-core(Objects, Python, Grammar, and Parser dirs)type-bugAn unexpected behavior, bug, or error

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions