Add pretty-format-toml #2605
Open
Add pretty-format-toml #2605
Conversation
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
5 tasks
geruh
reviewed
Oct 16, 2025
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # |
Contributor
There was a problem hiding this comment.
pretty-format-toml is linting the license header. I believe this may breaks the release process with the license check. Their documentation mentions an issue with comment preservation. I wonder if there is a way to ignore this. or we can try another lib like taplo.
Contributor
There was a problem hiding this comment.
I've did a check and it seems that it is fine with the format change:
➜ iceberg-python git:(pretty-format-toml) ./dev/check-license
ERROR: Ignored 0 lines in your exclusion files as comments or empty lines.
Could not find Apache license headers in the following files:
!????? /Users/fokko.driesprong/work/iceberg-python/coverage.xml
!????? /Users/fokko.driesprong/work/iceberg-python/.idea/iceberg-python.iml
!????? /Users/fokko.driesprong/work/iceberg-python/.idea/misc.xml
!????? /Users/fokko.driesprong/work/iceberg-python/.idea/modules.xml
!????? /Users/fokko.driesprong/work/iceberg-python/.idea/vcs.xml
!????? /Users/fokko.driesprong/work/iceberg-python/.idea/workspace.xml
!????? /Users/fokko.driesprong/work/iceberg-python/.idea/inspectionProfiles/profiles_settings.xml
!????? /Users/fokko.driesprong/work/iceberg-python/.mypy_cache/CACHEDIR.TAG
!????? /Users/fokko.driesprong/work/iceberg-python/.pytest_cache/CACHEDIR.TAG
!????? /Users/fokko.driesprong/work/iceberg-python/.pytest_cache/README.md
!????? /Users/fokko.driesprong/work/iceberg-python/.pytest_cache/v/cache/lastfailed
!????? /Users/fokko.driesprong/work/iceberg-python/.pytest_cache/v/cache/nodeids
!????? /Users/fokko.driesprong/work/iceberg-python/.pytest_cache/v/cache/stepwise
!????? /Users/fokko.driesprong/work/iceberg-python/.ruff_cache/CACHEDIR.TAG
!????? /Users/fokko.driesprong/work/iceberg-python/htmlcov/class_index.html
!????? /Users/fokko.driesprong/work/iceberg-python/htmlcov/function_index.html
!????? /Users/fokko.driesprong/work/iceberg-python/htmlcov/index.html
!????? /Users/fokko.driesprong/work/iceberg-python/pyiceberg/avro/decoder_fast.c
The checker is pretty flexible when it comes to whitespace.
Contributor
|
I'm unsure if we want to sort the thing. The most important stuff is now all the way at the bottom :/ |
Contributor
|
thanks for adding this. Lets get #2601 in first, and avoid too many moving parts :) |
Contributor
|
@kevinjqliu Let's get #2704 in first as well to avoid having all the exclusions to the top of the file 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Inspired by #2601
Rationale for this change
Adds
pretty-format-tomlfor formatting toml filesAre these changes tested?
I ran
make lintAre there any user-facing changes?