Skip to content

Commit b36048d

Browse files
authored
DOC: Fixed to_pickle compression argument list 'gzip' > 'gz' (#38192)
1 parent 0e52dbe commit b36048d

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

pandas/core/generic.py

+7
Original file line numberDiff line numberDiff line change
@@ -2799,6 +2799,13 @@ def to_pickle(
27992799
default 'infer'
28002800
A string representing the compression to use in the output file. By
28012801
default, infers from the file extension in specified path.
2802+
Compression mode may be any of the following possible
2803+
values: {{‘infer’, ‘gzip’, ‘bz2’, ‘zip’, ‘xz’, None}}. If compression
2804+
mode is ‘infer’ and path_or_buf is path-like, then detect
2805+
compression mode from the following extensions:
2806+
‘.gz’, ‘.bz2’, ‘.zip’ or ‘.xz’. (otherwise no compression).
2807+
If dict given and mode is ‘zip’ or inferred as ‘zip’, other entries
2808+
passed as additional compression options.
28022809
protocol : int
28032810
Int which indicates which protocol should be used by the pickler,
28042811
default HIGHEST_PROTOCOL (see [1]_ paragraph 12.1.2). The possible

0 commit comments

Comments
 (0)