bpo-39426: Fix outdated default and highest protocols in docs #18154

mdickinson · 2020-01-23T20:19:05Z

Some portions of the pickle documentation hadn't been updated for the pickle protocol changes in Python 3.8 (new protocol 5, default protocol 4). This PR fixes those docs.

https://bugs.python.org/issue39426

Automerge-Triggered-By: @pitrou


        Fix outdated default and highest protocols in docs

Lib/pickle.py

mdickinson · 2020-01-23T20:28:59Z

Whoops; I did a search and replace without noticing that I was editing the clinic files. Will fix.


        Fix and regenerate argument clinic code


        Minor grammatical fix: replace 'it' with 'and'

pitrou · 2020-01-24T10:03:24Z

Thank you Mark!

miss-islington · 2020-01-24T10:03:26Z

Thanks @mdickinson for the PR 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖


        bpo-39426: Fix outdated default and highest protocols in docs (python…

…GH-18154) Some portions of the pickle documentation hadn't been updated for the pickle protocol changes in Python 3.8 (new protocol 5, default protocol 4). This PR fixes those docs. https://bugs.python.org/issue39426 (cherry picked from commit e9652e8) Co-authored-by: Mark Dickinson <mdickinson@enthought.com>

bedevere-bot · 2020-01-24T10:03:47Z

GH-18162 is a backport of this pull request to the 3.8 branch.


        bpo-39426: Fix outdated default and highest protocols in docs (GH-18154)

Some portions of the pickle documentation hadn't been updated for the pickle protocol changes in Python 3.8 (new protocol 5, default protocol 4). This PR fixes those docs. https://bugs.python.org/issue39426 (cherry picked from commit e9652e8) Co-authored-by: Mark Dickinson <mdickinson@enthought.com>

bedevere-bot · 2020-01-24T10:52:58Z

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot PPC64LE Fedora 3.x has failed when building commit e9652e8.

What do you need to do:

