bpo-40304: Correct type(name, bases, dict) doc by verhovsky · Pull Request #19553 · python/cpython · GitHub

https://bugs.python.org/issue40304

Please correct me if there's some gotcha I'm missing, but if classes inherit from object, then don't they also do that when created via type?

>>> type('X', (object,), dict(a=1)).__bases__
(<class 'object'>,)
>>> type('X', (), dict(a=1)).__bases__
(<class 'object'>,)

No gotcha, in Python 3 both are equivalent.

This means that this bit of the docs (a couple paragraphs before your change) is not strictly accurate:

the bases class name and becomes the :attr:~definition.__name__ attribute; the bases tuple itemizes the base classes and becomes the :attr:~class.__bases__ tuple itemizes the base classes and becomes the :attr:~class.__bases__ attribute

object ends up in __bases__ even when implicitly added by the metaclass!

E'ric, can you finish this off, with blurb and possible additional doc change?

Ping, @merwok?

Hi! I will come back to this.

@taleinat @terryjreedy Please review additional changes!

class dict does not become instance __dict__ at all
itemizes is an obscure term, I thought about using enumerates but went for the simpler contains
I think this does not need a NEWS note, unless this is the first contribution from the PR author in which case I will add one to give attribution as a thank-you 🙂

I have added the skip news and backport labels. If there is no negative review about the wording I will merge this in a couple days!

This is an important fix and I like the direction!

However, the new wording is still not accurate: When providing one or more base classes, object is not added to __bases__. For example:

>>> class A:
	pass
>>> type('B', (A,), {}).__bases__
(<class '__main__.A'>,)

Also, if the attributes dict doesn't become __dict__, what exactly is done with it? Perhaps this would be a good place for a link to the docs about class instantiation?

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Also, if the attributes dict doesn't become dict, what exactly is done with it?

It is passed to the metaclass so that functions become methods, other descriptors do their thing, and all attributes are stored in the class object in the end… in TheClass.__dict__! (instance __dict__ is only for instance attributes)

Text I removed:

the dict dictionary is the namespace containing definitions
for class body and is copied to a standard dictionary to become the
:attr:~object.__dict__ attribute.

so it was not wrong but could be confusing; what do you think about this change:

to become the :attr:~object.__dict__ attribute of the class object.

(let me check if the link target only talks about class instances)

LGTM. Small suggestion about the NEWS entry, @terryjreedy.

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

And if you don't make the requested changes, you will be put in the comfy chair!

Co-authored-by: Tal Einat <532281+taleinat@users.noreply.github.com>

…LK7Ps.rst Co-authored-by: Tal Einat <532281+taleinat@users.noreply.github.com>

Made requested changes

Where does this link go?

class.__bases__ is at https://docs.python.org/3/library/stdtypes.html#class.__bases__
does class.__dict__ go to https://docs.python.org/3/reference/datamodel.html#index-48 ?

No link is created!

Ideas:

keep object.__dict__ but amend the doc there (in library/stdtypes) to describe __dict__ for class objects
change the reference to be to __dict__ (class attribute)

Since I changed object to class and that does not work, I changed it back for this issue, so it continues to link to
file:///F:/dev/3x/Doc/build/html/library/stdtypes.html#object.dict
Since 'objects' include 'classes', the current text is not incorrect. I consider changing it a separate issue.
If classes were the only objects with dict attribute (I am not sure), and object.dict should be class.dict, a change would require grepping for other references to change. This would be a different issue also.

one change needed

Thanks @verhovsky for the PR, and @terryjreedy for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8, 3.9.
🐍🍒⛏🤖

Co-authored-by: Éric Araujo <merwok@netwok.org> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Tal Einat <532281+taleinat@users.noreply.github.com> (cherry picked from commit 644d528) Co-authored-by: Борис Верховский <boris.verk@gmail.com>

GH-24295 is a backport of this pull request to the 3.9 branch.

Co-authored-by: Éric Araujo <merwok@netwok.org> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Tal Einat <532281+taleinat@users.noreply.github.com> (cherry picked from commit 644d528) Co-authored-by: Борис Верховский <boris.verk@gmail.com>

GH-24296 is a backport of this pull request to the 3.8 branch.

Co-authored-by: Éric Araujo <merwok@netwok.org> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Tal Einat <532281+taleinat@users.noreply.github.com> (cherry picked from commit 644d528) Co-authored-by: Борис Верховский <boris.verk@gmail.com>

Boris, you have 6 merged PRs before this. After checking them, I think you qualify for a listing in Misc/acks. If you make a PR with no issue or news to add yourself, with the improved English transliteration, and request my review, I will merge it, and ask for a 3.9 backport.

Co-authored-by: Éric Araujo <merwok@netwok.org> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Tal Einat <532281+taleinat@users.noreply.github.com> (cherry picked from commit 644d528) Co-authored-by: Борис Верховский <boris.verk@gmail.com>

Co-authored-by: Éric Araujo <merwok@netwok.org> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Tal Einat <532281+taleinat@users.noreply.github.com>

Remove unnecessary object base class from type docs

5ad9238

