Skip to content

bpo-17422:language reference should specify restrictions on class namespace #18559

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
merged 12 commits into from
Feb 22, 2020
Merged

bpo-17422:language reference should specify restrictions on class namespace #18559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
67042fc
language reference should specify restrictions on class namespace
ananthan-123 Feb 19, 2020
3cc613c
📜🤖 Added by blurb_it.
blurb-it[bot] Feb 19, 2020
5344bd5
Update 2020-02-19-11-13-47.bpo-17422.g7_9zz.rst
ananthan-123 Feb 19, 2020
ce1211d
Update datamodel.rst
ananthan-123 Feb 21, 2020
50bf96c
Update datamodel.rst
ananthan-123 Feb 21, 2020
fe0e189
Update datamodel.rst
ananthan-123 Feb 21, 2020
0cbefbd
Update Doc/reference/datamodel.rst
ananthan-123 Feb 21, 2020
8ff956a
Update Misc/NEWS.d/next/Documentation/2020-02-19-11-13-47.bpo-17422.g…
ananthan-123 Feb 21, 2020
1d37fb2
Update datamodel.rst
ananthan-123 Feb 21, 2020
c0d6251
Update datamodel.rst
ananthan-123 Feb 21, 2020
9823caa
Update datamodel.rst
ananthan-123 Feb 21, 2020
1c648cd
Update Misc/NEWS.d/next/Documentation/2020-02-19-11-13-47.bpo-17422.g…
ananthan-123 Feb 22, 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
6 changes: 4 additions & 2 deletions Doc/reference/datamodel.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1946,10 +1946,12 @@ Once the appropriate metaclass has been identified, then the class namespace
is prepared. If the metaclass has a ``__prepare__`` attribute, it is called
as ``namespace = metaclass.__prepare__(name, bases, **kwds)`` (where the
additional keyword arguments, if any, come from the class definition). The
``__prepare__`` method should be implemented as a :func:`classmethod`.
``__prepare__`` method should be implemented as a :func:`classmethod`. The
namespace returned by ``__prepare__`` is passed in to ``__new__``, but when
the final class object is created the namespace is copied into a new ``dict``.

If the metaclass has no ``__prepare__`` attribute, then the class namespace
is initialised as an empty ordered mapping.
Copy link
Member

@ericsnowcurrently ericsnowcurrently Feb 28, 2020

Choose a reason for hiding this comment

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

Per PEP 520, the default class namespace must be an ordered mapping and the original text here was purposefully phrased. While we've talked about requiring "dict" to be ordered (in the language reference), that hasn't happened. So changing the language spec text here to "dict" is inappropriate without a PEP. Note that elsewhere in the language reference the "ordered mapping" phrasing still exists.

Copy link
Member

@gvanrossum gvanrossum Feb 28, 2020

Choose a reason for hiding this comment

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

Um, dict is required to be ordered. Since 3.7. See the 3.7. what's new doc "the insertion-order preservation nature of dict objects has been declared to be an official part of the Python language spec."

If after that has sunk in you still think this PR is wrong, please submit a new PR to fix it! (Sorry for landing prematurely.)

Copy link
Contributor

@cdonovick cdonovick Feb 28, 2020

Choose a reason for hiding this comment

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

Per my comment on the bpo I think @ericsnowcurrently is right but for the wrong reasons. I have opened a PR correcting the wording. #18682

is initialised as an empty :func:`dict`.

.. seealso::

Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2020-02-19-11-13-47.bpo-17422.g7_9zz.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The language reference now specifies restrictions on class namespaces. Adapted from a patch by Ethan Furman.