Suffix clients with Client after service name#478
Merged
Conversation
1c74701 to
7f58bf4
Compare
7f58bf4 to
51017df
Compare
SamRemis
approved these changes
Apr 7, 2025
SamRemis
left a comment
Contributor
There was a problem hiding this comment.
Since this PR is opened as a point of discussion, just adding my two cents:
Approving this since I'm very much in favor of it. The docs seem to generate fine with this change, but I should probably look more into it than just a quick skim.
Calling this a "client" will make this more familiar for users migrating from botocore and makes it clear that this is not just a general concept, but an object to be used to call the service. I'd be very surprised if we had strong customer feedback making a compelling argument for a different name. If we do, we should make the breaking change before this goes GA.
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.
Description of changes:
This is a proposal for adding
Clientto the end of our generated service clients. While these all originated from the generated namespacefrom service_name.client import ServiceName, it reads a bit oddly in isolated code snippets.Prior art from recent SDKs is showing 3 out of the 5 existing Smithy SDKs all suffix with Client to reduce ambiguity. I don't think there's a lot of standing precedent in Python itself for which direction to go. I'm adding this PR as a talking point for if we feel this is necessary.
I don't think it hurts to add this for the moment, but we'll need to decide if we bias one way now, are we're willing to break that based on feedback later?
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.