summaryrefslogtreecommitdiff
path: root/Doc/library
diff options
context:
space:
mode:
authorGregory P. Smith <greg@krypto.org>2018-12-09 11:42:58 -0800
committerGitHub <noreply@github.com>2018-12-09 11:42:58 -0800
commite328753d91379274b699b93decff45de07854617 (patch)
tree87ea1246e3c1142d6c16535c3e81020ff8880579 /Doc/library
parent25648d05ac3d74c436f951579bbb716372fb8cc7 (diff)
downloadcpython-git-e328753d91379274b699b93decff45de07854617.tar.gz
bpo-22005: Document the reality of pickle compatibility. (GH-11054)
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/pickle.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/library/pickle.rst b/Doc/library/pickle.rst
index 5fe49a013b..100a6a1345 100644
--- a/Doc/library/pickle.rst
+++ b/Doc/library/pickle.rst
@@ -71,7 +71,9 @@ The :mod:`pickle` module differs from :mod:`marshal` in several significant ways
:file:`.pyc` files, the Python implementers reserve the right to change the
serialization format in non-backwards compatible ways should the need arise.
The :mod:`pickle` serialization format is guaranteed to be backwards compatible
- across Python releases.
+ across Python releases provided a compatible pickle protocol is chosen and
+ pickling and unpickling code deals with Python 2 to Python 3 type differences
+ if your data is crossing that unique breaking change language boundary.
Comparison with ``json``
^^^^^^^^^^^^^^^^^^^^^^^^