Extend PEP 562 with __setattr__ for modules?

Since CPython 3.5 it’s possible to customize setting module attributes by setting __class__ attribute. Unfortunately, this coming with a measurable speed regression for attribute access:

$ cat b.py
x = 1
$ python -m timeit -r11 -s 'import b' 'b.x'
5000000 loops, best of 11: 48.8 nsec per loop
$ cat c.py
import sys, types
x = 1
class _Foo(types.ModuleType): pass
sys.modules[__name__].__class__ = _Foo
$ python -m timeit -r11 -s 'import c' 'c.x'
2000000 loops, best of 11: 131 nsec per loop

For reading attributes this could be workarounded with __getattr__, but there is no similar support for __setattr__. Maybe it does make sense as well (or even for __delattr__)? If so, will this require
a PEP? (Draft implementation is in GitHub - skirpichev/cpython at module-setattr)

As a background story, this solution come from the mpmath issue ENH: guard against incorrect use of `mp.dps`? · Issue #657 · mpmath/mpmath · GitHub In short, people are trying to set precision attributes not on the context object (mpmath.mp, e.g. mpmath.mp.dps), but on the mpmath module. Probably, this is a very special scenario, but…

1 Like

To be clear, this is __setattr__ for module objects?

Not necessarily, but since it would potentially impact all modules and the setting of module attributes it could come to that in the end.

Yes.

The context here is:

Without going into the details of the issue it would be useful if there was someway to intercept a user setting an attribute on a module to either warn or raise an error. For example if a user does

import mpmath as mp
mp.dps = 100

then that will not work as intended. The correct way is

from mpmath import mp
mp.dps = 100

Here mp is a special non-module object that can interpret its dps attribute and do something useful with it.

In the interest of communicating errors helpfully to users it would be good to be able to make it an error to set an attribute on a module so e.g. mpmath.dps = 100 (where mpmath is a module) could be an error. Currently this is only possible by replacing the module object with a proxy in sys.modules but I expect that being able to protect a module from arbitrary attribute assignment would be a useful feature in general.

__getattr__ has very little performance impact because it is called only when the attribute is not found.

On the other hand, __setattr__ would be called for every attribute access. So it might have performance impact like __class__ hack.

I agree that this is a very specail scenario.

1 Like

With a class, we can define its slots and then any new attributes are instant errors. What if modules could do the same? It wouldn’t let you fully customize the error (and thus point people to the correct way to do things), but it’d prevent the scenario of “no error, just wrong behaviour” and would give people an error that they can ask about.

1 Like

__setattr__ would only be called when an assignment was attempted; __getattribute__ is the one that’s called all the time. (Unless it’s different at the C level.)

In the above example (wich __class__ hack) actually neither __getattr__ or __setattr__ was changed. Yet attribute reading is affected (~2x speed loss).

Only for setting attributes, here is a test on my branch (same timings as without __class__ hack):

$ cat d.py 
x = 1
def __setattr__(name, value):
    if name == 'spam':
        raise AttributeError
    globals()[name] = value
$ python -m timeit -r11 -s 'import d' 'd.x'
5000000 loops, best of 11: 48.8 nsec per loop

Sorry, I meant all attribute assignment.

This thread looks to me like there might be some miscommunication going on, so I want to try to share my understanding first.

I think that OP is not concerned with slowing down attribute assignment here, because assigning an attribute to an imported module is much less common than looking up an attribute there. The goal is to have some way to intercept attribute assignment so that an exception can be raised to guard against programming errors; of course we should expect this to have some overhead. However, the current best solution for intercepting attribute assignment, means that attribute lookup will also be slowed down. (I assume this is because we now have to work through a Python implementation of the module class instead of using a built-in one.)

However, if we add a __setattr__ hook to the C implementation, although that doesn’t impact on attribute lookups (satisfying OP’s use case), it presumably would slow down assigning attributes to modules for everybody. OP isn’t bothered by this in a SciPy or mpmath context, but a change like that needs serious consideration since the overhead cost would be paid even by people who don’t plan to use the hook.


Personally, my intuition is that it might still be worthwhile. It’s hard for me to imagine a popular third-party library that expects the user to set attributes on modules imported from the library, enough times to become a performance concern. On the other hand, a tight loop repeatedly calling some library function is pretty easy to imagine (granted, the user could trivially cache this lookup).

On the other hand, it’s commonly enough incorrect to assign attributes to a module (after import) that I almost wonder if it needs to be supported by default. (If I had to choose, I find it more annoying not being able to set attributes on an ordinary object instance - that also makes it harder to teach beginners about the concept of attributes in general, at least with my teaching style).

