Skip to content

ENH: Adding 'protocol' parameter to 'to_pickle'. #16252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 11 commits into from
Closed

ENH: Adding 'protocol' parameter to 'to_pickle'. #16252

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
66a35e8
Added 'protocol' parameter to 'to_pickle'.
jbschiratti May 4, 2017
04bc5c2
Added 'versionadded' tag, improved docstring + fixed import.
jbschiratti May 11, 2017
4bf0386
Added docstring for negative protocol parameter.
jbschiratti May 12, 2017
35f8d18
Added tests for new 'protocol' parameter in 'to_pickle'.
jbschiratti May 12, 2017
9c9d38f
Added enhancement to 'whatsnew' file.
jbschiratti May 12, 2017
352220b
Fix : Fixed error message in 'test_read_bad_versions'.
jbschiratti May 12, 2017
460ca0c
Shortened paragraph addded in 'whatsnew'.
jbschiratti May 17, 2017
7631146
Fix : added issue number.
jbschiratti May 17, 2017
14bc485
Fix : removed unused import.
jbschiratti May 17, 2017
20a854d
Added ref for protocol parameter + edited whatsnew.
jbschiratti May 18, 2017
8eb660d
Minor change on whatsnew.
jbschiratti May 18, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
from pandas.compat.numpy import function as nv
from pandas.compat import (map, zip, lzip, lrange, string_types,
isidentifier, set_function_name)
from pandas.compat import cPickle as pkl
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

move to the previous line

import pandas.core.nanops as nanops
from pandas.util.decorators import Appender, Substitution, deprecate_kwarg
from pandas.util.validators import validate_bool_kwarg
Expand Down Expand Up @@ -1344,7 +1345,8 @@ def to_sql(self, name, con, flavor=None, schema=None, if_exists='fail',
if_exists=if_exists, index=index, index_label=index_label,
chunksize=chunksize, dtype=dtype)

def to_pickle(self, path, compression='infer'):
def to_pickle(self, path, compression='infer',
protocol=pkl.HIGHEST_PROTOCOL):
"""
Pickle (serialize) object to input file path.

Expand All @@ -1354,11 +1356,15 @@ def to_pickle(self, path, compression='infer'):
File path
compression : {'infer', 'gzip', 'bz2', 'xz', None}, default 'infer'
a string representing the compression to use in the output file
protocol : int
Int which indicates which protocol should be used by the pickler,
default HIGHEST_PROTOCOL (Pickle module).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

version added tag (the compression one goes above this), your tag should read 0.21.0


.. versionadded:: 0.20.0
"""
from pandas.io.pickle import to_pickle
return to_pickle(self, path, compression=compression)
return to_pickle(self, path, compression=compression,
protocol=protocol)

def to_clipboard(self, excel=None, sep=None, **kwargs):
"""
Expand Down
7 changes: 5 additions & 2 deletions pandas/io/pickle.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from pandas.io.common import _get_handle, _infer_compression


def to_pickle(obj, path, compression='infer'):
def to_pickle(obj, path, compression='infer', protocol=pkl.HIGHEST_PROTOCOL):
"""
Pickle (serialize) object to input file path

Expand All @@ -18,6 +18,9 @@ def to_pickle(obj, path, compression='infer'):
File path
compression : {'infer', 'gzip', 'bz2', 'xz', None}, default 'infer'
a string representing the compression to use in the output file
protocol : int
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

Int which indicates which protocol should be used by the pickler,
default HIGHEST_PROTOCOL (Pickle module).

.. versionadded:: 0.20.0
"""
Expand All @@ -26,7 +29,7 @@ def to_pickle(obj, path, compression='infer'):
compression=inferred_compression,
is_text=False)
try:
pkl.dump(obj, f, protocol=pkl.HIGHEST_PROTOCOL)
pkl.dump(obj, f, protocol=protocol)
finally:
for _f in fh:
_f.close()
Expand Down