Skip to content

[3.6] bpo-27505: Retrofit module __class__ documentation from 3.7 #5321

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
ncoghlan merged 2 commits into from
Jan 27, 2018
Merged

[3.6] bpo-27505: Retrofit module __class__ documentation from 3.7 #5321

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e4b575
bpo-27505: Retrofit module __class__ documentation from 3.7
csabella Jan 25, 2018
0543bd7
Change from versionadded to versionchanged
csabella Jan 26, 2018
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
33 changes: 33 additions & 0 deletions Doc/reference/datamodel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1500,6 +1500,39 @@ access (use of, assignment to, or deletion of ``x.name``) for class instances.
returned. :func:`dir` converts the returned sequence to a list and sorts it.


Customizing module attribute access
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. index::
single: __class__ (module attribute)

For a more fine grained customization of the module behavior (setting
attributes, properties, etc.), one can set the ``__class__`` attribute of
a module object to a subclass of :class:`types.ModuleType`. For example::

import sys
from types import ModuleType

class VerboseModule(ModuleType):
def __repr__(self):
return f'Verbose {self.__name__}'

def __setattr__(self, attr, value):
print(f'Setting {attr}...')
setattr(self, attr, value)

sys.modules[__name__].__class__ = VerboseModule

.. note::
Setting module ``__class__`` only affects lookups made using the attribute
access syntax -- directly accessing the module globals (whether by code
within the module, or via a reference to the module's globals dictionary)
is unaffected.

.. versionchanged:: 3.5
``__class__`` module attribute is now writable.


.. _descriptors:

Implementing Descriptors
Expand Down