summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJeff Allen <ja.py@farowl.co.uk>2022-09-29 23:02:27 (GMT)
committerGitHub <noreply@github.com>2022-09-29 23:02:27 (GMT)
commit9a11ed8e50492d327e4de0a8f3a473e788b14a6f (patch)
tree39eaf63740668b43c27b487b2ca956056dc606ad
parent0179a82caa05a322d1dbab05155be6f919c281ff (diff)
downloadcpython-9a11ed8e50492d327e4de0a8f3a473e788b14a6f.zip
cpython-9a11ed8e50492d327e4de0a8f3a473e788b14a6f.tar.gz
cpython-9a11ed8e50492d327e4de0a8f3a473e788b14a6f.tar.bz2
gh-96397: Document that attributes need not be identifiers (#96454)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
-rw-r--r--Doc/glossary.rst11
-rw-r--r--Doc/library/functions.rst8
2 files changed, 17 insertions, 2 deletions
diff --git a/Doc/glossary.rst b/Doc/glossary.rst
index e0dd4fc..9385b8d 100644
--- a/Doc/glossary.rst
+++ b/Doc/glossary.rst
@@ -136,10 +136,17 @@ Glossary
:exc:`StopAsyncIteration` exception. Introduced by :pep:`492`.
attribute
- A value associated with an object which is referenced by name using
- dotted expressions. For example, if an object *o* has an attribute
+ A value associated with an object which is usually referenced by name
+ using dotted expressions.
+ For example, if an object *o* has an attribute
*a* it would be referenced as *o.a*.
+ It is possible to give an object an attribute whose name is not an
+ identifier as defined by :ref:`identifiers`, for example using
+ :func:`setattr`, if the object allows it.
+ Such an attribute will not be accessible using a dotted expression,
+ and would instead need to be retrieved with :func:`getattr`.
+
awaitable
An object that can be used in an :keyword:`await` expression. Can be
a :term:`coroutine` or an object with an :meth:`__await__` method.
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index ccb691d..26ee302 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -397,6 +397,7 @@ are always available. They are listed here in alphabetical order.
string. The string must be the name of one of the object's attributes. The
function deletes the named attribute, provided the object allows it. For
example, ``delattr(x, 'foobar')`` is equivalent to ``del x.foobar``.
+ *name* need not be a Python identifier (see :func:`setattr`).
.. _func-dict:
@@ -738,6 +739,7 @@ are always available. They are listed here in alphabetical order.
value of that attribute. For example, ``getattr(x, 'foobar')`` is equivalent to
``x.foobar``. If the named attribute does not exist, *default* is returned if
provided, otherwise :exc:`AttributeError` is raised.
+ *name* need not be a Python identifier (see :func:`setattr`).
.. note::
@@ -1582,6 +1584,12 @@ are always available. They are listed here in alphabetical order.
object allows it. For example, ``setattr(x, 'foobar', 123)`` is equivalent to
``x.foobar = 123``.
+ *name* need not be a Python identifier as defined in :ref:`identifiers`
+ unless the object chooses to enforce that, for example in a custom
+ :meth:`~object.__getattribute__` or via :attr:`~object.__slots__`.
+ An attribute whose name is not an identifier will not be accessible using
+ the dot notation, but is accessible through :func:`getattr` etc..
+
.. note::
Since :ref:`private name mangling <private-name-mangling>` happens at