]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] gh-122511: Improve documentation for object identity of mutable/immutable...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 7 Aug 2024 13:56:40 +0000 (15:56 +0200)
committerGitHub <noreply@github.com>
Wed, 7 Aug 2024 13:56:40 +0000 (14:56 +0100)
gh-122511: Improve documentation for object identity of mutable/immutable types (GH-122512)
(cherry picked from commit 76bdeebef6c6206f3e0af1e42cbfc75c51fbb8ca)

Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Doc/reference/datamodel.rst

index 25ca94fd5a8d47e2cea186586e8b0dcc1e8e50ba..5044c330d6ba2c450a263be4fa40d72843b15664 100644 (file)
@@ -106,12 +106,16 @@ that mutable object is changed.
 Types affect almost all aspects of object behavior.  Even the importance of
 object identity is affected in some sense: for immutable types, operations that
 compute new values may actually return a reference to any existing object with
-the same type and value, while for mutable objects this is not allowed.  E.g.,
-after ``a = 1; b = 1``, ``a`` and ``b`` may or may not refer to the same object
-with the value one, depending on the implementation, but after ``c = []; d =
-[]``, ``c`` and ``d`` are guaranteed to refer to two different, unique, newly
-created empty lists. (Note that ``c = d = []`` assigns the same object to both
-``c`` and ``d``.)
+the same type and value, while for mutable objects this is not allowed.
+For example, after ``a = 1; b = 1``, *a* and *b* may or may not refer to
+the same object with the value one, depending on the implementation.
+This is because :class:`int` is an immutable type, so the reference to ``1``
+can be reused. This behaviour depends on the implementation used, so should
+not be relied upon, but is something to be aware of when making use of object
+identity tests.
+However, after ``c = []; d = []``, *c* and *d* are guaranteed to refer to two
+different, unique, newly created empty lists. (Note that ``e = f = []`` assigns
+the *same* object to both *e* and *f*.)
 
 
 .. _types: