]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-22005: Document the reality of pickle compatibility. (GH-11054)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sun, 9 Dec 2018 19:48:35 +0000 (11:48 -0800)
committerGitHub <noreply@github.com>
Sun, 9 Dec 2018 19:48:35 +0000 (11:48 -0800)
(cherry picked from commit e328753d91379274b699b93decff45de07854617)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
Doc/library/pickle.rst

index 52cbb6241bc9b96f413d9b93e785ec8dc61bef83..36f66a159bf2689bbb4413e685454306e38c3888 100644 (file)
@@ -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``
 ^^^^^^^^^^^^^^^^^^^^^^^^