Don't panic.
Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
Go to the page of the buildbot that failed (https://buildbot.python.org/all/#builders/11/builds/227) and take a look at the build logs.
Check if the failure is related to this commit (e9652e8) or if it is a false positive.
If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/all/#builders/11/builds/227

Failed tests:

test_asyncio

Summary of the results of the build (if available):

==

Click to see traceback logs

remote: Enumerating objects: 15, done.�[K
remote: Counting objects:   6% (1/15)�[K
remote: Counting objects:  13% (2/15)�[K
remote: Counting objects:  20% (3/15)�[K
remote: Counting objects:  26% (4/15)�[K
remote: Counting objects:  33% (5/15)�[K
remote: Counting objects:  40% (6/15)�[K
remote: Counting objects:  46% (7/15)�[K
remote: Counting objects:  53% (8/15)�[K
remote: Counting objects:  60% (9/15)�[K
remote: Counting objects:  66% (10/15)�[K
remote: Counting objects:  73% (11/15)�[K
remote: Counting objects:  80% (12/15)�[K
remote: Counting objects:  86% (13/15)�[K
remote: Counting objects:  93% (14/15)�[K
remote: Counting objects: 100% (15/15)�[K
remote: Counting objects: 100% (15/15), done.�[K
remote: Compressing objects:  12% (1/8)�[K
remote: Compressing objects:  25% (2/8)�[K
remote: Compressing objects:  37% (3/8)�[K
remote: Compressing objects:  50% (4/8)�[K
remote: Compressing objects:  62% (5/8)�[K
remote: Compressing objects:  75% (6/8)�[K
remote: Compressing objects:  87% (7/8)�[K
remote: Compressing objects: 100% (8/8)�[K
remote: Compressing objects: 100% (8/8), done.�[K
remote: Total 8 (delta 7), reused 0 (delta 0), pack-reused 0�[K
From https://github.com/python/cpython
 * branch            master     -> FETCH_HEAD
Reset branch 'master'

test_winsound skipped -- No module named 'winsound'
test_ioctl skipped -- Unable to open /dev/tty
test_zipfile64 skipped -- test requires loads of disk-space bytes and a long time to run
stty: standard input: Inappropriate ioctl for device
/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/multiprocessing/resource_tracker.py:216: UserWarning: resource_tracker: There appear to be 1 leaked shared_memory objects to clean up at shutdown
  warnings.warn('resource_tracker: There appear to be %d '
/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/multiprocessing/resource_tracker.py:229: UserWarning: resource_tracker: '/psm_3cbacd2a': [Errno 2] No such file or directory: '/psm_3cbacd2a'
  warnings.warn('resource_tracker: %r: %s' % (name, e))
test_flock (__main__.FNTLEINTRTest) ... ok
test_lockf (__main__.FNTLEINTRTest) ... ok
test_read (__main__.OSEINTRTest) ... ok
test_wait (__main__.OSEINTRTest) ... ok
test_wait3 (__main__.OSEINTRTest) ... ok
test_wait4 (__main__.OSEINTRTest) ... ok
test_waitpid (__main__.OSEINTRTest) ... ok
test_write (__main__.OSEINTRTest) ... ok
test_devpoll (__main__.SelectEINTRTest) ... skipped 'need select.devpoll'
test_epoll (__main__.SelectEINTRTest) ... ok
test_kqueue (__main__.SelectEINTRTest) ... skipped 'need select.kqueue'
test_poll (__main__.SelectEINTRTest) ... ok
test_select (__main__.SelectEINTRTest) ... ok
test_sigtimedwait (__main__.SignalEINTRTest) ... ok
test_sigwaitinfo (__main__.SignalEINTRTest) ... ok
test_accept (__main__.SocketEINTRTest) ... ok
test_open (__main__.SocketEINTRTest) ... ok
test_os_open (__main__.SocketEINTRTest) ... ok
test_recv (__main__.SocketEINTRTest) ... ok
test_recvmsg (__main__.SocketEINTRTest) ... ok
test_send (__main__.SocketEINTRTest) ... ok
test_sendall (__main__.SocketEINTRTest) ... ok
test_sendmsg (__main__.SocketEINTRTest) ... ok
test_sleep (__main__.TimeEINTRTest) ... ok

----------------------------------------------------------------------
Ran 24 tests in 7.265s

OK (skipped=2)
test_winreg skipped -- No module named 'winreg'
test_tk skipped -- Tk unavailable due to TclError: no display name and no $DISPLAY environment variab [...]
test_winconsoleio skipped -- test only relevant on win32
test_ttk_guionly skipped -- Tk unavailable due to TclError: no display name and no $DISPLAY environment variab [...]
Timeout (0:15:00)!
Thread 0x00003fff7d555330 (most recent call first):
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/selectors.py", line 468 in select
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/asyncio/base_events.py", line 1852 in _run_once
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/asyncio/base_events.py", line 596 in run_forever
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/asyncio/base_events.py", line 629 in run_until_complete
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/test_asyncio/test_subprocess.py", line 441 in test_cancel_make_subprocess_transport_exec
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/case.py", line 616 in _callTestMethod
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/case.py", line 659 in run
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/case.py", line 719 in __call__
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 122 in run
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 84 in __call__
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 122 in run
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 84 in __call__
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 122 in run
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 84 in __call__
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 122 in run
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 84 in __call__
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 122 in run
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 84 in __call__
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/runner.py", line 176 in run
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/support/__init__.py", line 2079 in _run_suite
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/support/__init__.py", line 2201 in run_unittest
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/libregrtest/runtest.py", line 209 in _test_module
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/libregrtest/runtest.py", line 234 in _runtest_inner2
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/libregrtest/runtest.py", line 270 in _runtest_inner
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/libregrtest/runtest.py", line 140 in _runtest
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/libregrtest/runtest.py", line 193 in runtest
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/libregrtest/runtest_mp.py", line 80 in run_tests_worker
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/libregrtest/main.py", line 654 in _main
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/libregrtest/main.py", line 634 in main
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/libregrtest/main.py", line 712 in main
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/regrtest.py", line 43 in _main
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/regrtest.py", line 47 in <module>
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/runpy.py", line 86 in _run_code
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/runpy.py", line 193 in _run_module_as_main
test_msilib skipped -- No module named '_msi'
test_kqueue skipped -- test works only on BSD
/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/multiprocessing/resource_tracker.py:216: UserWarning: resource_tracker: There appear to be 1 leaked shared_memory objects to clean up at shutdown
  warnings.warn('resource_tracker: There appear to be %d '
/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/multiprocessing/resource_tracker.py:229: UserWarning: resource_tracker: '/psm_3b695a3d': [Errno 2] No such file or directory: '/psm_3b695a3d'
  warnings.warn('resource_tracker: %r: %s' % (name, e))
/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/multiprocessing/resource_tracker.py:216: UserWarning: resource_tracker: There appear to be 1 leaked shared_memory objects to clean up at shutdown
  warnings.warn('resource_tracker: There appear to be %d '
/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/multiprocessing/resource_tracker.py:229: UserWarning: resource_tracker: '/psm_176e599d': [Errno 2] No such file or directory: '/psm_176e599d'
  warnings.warn('resource_tracker: %r: %s' % (name, e))
test_tix skipped -- Tk unavailable due to TclError: no display name and no $DISPLAY environment variab [...]
test_startfile skipped -- object <module 'os' from '/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/os.py'> has no attribute 'startfile'
test_devpoll skipped -- test works only on Solaris OS family
test_ossaudiodev skipped -- [Errno 2] No such file or directory: '/dev/dsp'
Timeout (0:15:00)!
Thread 0x00003fff9fdd5330 (most recent call first):
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/selectors.py", line 468 in select
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/asyncio/base_events.py", line 1852 in _run_once
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/asyncio/base_events.py", line 596 in run_forever
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/asyncio/base_events.py", line 629 in run_until_complete
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/test_asyncio/test_subprocess.py", line 441 in test_cancel_make_subprocess_transport_exec
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/case.py", line 616 in _callTestMethod
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/case.py", line 659 in run
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/case.py", line 719 in __call__
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 122 in run
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 84 in __call__
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 122 in run
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 84 in __call__
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 122 in run
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 84 in __call__
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 122 in run
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 84 in __call__
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 122 in run
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/suite.py", line 84 in __call__
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/unittest/runner.py", line 176 in run
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/support/__init__.py", line 2079 in _run_suite
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/support/__init__.py", line 2201 in run_unittest
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/libregrtest/runtest.py", line 209 in _test_module
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/libregrtest/runtest.py", line 234 in _runtest_inner2
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/libregrtest/runtest.py", line 270 in _runtest_inner
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/libregrtest/runtest.py", line 153 in _runtest
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/libregrtest/runtest.py", line 193 in runtest
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/libregrtest/main.py", line 318 in rerun_failed_tests
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/libregrtest/main.py", line 691 in _main
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/libregrtest/main.py", line 634 in main
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/libregrtest/main.py", line 712 in main
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/test/__main__.py", line 2 in <module>
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/runpy.py", line 86 in _run_code
  File "/home/shager/cpython-buildarea/3.x.edelsohn-fedora-ppc64le/build/Lib/runpy.py", line 193 in _run_module_as_main
make: *** [buildbottest] Error 1

Fix outdated default and highest protocols in docs

Loading status checks…

7781efb

mdickinson added skip news needs backport to 3.8 labels Jan 23, 2020

the-knights-who-say-ni added the CLA signed label Jan 23, 2020

bedevere-bot added the awaiting core review label Jan 23, 2020

mdickinson reviewed Jan 23, 2020

View changes

Lib/pickle.py Outdated Show resolved Hide resolved

mdickinson added 2 commits Jan 23, 2020

Fix and regenerate argument clinic code

Loading status checks…

fb288ea

Minor grammatical fix: replace 'it' with 'and'

Loading status checks…

491e71b

ammaraskar approved these changes Jan 23, 2020

View changes

mdickinson requested a review from pitrou Jan 23, 2020

pitrou approved these changes Jan 24, 2020

View changes

bedevere-bot added awaiting merge and removed awaiting core review labels Jan 24, 2020

pitrou added the 🤖 automerge label Jan 24, 2020

bedevere-bot removed the awaiting merge label Jan 24, 2020

bedevere-bot removed the needs backport to 3.8 label Jan 24, 2020

python / cpython

bpo-39426: Fix outdated default and highest protocols in docs #18154

bpo-39426: Fix outdated default and highest protocols in docs #18154

mdickinson commented Jan 23, 2020 •

edited by miss-islington

This comment has been minimized.

mdickinson commented Jan 23, 2020

This comment has been minimized.

pitrou commented Jan 24, 2020

This comment has been minimized.

miss-islington commented Jan 24, 2020

This comment has been minimized.

bedevere-bot commented Jan 24, 2020

This comment has been minimized.

bedevere-bot commented Jan 24, 2020

python / cpython

Sponsor python/cpython

Join GitHub today

bpo-39426: Fix outdated default and highest protocols in docs #18154

bpo-39426: Fix outdated default and highest protocols in docs #18154

Conversation

mdickinson commented Jan 23, 2020 • edited by miss-islington

This comment has been minimized.

mdickinson commented Jan 23, 2020

This comment has been minimized.

pitrou commented Jan 24, 2020

This comment has been minimized.

miss-islington commented Jan 24, 2020

This comment has been minimized.

bedevere-bot commented Jan 24, 2020

This comment has been minimized.

bedevere-bot commented Jan 24, 2020

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

mdickinson commented Jan 23, 2020 •

edited by miss-islington