the-knights-who-say-ni added the CLA signed label Apr 16, 2020

bedevere-bot added docs Documentation in the Doc dir awaiting review labels Apr 16, 2020

verhovsky changed the title Remove unnecessary object base class from type docs bpo-40304: remove unnecessary object base class from type docs Apr 16, 2020

terryjreedy added needs backport to 3.7 labels Apr 30, 2020

terryjreedy reviewed Apr 30, 2020

View reviewed changes

merwok self-assigned this Apr 30, 2020

terryjreedy added needs backport to 3.9 and removed needs backport to 3.7 labels Sep 27, 2020

More doc updates

80a6ecf

merwok changed the title bpo-40304: remove unnecessary object base class from type docs bpo-40304: correct some notes in type doc Sep 30, 2020

restore dict() instead of dict literal

2ffbfc2

merwok added skip news awaiting core review and removed awaiting review labels Oct 19, 2020

taleinat previously requested changes Oct 20, 2020

View reviewed changes

Comment thread Doc/library/functions.rst

bedevere-bot added awaiting changes and removed awaiting core review labels Oct 20, 2020

terryjreedy self-assigned this Jan 21, 2021

taleinat reviewed Jan 21, 2021

View reviewed changes

Comment thread Misc/NEWS.d/next/Documentation/2021-01-20-23-03-49.bpo-40304.-LK7Ps.rst Outdated

taleinat previously requested changes Jan 21, 2021

View reviewed changes

Comment thread Doc/library/functions.rst Outdated

bedevere-bot added the awaiting changes label Jan 21, 2021

terryjreedy and others added 2 commits January 21, 2021 17:00

Update Doc/library/functions.rst

5de9bac

Co-authored-by: Tal Einat <532281+taleinat@users.noreply.github.com>

Update Misc/NEWS.d/next/Documentation/2021-01-20-23-03-49.bpo-40304.-…

991ecfa

…LK7Ps.rst Co-authored-by: Tal Einat <532281+taleinat@users.noreply.github.com>

merwok reviewed Jan 21, 2021

View reviewed changes

merwok previously approved these changes Jan 21, 2021

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting changes labels Jan 21, 2021

merwok self-requested a review January 21, 2021 22:27

verhovsky and others added 2 commits January 21, 2021 23:53

Change my name

ba278e6

class to object for __dict__

78c4319

terryjreedy merged commit 644d528 into python:master Jan 22, 2021

bedevere-bot removed the awaiting merge label Jan 22, 2021

bedevere-bot removed the needs backport to 3.9 label Jan 22, 2021

bedevere-bot removed the needs backport to 3.8 label Jan 22, 2021

verhovsky mentioned this pull request Sep 12, 2021

Remove inheriting from object when creating classes with type() asottile/pyupgrade#532

Open

+                 :attr:`~class.__bases__` attribute; if empty, :class:`object`, the
+                 ultimate base of all classes, is added.  The *dict* dictionary contains
+                 attribute and method definitions for the class body; it may be copied
+                 or wrapped before becoming the :attr:`~class.__dict__` attribute.

bpo-40304: Correct type(name, bases, dict) doc by verhovsky · Pull Request #19553 · python/cpython · GitHub

Repository navigation

bpo-40304: Correct type(name, bases, dict) doc - #19553

bpo-40304: Correct type(name, bases, dict) doc#19553terryjreedy merged 9 commits intopython:masterpython/cpython:masterfrom verhovsky:patch-7verhovsky/cpython:patch-7Copy head branch name to clipboard

Conversation

verhovsky commented Apr 16, 2020 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

verhovsky commented Apr 16, 2020

Uh oh!

merwok commented Apr 17, 2020

Uh oh!

terryjreedy left a comment

Choose a reason for hiding this comment

Uh oh!

taleinat commented Sep 26, 2020

Uh oh!

merwok commented Sep 27, 2020

Uh oh!

merwok commented Sep 30, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

merwok commented Oct 19, 2020

Uh oh!

taleinat left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bedevere-bot commented Oct 20, 2020

Uh oh!

merwok commented Oct 20, 2020

Uh oh!

merwok commented Oct 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

taleinat left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bedevere-bot commented Jan 21, 2021

Uh oh!

merwok Jan 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

merwok Jan 21, 2021

Choose a reason for hiding this comment

Uh oh!

terryjreedy Jan 22, 2021

Choose a reason for hiding this comment

Uh oh!

miss-islington commented Jan 22, 2021

Uh oh!

bedevere-bot commented Jan 22, 2021

Uh oh!

bedevere-bot commented Jan 22, 2021

Uh oh!

terryjreedy commented Jan 22, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

bpo-40304: Correct type(name, bases, dict) doc#19553
terryjreedy merged 9 commits into
python:masterfrom
verhovsky:patch-7

verhovsky commented Apr 16, 2020 •
edited by bedevere-bot
Loading

merwok commented Sep 30, 2020 •
edited
Loading

taleinat left a comment •
edited
Loading

merwok commented Oct 20, 2020 •
edited
Loading

merwok Jan 21, 2021 •
edited
Loading