Therefore, I like this suggestion, assuming it works as expected. It should address OP’s use case and, if anything, improve performance rather than making it worse. Meanwhile, people who want to do fancy things with setting attributes on modules still have the option of taking the performance hit of a user-defined subclass (and if they want to do really fancy things, the __setattr__ hook is right there for them, because they already defined a class in Python).

For bonus points, a bit of standard library support, along the lines of:

from types import ModuleType
import sys

def module_setattr_hook(func=None):
    """
    A decorator to enable custom logic for setting module attributes.
    Decorate a top-level function in a module, to make it implement
    attribute assignment for the module. It should accept three arguments:
    * self: types.ModuleType - the module being modified.
    * attr: str -> the name of the attribute being set.
    * value -> the new value for the attribute.
    Alternately, just call `module_setattr_hook()` to make it possible
    to set attributes with no special logic.
    """
    module = sys.modules[func.__module__]
    cls = module.__class__
    if cls is types.ModuleType:
        # base type, needs to be swapped with a user type
        cls = type('_UserModule', (types.ModuleType,), {})
        module.__class__ = cls
        # otherwise, just monkey-patch the existing type
    if func is not None:
        cls.__setattr__ = func
    return func

The problem is that I don’t see a measurable difference for naive tests with timeit (~same numbers in the main and on the branch):

$ cat b.py 
x = 1
$ python -m timeit -r11 -s 'import b' 'b.x=2'  # name exists in __dict__
5000000 loops, best of 11: 97.4 nsec per loop
$ python -m timeit -r11 -s 'import b' 'b.y=2'
5000000 loops, best of 11: 97.4 nsec per loop

That’s why this obvious concern wasn’t mentioned in my top post:)

The cost is an additional call PyDict_GetItemWithError() to check if there is a __getattr__ helper.

Also, as you pointed out, intensive using of attribute assignments for modules is a very exotic scenario, while reading attributes - is not. Unfortunately, the __class__ hack affects the second case even if you are using it to customize assignment of attributes… So, slight speed regression for exotic scenarios seems to be a fair trade off.

Only partially. It lacks a user-friendly exception message.

Well, yes; you’re comparing two use cases within the current existing functionality. If the built-in type had a __setattr__ hook, it would have to be invoked in both cases, and doing so would take more time than the current approach, which doesn’t.

Does the standard AttributeError not explain well enough, given the circumstance?
… Actually, I have some separate proposals there.

Not only that. It makes:

  • Python semantics complex.
  • Cpython and other implementation complex.
  • Need special care for it when optimizing the interpreter.

Python is very dynamic language already. I am very conservative about making Python even more dynamic.

Emitting DeprecationWarning and lazy import are useful for many packages. That’s why I like module __getattr__. I don’t know how module __setattr__ is useful for packages other than this specific case.

You meant if the module had __setattr__ hook, right? That’s true, but we are talking about the cost for people who don’t plan to use the hook. In this case it should be safe to assume there is no such name in the module’s dict. From PEP 562:

This PEP may break code that uses module level (global) names __getattr__ and
__dir__. (But the language reference explicitly reserves all undocumented dunder
names, and allows “breakage without warning”

Well, it certainly doesn’t show to user how to fix the problem.

Write-protecting module constants could be useful, if __setattr__ was called on all write access.

PS: But more appropriate and useful would be module-level descriptors.

How is it important for Python future?
I think this change needs a PEP. The PEP can list such use cases.

2 Likes

It just occurred to me, trying to control __setattr__ on modules would also cause problems for packages. If I want to import a.b, it will be problematic if a is a module instance and the default module denies (via __slots__) permission to attach any attributes that weren’t defined during a’s creation.

I think the response to that would be “don’t do that, then”. Use of __slots__ would be incompatible with lazy loading of a package’s modules.

(Eager loading would be no harder to handle than any other names, you just import them all and then __slots__ = tuple(globals()) or whatever the recommended idiom is.)

I misunderstood your original suggestion, then. I thought you were proposing to add such a mechanism to the builtin type.

I figured that using __slots__ on non-package modules is already possible, if you derive from types.ModuleType. However, it seems that such a declaration is ignored.

After reading PEP 713, I am +1 for both of __call__ and __setattr__.

Thanks for blessing. I’ll try to prepare a PEP. Unfortunately, probably now there is no chance that this could enter 3.12 if accepted…