bpo-35105: Document that CPython accepts "invalid" identifiers by Windsooon · Pull Request #11263 · python/cpython · GitHub

https://bugs.python.org/issue35105

That you for proposing something specific to chew on. I think spelling, grammar, and content all need tweaking.

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.

Do we really need to mention this?

That discussion is on the issue.

I don't think we can mark this as an implementation detail for setattr(). The details are downstream and determined by the target object, not by setattr itself.

Suggested wording:

Note, setattr() attempts to update the object with the given attr/value pair.
Whether this succeeds and what its affect is is determined by the target object.
If an object's class defines `__slots__`, the attribute may not be writeable.
If an object's class defines property with a setter method, the *setattr()*
will trigger the setter method which may or may not actually write the attribute.
For objects that have a regular dictionary (which is the typical case), the
*setattr()* call can make any string keyed update allowed by the dictionary
including keys that aren't valid identifiers -- for example setattr(a, '1', 'one')
will be the equivalent of vars()['1'] ='one'.

This issue has little to do with setattr() and is more related to the fact that instance dictionaries can hold any valid key. In a way, it is no different than a user writing a.__dict__['1'] = 'one'. That has always been allowed and the __dict__ attribute is documented as writeable, so a user is also allowed to write `a.dict = {'1': 'one'}.

In short, we can talk about this in the setattr() docs but it isn't really a setattr() issue. Also, the behavior is effectively guaranteed by the other things users are allowed to do, so there is no merit in marking this as an implementation detail. Non-identifier keys can make it into an instance dictionary via multiple paths that are guaranteed to work.

I agree with Raymond's revision. Note that it would replace the entire proposed addition, including the impl-detail directive. By adding more 'meat', it makes an addition more worthwhile.

The whole note needs to be indented for proper alignment.

Hi @Windsooon thanks for this PR! Would you have some time to integrate Cheryl comments?

I just updated it. Thank you @csabella

LGTM with nits (all can be accepted right from github).

Suggested change

      
               setattr() attempts to update the object with the given attr/value pair.
          
               ``setattr()`` attempts to update the object with the given attr/value pair.

Suggested change

      
               If an object's class defines `__slots__`, the attribute may not be writeable.
          
               If an object's class defines ``__slots__``, the attribute may not be writeable.

Suggested change

      
               will be the equivalent of ``vars()['1'] ='one'``.
          
               will be the equivalent of ``vars()['1'] = 'one'``.

@Windsooon, please address the review comments from Julien. Thanks!

Changes were requested on this PR by a core dev over two years ago, but have not been applied. There is also now a merge conflict. I am therefore closing this PR.

@Windsooon, if you're still interested in working on this, feel free to open a new PR. Alternatively, ping me, and I'll happily reopen the PR. Thanks! 🙂

@AlexWaygood I'm so sorry for missing the notification from CPython, I will catch up in a few weeks.

@Windsooon no worries!

(in addition to the above)

Suggested change

      
               setattr() attempts to update the object with the given attr/value pair.
          
               setattr() attempts to update the object with the given attribute/value pair.

or

Suggested change

      
               setattr() attempts to update the object with the given attr/value pair.
          
               setattr() attempts to update the object with the given attribute-value pair.

Suggested change

      
               Whether this succeeds and the effect it has determined by the target object.
          
               Whether this succeeds and the effect it has is determined by the target object.

*setattr()* -> `setattr()` here and below (I think * is commonly used for parameters)

Would you happen to have an example of this behavior? I'm not quite following what it's doing (how a turns into vars())

Suggested change

      
               *setattr()* call can make any string keyed update allowed by the dictionary
          
               *setattr()* call can make any string-keyed update allowed by the dictionary

I think this PR has now been superseded by #96454

the-knights-who-say-ni added the CLA signed label Dec 20, 2018

bedevere-bot added docs Documentation in the Doc dir awaiting review labels Dec 20, 2018

Windsooon force-pushed the bpo-35105 branch from b03e752 to a0e8550 Compare December 20, 2018 13:59

terryjreedy requested a review from vstinner December 20, 2018 21:30

terryjreedy requested changes Dec 20, 2018

View reviewed changes

Comment thread Doc/library/functions.rst Outdated

bedevere-bot added awaiting changes and removed awaiting review labels Dec 20, 2018

zhangyangyu requested a review from rhettinger December 21, 2018 03:37

rhettinger requested changes Dec 24, 2018

View reviewed changes

bpo-35105: Document that CPython accepts invalid identifiers

f47c3de

Windsooon force-pushed the bpo-35105 branch from a0e8550 to f47c3de Compare January 26, 2019 02:57

csabella requested changes May 29, 2019

View reviewed changes

csabella reviewed May 29, 2019

View reviewed changes

Comment thread Doc/library/functions.rst Outdated

csabella reviewed May 29, 2019

View reviewed changes

Comment thread Doc/library/functions.rst Outdated

csabella reviewed May 29, 2019

View reviewed changes

Comment thread Doc/library/functions.rst Outdated

csabella reviewed May 29, 2019

View reviewed changes

Comment thread Doc/library/functions.rst Outdated

JulienPalard added the skip news label Sep 11, 2019

fix docs format depend on review

7185897

JulienPalard requested changes Sep 12, 2019

View reviewed changes

AlexWaygood closed this Apr 17, 2022

AlexWaygood reopened this Apr 21, 2022

ezio-melotti removed the CLA signed label Jul 13, 2022

slateny reviewed Oct 11, 2022

View reviewed changes

AlexWaygood closed this Oct 11, 2022

vstinner mentioned this pull request Oct 11, 2022

Document that CPython accepts "invalid" identifiers #79286

Closed


		.. note::

		setattr() attempts to update the object with the given attr/value pair.

	setattr() attempts to update the object with the given attr/value pair.
	``setattr()`` attempts to update the object with the given attr/value pair.

	If an object's class defines `__slots__`, the attribute may not be writeable.
	If an object's class defines ``__slots__``, the attribute may not be writeable.

	will be the equivalent of ``vars()['1'] ='one'``.
	will be the equivalent of ``vars()['1'] = 'one'``.

	Whether this succeeds and the effect it has determined by the target object.
	Whether this succeeds and the effect it has is determined by the target object.

	setattr() call can make any string keyed update allowed by the dictionary
	setattr() call can make any string-keyed update allowed by the dictionary

bpo-35105: Document that CPython accepts "invalid" identifiers by Windsooon · Pull Request #11263 · python/cpython · GitHub

Uh oh!

Uh oh!

bpo-35105: Document that CPython accepts "invalid" identifiers - #11263

bpo-35105: Document that CPython accepts "invalid" identifiers#11263Windsooon wants to merge 2 commits intopython:mainpython/cpython:mainfrom Windsooon:bpo-35105Windsooon/cpython:bpo-35105Copy head branch name to clipboard

Conversation

Windsooon commented Dec 20, 2018 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

terryjreedy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bedevere-bot commented Dec 20, 2018

Uh oh!

zhangyangyu commented Dec 21, 2018

Uh oh!

terryjreedy commented Dec 21, 2018

Uh oh!

rhettinger left a comment

Choose a reason for hiding this comment

Uh oh!

terryjreedy commented Dec 24, 2018

Uh oh!

csabella left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JulienPalard commented Sep 11, 2019

Uh oh!

Windsooon commented Sep 11, 2019

Uh oh!

JulienPalard left a comment

Choose a reason for hiding this comment

Uh oh!

JulienPalard Sep 12, 2019 • 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!

JulienPalard Sep 12, 2019

Choose a reason for hiding this comment

Uh oh!

JulienPalard Sep 12, 2019

Choose a reason for hiding this comment

Uh oh!

csabella commented Jan 12, 2020

Uh oh!

AlexWaygood commented Apr 17, 2022

Uh oh!

Windsooon commented Apr 21, 2022

Uh oh!

AlexWaygood commented Apr 21, 2022

Uh oh!

slateny Oct 10, 2022

Choose a reason for hiding this comment

Uh oh!

slateny Oct 10, 2022

Choose a reason for hiding this comment

Uh oh!

slateny Oct 11, 2022

Choose a reason for hiding this comment

Uh oh!

slateny Oct 11, 2022

Choose a reason for hiding this comment

Uh oh!

slateny Oct 11, 2022

Choose a reason for hiding this comment

Uh oh!

AlexWaygood commented Oct 11, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

bpo-35105: Document that CPython accepts "invalid" identifiers#11263
Windsooon wants to merge 2 commits into
python:mainfrom
Windsooon:bpo-35105

Windsooon commented Dec 20, 2018 •
edited by bedevere-bot
Loading

JulienPalard Sep 12, 2019 •
edited
Loading