feat(cli): deprecate version command in favor of --version flag#3206
Open
chrisqiqiu wants to merge 1 commit intoapache:mainfrom
Open
feat(cli): deprecate version command in favor of --version flag#3206chrisqiqiu wants to merge 1 commit intoapache:mainfrom
chrisqiqiu wants to merge 1 commit intoapache:mainfrom
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #3160
Rationale for this change
The
pyiceberg versionsubcommand is non-standard. Most CLI tools use--versioninstead.This PR adds
--versionvia Click's built-inclick.version_option()and deprecates theold
versionsubcommand with a visible warning message, following the project's deprecationconventions.
Note: I chose
removed_in="1.0.0"to match the existing deprecation in the REST catalog(see
pyiceberg/catalog/rest/__init__.py), but happy to adjust if a different version is preferred.Are these changes tested?
Yes. Added two new tests:
test_version_flag— verifiespyiceberg --versionworks correctlytest_version_command_emits_deprecation_warning— verifies the old command still works but emits aDeprecationWarningand prints a visible deprecation notice to stderrUpdated the existing

test_version_does_not_load_catalogto account for the deprecation warning.Are there any user-facing changes?
Yes:
pyiceberg --versionis now availablepyiceberg versionstill works but prints a deprecation warning