Skip to content

Commit f20ad5e

Browse files
miss-islingtonjeff5
authored andcommitted
gh-96397: Document that attributes need not be identifiers (GH-96454)
Co-authored-by: C.A.M. Gerlach <[email protected]> (cherry picked from commit 9a11ed8) Co-authored-by: Jeff Allen <[email protected]>
1 parent 815ad02 commit f20ad5e

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

Doc/glossary.rst

+9-2
Original file line numberDiff line numberDiff line change
@@ -136,10 +136,17 @@ Glossary
136136
:exc:`StopAsyncIteration` exception. Introduced by :pep:`492`.
137137

138138
attribute
139-
A value associated with an object which is referenced by name using
140-
dotted expressions. For example, if an object *o* has an attribute
139+
A value associated with an object which is usually referenced by name
140+
using dotted expressions.
141+
For example, if an object *o* has an attribute
141142
*a* it would be referenced as *o.a*.
142143

144+
It is possible to give an object an attribute whose name is not an
145+
identifier as defined by :ref:`identifiers`, for example using
146+
:func:`setattr`, if the object allows it.
147+
Such an attribute will not be accessible using a dotted expression,
148+
and would instead need to be retrieved with :func:`getattr`.
149+
143150
awaitable
144151
An object that can be used in an :keyword:`await` expression. Can be
145152
a :term:`coroutine` or an object with an :meth:`__await__` method.

Doc/library/functions.rst

+8
Original file line numberDiff line numberDiff line change
@@ -403,6 +403,7 @@ are always available. They are listed here in alphabetical order.
403403
string. The string must be the name of one of the object's attributes. The
404404
function deletes the named attribute, provided the object allows it. For
405405
example, ``delattr(x, 'foobar')`` is equivalent to ``del x.foobar``.
406+
*name* need not be a Python identifier (see :func:`setattr`).
406407

407408

408409
.. _func-dict:
@@ -746,6 +747,7 @@ are always available. They are listed here in alphabetical order.
746747
value of that attribute. For example, ``getattr(x, 'foobar')`` is equivalent to
747748
``x.foobar``. If the named attribute does not exist, *default* is returned if
748749
provided, otherwise :exc:`AttributeError` is raised.
750+
*name* need not be a Python identifier (see :func:`setattr`).
749751

750752
.. note::
751753

@@ -1598,6 +1600,12 @@ are always available. They are listed here in alphabetical order.
15981600
object allows it. For example, ``setattr(x, 'foobar', 123)`` is equivalent to
15991601
``x.foobar = 123``.
16001602

1603+
*name* need not be a Python identifier as defined in :ref:`identifiers`
1604+
unless the object chooses to enforce that, for example in a custom
1605+
:meth:`~object.__getattribute__` or via :attr:`~object.__slots__`.
1606+
An attribute whose name is not an identifier will not be accessible using
1607+
the dot notation, but is accessible through :func:`getattr` etc..
1608+
16011609
.. note::
16021610

16031611
Since :ref:`private name mangling <private-name-mangling>` happens at

0 commit comments

Comments
 (0)