config homogenization #323
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
gadomski
reviewed
Mar 6, 2025
| @@ -29,326 +26,52 @@ class AzureConfig(TypedDict, total=False): | |||
| ``` | |||
| """ | |||
|
|
|||
| azure_storage_account_name: str | |||
| storage_account_name: str | |||
There was a problem hiding this comment.
This does feel a lot more natural (no azure_* prefix) 👍🏼
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.
API question: should there be multiple accepted values for each config value?
Today, you can pass
region,aws_region,REGIONorAWS_REGIONto the config parameter (or as kwargs) and it all works the same (because the underlying Rust library allows all of these variants).But I'm thinking that reading code where one person uses
region, another usesaws_region, and another usesAWS_REGIONis kinda confusing.After all, the zen of python says:
This PR makes the docs much simpler to reason about as well, as there are much fewer options.
The main remaining question is whether we should error on other (now undocumented variants) at runtime, or let it slide. For now, this PR does not yet error for those at runtime.