Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add generic support for client context params #3037

Merged
merged 6 commits into from
Oct 24, 2023

Conversation

dlm6693
Copy link
Contributor

@dlm6693 dlm6693 commented Oct 12, 2023

Adds client context parameters generically across all AWS services and adds them to docs. This PR can be reviewed in two parts. Should be merged in tandem with boto/boto3#3894.

Commit 1

Adds client_context_params config option. If the service is s3 or s3control, still use the s3 config param over client context params if it is set. Params are modeled as capital case but are expected in snake case by the endpoint resolver. This commit also includes some code cleanup for the existing client context params test.

Commit 2

Adds client context params docs to each service client's homepage if any are modeled. Existing s3/s3control params are excluded because overlapping behavior already exists in the s3 config. There are no other modeled client context params today, but when one is added to a service model, the new docs section will look something like this:

Screenshot 2023-10-11 at 2 58 03 PM

@dlm6693 dlm6693 changed the title Client context params Add generic support for client context params Oct 12, 2023
@codecov-commenter
Copy link

codecov-commenter commented Oct 12, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f0ff061) 93.44% compared to head (ff56318) 93.46%.
Report is 32 commits behind head on develop.

❗ Current head ff56318 differs from pull request most recent head 18c3abb. Consider uploading reports for the commit 18c3abb to get more accurate results

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #3037      +/-   ##
===========================================
+ Coverage    93.44%   93.46%   +0.01%     
===========================================
  Files           66       66              
  Lines        13965    14007      +42     
===========================================
+ Hits         13049    13091      +42     
  Misses         916      916              
Files Coverage Δ
botocore/args.py 100.00% <100.00%> (ø)
botocore/config.py 100.00% <ø> (ø)
botocore/docs/client.py 100.00% <100.00%> (ø)
botocore/docs/service.py 98.41% <100.00%> (+0.33%) ⬆️

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

botocore/config.py Outdated Show resolved Hide resolved
botocore/args.py Outdated Show resolved Hide resolved
Copy link
Contributor

@nateprewitt nateprewitt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple minor comments but otherwise this looks good. Can you add an enhancement changelog to this?

botocore/config.py Outdated Show resolved Hide resolved
botocore/docs/client.py Show resolved Hide resolved
botocore/config.py Outdated Show resolved Hide resolved
@dlm6693 dlm6693 merged commit 1b43d1a into boto:develop Oct 24, 2023
40 checks passed
@dlm6693 dlm6693 deleted the client-context-params branch October 24, 2023 19:56
aws-sdk-python-automation added a commit that referenced this pull request Oct 25, 2023
* release-1.31.71:
  Bumping version to 1.31.71
  Update to latest models
  Add generic support for client context params (#3037)
dlm6693 added a commit to dlm6693/botocore that referenced this pull request Nov 7, 2023
* add `client_context_params` config setting

* add `client_context_params` to docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants