diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 3967c3df6b7cb..76a473dad79a4 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -3296,7 +3296,7 @@ def to_latex( @final @doc( storage_options=_shared_docs["storage_options"], - compression_options=_shared_docs["compression_options"], + compression_options=_shared_docs["compression_options"] % "path_or_buf", ) @deprecate_kwarg(old_arg_name="line_terminator", new_arg_name="lineterminator") def to_csv( diff --git a/pandas/core/shared_docs.py b/pandas/core/shared_docs.py index 09ee254633b22..4b7a487e9472d 100644 --- a/pandas/core/shared_docs.py +++ b/pandas/core/shared_docs.py @@ -423,7 +423,7 @@ _shared_docs[ "compression_options" ] = """compression : str or dict, default 'infer' - For on-the-fly compression of the output data. If 'infer' and '%s' + For on-the-fly compression of the output data. If 'infer' and '%s' is path-like, then detect compression from the following extensions: '.gz', '.bz2', '.zip', '.xz', '.zst', '.tar', '.tar.gz', '.tar.xz' or '.tar.bz2' (otherwise no compression). @@ -432,7 +432,7 @@ to one of {``'zip'``, ``'gzip'``, ``'bz2'``, ``'zstd'``, ``'tar'``} and other key-value pairs are forwarded to ``zipfile.ZipFile``, ``gzip.GzipFile``, - ``bz2.BZ2File``, ``zstandard.ZstdDecompressor`` or + ``bz2.BZ2File``, ``zstandard.ZstdCompressor`` or ``tarfile.TarFile``, respectively. As an example, the following could be passed for faster compression and to create a reproducible gzip archive: diff --git a/pandas/io/parsers/readers.py b/pandas/io/parsers/readers.py index b4e3a0545879c..35227dcf6a82d 100644 --- a/pandas/io/parsers/readers.py +++ b/pandas/io/parsers/readers.py @@ -852,7 +852,8 @@ def read_csv( summary="Read a comma-separated values (csv) file into DataFrame.", _default_sep="','", storage_options=_shared_docs["storage_options"], - decompression_options=_shared_docs["decompression_options"], + decompression_options=_shared_docs["decompression_options"] + % "filepath_or_buffer", ) ) def read_csv( @@ -1189,7 +1190,8 @@ def read_table( summary="Read general delimited file into DataFrame.", _default_sep=r"'\\t' (tab-stop)", storage_options=_shared_docs["storage_options"], - decompression_options=_shared_docs["decompression_options"], + decompression_options=_shared_docs["decompression_options"] + % "filepath_or_buffer", ) ) def read_table( diff --git a/pandas/io/sas/sasreader.py b/pandas/io/sas/sasreader.py index 57014ef9c9622..359174166f980 100644 --- a/pandas/io/sas/sasreader.py +++ b/pandas/io/sas/sasreader.py @@ -79,7 +79,7 @@ def read_sas( @deprecate_nonkeyword_arguments(version=None, allowed_args=["filepath_or_buffer"]) -@doc(decompression_options=_shared_docs["decompression_options"]) +@doc(decompression_options=_shared_docs["decompression_options"] % "filepath_or_buffer") def read_sas( filepath_or_buffer: FilePath | ReadBuffer[bytes], format: str | None = None, diff --git a/pandas/io/stata.py b/pandas/io/stata.py index 1a230f4ae4164..16c1a80034d0c 100644 --- a/pandas/io/stata.py +++ b/pandas/io/stata.py @@ -140,7 +140,7 @@ {_statafile_processing_params2} {_chunksize_params} {_iterator_params} -{_shared_docs["decompression_options"]} +{_shared_docs["decompression_options"] % "filepath_or_buffer"} {_shared_docs["storage_options"]} Returns