Refactor planetary_variable_source() signature #1170
Merged
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
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the planetary_variable_source() function to remove the source_type positional argument, representing a breaking change for v3.x.x as the SDK moves away from source type dependencies in favor of more precise parameters.
- Removes
var_typeparameter fromplanetary_variable_source()function signature - Updates all tests and CLI commands to no longer use or expect source type functionality
- Simplifies documentation to focus on variable IDs rather than types
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| planet/subscription_request.py | Removes var_type parameter and associated logic from planetary_variable_source() function |
| planet/cli/subscriptions.py | Removes --var-type CLI option and updates command implementation |
| tests/unit/test_subscription_request.py | Updates unit tests to remove source type test cases and assertions |
| tests/integration/test_subscriptions_cli.py | Updates integration tests to remove source type parameterization |
| docs/hooks/mkdocs_hooks.py | Adds whitespace formatting |
Comments suppressed due to low confidence (1)
adamweiner
reviewed
Jul 23, 2025
|
Add note about breaking change to the 3.0 migration guide. |
asonnenschein
force-pushed
the
adrian/refactor-kwargs
branch
from
2da4768 to
7dd1896
Compare
asonnenschein
force-pushed
the
adrian/refactor-kwargs
branch
from
7dd1896 to
8153685
Compare
adamweiner
approved these changes
Jul 24, 2025
|
Added breaking change note to v3 migration doc #1173 |
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.
This MR refactors the
subscription_request.planetary_variable_source()to better reflect API functionality by removing thesource_typepositional argument from the signature. This is a breaking change and will need to ship with v3.x.x. Source type is an optional property on the Subscriptions API service contract that we are moving away from in favor of more precise parameters like source ID, item types, asset types, etc. #1107 started the effort to reduce reliance of source type in the SDK, but had to stop short of removing the source type positional argument fromsubscription_request.planetary_variable_source()because it would've been a breaking change in v2.x.x.