Skip to content

DOC: Fixed to_pickle compression argument list 'gzip' > 'gz' #38192

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

Merged
merged 2 commits into from
Dec 2, 2020
Merged

DOC: Fixed to_pickle compression argument list 'gzip' > 'gz' #38192

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6059ef4
DOC: Fixed to_pickle compression argument list 'gzip' > 'gz'
ooojpeg Nov 30, 2020
d036e73
DOC: Reverted changes to gzip on parameter and added further informat…
ooojpeg Nov 30, 2020
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
7 changes: 7 additions & 0 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2799,6 +2799,13 @@ def to_pickle(
default 'infer'
A string representing the compression to use in the output file. By
default, infers from the file extension in specified path.
Compression mode may be any of the following possible
values: {{‘infer’, ‘gzip’, ‘bz2’, ‘zip’, ‘xz’, None}}. If compression
mode is ‘infer’ and path_or_buf is path-like, then detect
compression mode from the following extensions:
‘.gz’, ‘.bz2’, ‘.zip’ or ‘.xz’. (otherwise no compression).
If dict given and mode is ‘zip’ or inferred as ‘zip’, other entries
passed as additional compression options.
protocol : int
Int which indicates which protocol should be used by the pickler,
default HIGHEST_PROTOCOL (see [1]_ paragraph 12.1.2). The possible
Expand Down