This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: pickle dump argument description vague
Type: Stage:
Components: Documentation Versions: Python 2.3
process
Status: closed Resolution: out of date
Dependencies: Superseder:
Assigned To: fdrake Nosy List: bkc, fdrake, georg.brandl, irmen, zseil
Priority: normal Keywords:

Created on 2004-02-05 19:08 by bkc, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (4)
msg19919 - (view) Author: Brad Clements (bkc) Date: 2004-02-05 19:08
The documentation for pickle.dump()

see http://www.python.org/doc/current/lib/node64.html

dump(  	object, file[, protocol[, bin]])

implies that up to four arguments can be specified.
That bin can be specified if protocol has been
specified. The implementation actually accepts only 3
arguments, the last one being either 'protocol' or a
'bin' flag.

The text notation for this function needs to be
clarified, and the visual presentation of the argument
functions changed.

Perhaps to:

dump(  	object, file[, protocol | bin])

or

dump(  	object, file[, protocol] | [, bin])

or

dump(  	object, file[, protocol_or_bin])


msg19920 - (view) Author: Irmen de Jong (irmen) (Python triager) Date: 2004-11-07 19:13
Logged In: YES 
user_id=129426

There is one other thing.
The cPickle dump/dumps functions don't like the 'bin'
argument at all:
TypeError: 'bin' is an invalid keyword argument for this
function
They only accept the 'protocol' argument.

So that's another thing that should probably be changed in
cPickle (also see bug 888594), or it should probably be
mentioned in the docs, or the 'bin' argument should be
removed totally ;-)
msg19921 - (view) Author: Ziga Seilnacht (zseil) * (Python committer) Date: 2006-03-31 14:05
Logged In: YES 
user_id=1326842

The bin parameter has been consistently removed from the
docs as well as from the pickle module in revision 37966.

Resolution should be changed to fixed.
msg19922 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2006-03-31 14:13
Logged In: YES 
user_id=849994

Python 2.5 docs don't include the "bin" parameter any more.
History
Date User Action Args
2022-04-11 14:56:02adminsetgithub: 39904
2004-02-05 19:08:39bkccreate