summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFurkan Önder <furkantahaonder@gmail.com>2020-04-18 18:09:09 (GMT)
committerGitHub <noreply@github.com>2020-04-18 18:09:09 (GMT)
commit482259d0dcf27714a84cf56b93977320bea7e093 (patch)
treedb3bfa928687a5a73c552ba128e87044a94d7216
parent696136b993e11b37c4f34d729a0375e5ad544ade (diff)
downloadcpython-482259d0dcf27714a84cf56b93977320bea7e093.zip
cpython-482259d0dcf27714a84cf56b93977320bea7e093.tar.gz
cpython-482259d0dcf27714a84cf56b93977320bea7e093.tar.bz2
bpo-27635: Fix pickle documentation about `__new__` not being called. (GH-19269)
Automerge-Triggered-By: @pitrou
-rw-r--r--Doc/library/pickle.rst6
-rw-r--r--Misc/NEWS.d/next/Documentation/2020-04-01-00-27-03.bpo-27635.VwxUty.rst2
2 files changed, 5 insertions, 3 deletions
diff --git a/Doc/library/pickle.rst b/Doc/library/pickle.rst
index 779b60e..a7b92bb 100644
--- a/Doc/library/pickle.rst
+++ b/Doc/library/pickle.rst
@@ -639,9 +639,9 @@ the methods :meth:`__getstate__` and :meth:`__setstate__`.
At unpickling time, some methods like :meth:`__getattr__`,
:meth:`__getattribute__`, or :meth:`__setattr__` may be called upon the
instance. In case those methods rely on some internal invariant being
- true, the type should implement :meth:`__getnewargs__` or
- :meth:`__getnewargs_ex__` to establish such an invariant; otherwise,
- neither :meth:`__new__` nor :meth:`__init__` will be called.
+ true, the type should implement :meth:`__new__` to establish such an
+ invariant, as :meth:`__init__` is not called when unpickling an
+ instance.
.. index:: pair: copy; protocol
diff --git a/Misc/NEWS.d/next/Documentation/2020-04-01-00-27-03.bpo-27635.VwxUty.rst b/Misc/NEWS.d/next/Documentation/2020-04-01-00-27-03.bpo-27635.VwxUty.rst
new file mode 100644
index 0000000..24f640b
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2020-04-01-00-27-03.bpo-27635.VwxUty.rst
@@ -0,0 +1,2 @@
+The pickle documentation incorrectly claimed that ``__new__`` isn't called by
+default when unpickling.