Pickle protocol v 5 needs to be documented

[dimaqq]

BPO	38388
Nosy	@pitrou, @taleinat, @dimaqq, @miss-islington, @nanjekyejoannah
PRs	bpo-38388 Document pickle protocol version 5 #16639 [3.8] bpo-38388: Document pickle protocol version 5 (GH-16639) #17035

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2019-11-03.11:57:20.584>
created_at = <Date 2019-10-06.23:51:13.896>
labels = ['3.8', '3.9', 'docs']
title = 'Pickle protocol v 5 needs to be documented'
updated_at = <Date 2019-11-03.12:03:22.363>
user = 'https://github.com/dimaqq'

bugs.python.org fields:

activity = <Date 2019-11-03.12:03:22.363>
actor = 'miss-islington'
assignee = 'docs@python'
closed = True
closed_date = <Date 2019-11-03.11:57:20.584>
closer = 'taleinat'
components = ['Documentation']
creation = <Date 2019-10-06.23:51:13.896>
creator = 'Dima.Tisnek'
dependencies = []
files = []
hgrepos = []
issue_num = 38388
keywords = ['patch']
message_count = 4.0
messages = ['354054', '355894', '355895', '355896']
nosy_count = 6.0
nosy_names = ['pitrou', 'taleinat', 'docs@python', 'Dima.Tisnek', 'miss-islington', 'nanjekyejoannah']
pr_nums = ['16639', '17035']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue38388'
versions = ['Python 3.8', 'Python 3.9']

[dimaqq]

Python 3.8 brings new pickle protocol, version 5.
It's not documented.

(venv) … ~/m/proj> python
Python 3.7.4 (v3.7.4:e09359112e, Jul  8 2019, 14:54:52)
[Clang 6.0 (clang-600.0.57)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import pickle
>>> pickle.HIGHEST_PROTOCOL
4
>>> ^D
(venv) … ~/m/proj> python3.8
Python 3.8.0rc1 (v3.8.0rc1:34214de6ab, Oct  1 2019, 12:56:49)
[Clang 6.0 (clang-600.0.57)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import pickle
>>> pickle.HIGHEST_PROTOCOL
5
>>> ^D

Yet there's no mention of "protocol version 5" at:

https://github.com/python/cpython/blob/master/Doc/library/pickle.rst
https://docs.python.org/3.9/library/pickle.html#data-stream-format
https://docs.python.org/3.8/library/pickle.html#data-stream-format

[taleinat]

New changeset d0e0f5b by Tal Einat (Dima Tisnek) in branch 'master':
bpo-38388: Document pickle protocol version 5 (GH-16639)
d0e0f5b

[taleinat]

Thanks for the report and the PR, Dima!

[miss-islington]

New changeset 87af518 by Miss Skeleton (bot) in branch '3.8':
bpo-38388: Document pickle protocol version 5 (GH-16639)
87af518