add ParquetCompressionOptions and SliceType

Author: Dr-Irv

doc/source/reference/aliases.rst

@@ -38,7 +38,7 @@ Alias                                Meaning
 :py:type:`Axis`                      Argument type for ``axis`` in many methods
 :py:type:`CSVEngine`                 Argument type for ``engine`` in :meth:`DataFrame.read_csv`
 :py:type:`ColspaceArgType`           Argument type for ``colspace`` in :meth:`DataFrame.to_html`
-:py:type:`CompressionOptions`        Argument type for ``compression`` in many I/O output methods
+:py:type:`CompressionOptions`        Argument type for ``compression`` in all I/O output methods except :meth:`DataFrame.to_parquet`
 :py:type:`CorrelationMethod`         Argument type for ``correlation`` in :meth:`corr`
 :py:type:`DropKeep`                  Argument type for ``keep`` in :meth:`drop_duplicates`
 :py:type:`Dtype`                     Types as objects that can be used to specify dtypes
@@ -66,13 +66,15 @@ Alias                                Meaning
 :py:type:`NsmallestNlargestKeep`     Argument type for ``keep`` in :meth:`nlargest` and :meth:`nsmallest`
 :py:type:`OpenFileErrors`            Argument type for ``errors`` in :meth:`to_hdf` and :meth:`to_csv`
 :py:type:`Ordered`                   Return type for :py:attr:`ordered`` in :class:`CategoricalDtype` and :class:`Categorical`
+:py:type:`ParquetCompressionOptions` Argument type for ``compression`` in :meth:`DataFrame.to_parquet`
 :py:type:`QuantileInterpolation`     Argument type for ``interpolation`` in :meth:`quantile`
 :py:type:`ReadBuffer`                Additional argument type corresponding to buffers for various file reading methods
 :py:type:`ReadCsvBuffer`             Additional argument type corresponding to buffers for :meth:`pandas.read_csv`
 :py:type:`ReadPickleBuffer`          Additional argument type corresponding to buffers for :meth:`pandas.read_pickle`
 :py:type:`ReindexMethod`             Argument type for ``reindex`` in :meth:`reindex`
 :py:type:`Scalar`                    Basic type that can be stored in :class:`Series`
 :py:type:`SequenceNotStr`            Used for arguments that require sequences, but not plain strings
+:py:type:`SliceType`                 Argument types for ``start`` and ``end`` in :meth:`Index.slice_locs`
 :py:type:`SortKind`                  Argument type for ``kind`` in :meth:`sort_index` and :meth:`sort_values`
 :py:type:`StorageOptions`            Argument type for ``storage_options`` in various file output methods
 :py:type:`Suffixes`                  Argument type for ``suffixes`` in :meth:`merge`, :meth:`compare` and :meth:`merge_ordered`

pandas/_typing.py

@@ -312,6 +312,9 @@ def closed(self) -> bool:
 CompressionOptions: TypeAlias = (
     Literal["infer", "gzip", "bz2", "zip", "xz", "zstd", "tar"] | CompressionDict | None
 )
+ParquetCompressionOptions: TypeAlias = (
+    Literal["snappy", "gzip", "brotli", "lz4", "zstd"] | None
+)
 
 # types in DataFrameFormatter
 FormattersType: TypeAlias = (

pandas/api/typing/aliases.py

@@ -37,13 +37,15 @@
     NsmallestNlargestKeep,
     OpenFileErrors,
     Ordered,
+    ParquetCompressionOptions,
     QuantileInterpolation,
     ReadBuffer,
     ReadCsvBuffer,
     ReadPickleBuffer,
     ReindexMethod,
     Scalar,
     SequenceNotStr,
+    SliceType,
     SortKind,
     StorageOptions,
     Suffixes,
@@ -103,13 +105,15 @@
     "NsmallestNlargestKeep",
     "OpenFileErrors",
     "Ordered",
+    "ParquetCompressionOptions",
     "QuantileInterpolation",
     "ReadBuffer",
     "ReadCsvBuffer",
     "ReadPickleBuffer",
     "ReindexMethod",
     "Scalar",
     "SequenceNotStr",
+    "SliceType",
     "SortKind",
     "StorageOptions",
     "Suffixes",

pandas/core/frame.py

@@ -238,6 +238,7 @@
         MutableMappingT,
         NaPosition,
         NsmallestNlargestKeep,
+        ParquetCompressionOptions,
         PythonFuncType,
         QuantileInterpolation,
         ReadBuffer,
@@ -2860,7 +2861,7 @@ def to_parquet(
         path: None = ...,
         *,
         engine: Literal["auto", "pyarrow", "fastparquet"] = ...,
-        compression: str | None = ...,
+        compression: ParquetCompressionOptions = ...,
         index: bool | None = ...,
         partition_cols: list[str] | None = ...,
         storage_options: StorageOptions = ...,
@@ -2873,7 +2874,7 @@ def to_parquet(
         path: FilePath | WriteBuffer[bytes],
         *,
         engine: Literal["auto", "pyarrow", "fastparquet"] = ...,
-        compression: str | None = ...,
+        compression: ParquetCompressionOptions = ...,
         index: bool | None = ...,
         partition_cols: list[str] | None = ...,
         storage_options: StorageOptions = ...,
@@ -2886,7 +2887,7 @@ def to_parquet(
         path: FilePath | WriteBuffer[bytes] | None = None,
         *,
         engine: Literal["auto", "pyarrow", "fastparquet"] = "auto",
-        compression: str | None = "snappy",
+        compression: ParquetCompressionOptions = "snappy",
         index: bool | None = None,
         partition_cols: list[str] | None = None,
         storage_options: StorageOptions | None = None,

pandas/io/parquet.py

@@ -43,6 +43,7 @@
     from pandas._typing import (
         DtypeBackend,
         FilePath,
+        ParquetCompressionOptions,
         ReadBuffer,
         StorageOptions,
         WriteBuffer,
@@ -175,7 +176,7 @@ def write(
         self,
         df: DataFrame,
         path: FilePath | WriteBuffer[bytes],
-        compression: str | None = "snappy",
+        compression: ParquetCompressionOptions = "snappy",
         index: bool | None = None,
         storage_options: StorageOptions | None = None,
         partition_cols: list[str] | None = None,
@@ -411,7 +412,7 @@ def to_parquet(
     df: DataFrame,
     path: FilePath | WriteBuffer[bytes] | None = None,
     engine: str = "auto",
-    compression: str | None = "snappy",
+    compression: ParquetCompressionOptions = "snappy",
     index: bool | None = None,
     storage_options: StorageOptions | None = None,
     partition_cols: list[str] | None = None,

pandas/tests/api/test_api.py

@@ -383,13 +383,15 @@ class TestApi(Base):
         "NsmallestNlargestKeep",
         "OpenFileErrors",
         "Ordered",
+        "ParquetCompressionOptions",
         "QuantileInterpolation",
         "ReadBuffer",
         "ReadCsvBuffer",
         "ReadPickleBuffer",
         "ReindexMethod",
         "Scalar",
         "SequenceNotStr",
+        "SliceType",
         "SortKind",
         "StorageOptions",
         "Suffixes",