Repository navigation
Add compression_level support to ParquetWriterOptions and enhance write_parquet to accept full options object - #1169
Merged
Merged
Conversation
timsaucer
requested changes
Jun 24, 2025
Comment on lines
877
to
883
| def write_parquet( | ||
| self, | ||
| path: str | pathlib.Path, | ||
| compression: Union[str, Compression] = Compression.ZSTD, | ||
| compression: Union[str, Compression, ParquetWriterOptions] = Compression.ZSTD, | ||
| compression_level: int | None = None, | ||
| ) -> None: | ||
| """Execute the :py:class:`DataFrame` and write the results to a Parquet file. |
Member
There was a problem hiding this comment.
This change is nice. I think it would be a little better for type hinting in IDEs if we overload the method signatures.
Contributor
Author
There was a problem hiding this comment.
I'll add the overload.
timsaucer
approved these changes
Jun 25, 2025
This was referenced Sep 25, 2026
timsaucer
pushed a commit
that referenced
this pull request
Oct 5, 2026
…ptions (#1761) `write_parquet` takes `write_options`, documents it and declares it in the `@overload` for the `ParquetWriterOptions` form, but that branch calls `write_parquet_with_options(path, compression)` and drops it. The destination accepts the parameter, so everything in `DataFrameWriteOptions` (`partition_by`, `single_file_output`, `insert_operation`, `sort_by`) was silently ignored for that one spelling. Measured with the same `DataFrameWriteOptions(partition_by="part")`: write_parquet(path, ParquetWriterOptions(), write_options=wo) -> ['IDuOjvMa3pdEDotb_0.parquet'] not partitioned write_parquet_with_options(path, ParquetWriterOptions(), write_options=wo) -> ['part=a', 'part=b'] write_parquet(path, "zstd", write_options=wo) -> ['part=a', 'part=b'] No error and no warning: the files just land in the wrong layout. The branch arrived in ef62fa8 (#1169) while `write_options` came earlier in #857, so the new delegation path was written without carrying the existing parameter over. The same `if` refuses `compression_level` with an explicit `ValueError`, which shows that arguments incompatible with this branch get rejected on purpose; `write_options` was not rejected, only forgotten.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Rationale for this change
This change enhances the flexibility of the Parquet writing process by allowing users to specify both compression type and compression level through a unified
ParquetWriterOptionsobject. It also prevents conflicting configurations when options are explicitly passed.What changes are included in this PR?
compression_levelparameter toParquetWriterOptions.DataFrame.write_parquet()to accept aParquetWriterOptionsobject.compression_levelwhen using a full options object.test_write_parquet_options: Verifies functionality with custom compression and level.test_write_parquet_options_error: Ensures proper error is raised for misconfiguration.Are these changes tested?
Yes, two new tests have been added:
test_write_parquet_options: Confirms Parquet output matches expected data.test_write_parquet_options_error: Validates error handling when conflicting options are provided.Are there any user-facing changes?
Yes:
ParquetWriterOptionsobject directly toDataFrame.write_parquet(), allowing more granular control.ValueErrorwill be raised ifcompression_levelis used with an already configured options object.