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

Use list_objects_v2 in README #1259

Merged

Conversation

nyoungstudios
Copy link
Contributor

Description of Change

  • Updates README documentation to use list_objects_v2 instead of list_objects since that is what the AWS documentation recommends (and list_objects_v2 supports automatic pagination with the client.get_paginator function used in the sample). Should I add a comment or anything in the readme?
  • list_objects documentation recommends to use list_objects_v2 documentation

Assumptions

  • none

Checklist for All Submissions

  • I have added change info to CHANGES.rst
    • Do you want me to add something to the change list for a documentation change?
  • If this is resolving an issue (needed so future developers can determine if change is still necessary and under what conditions) (can be provided via link to issue with these details):
    • Detailed description of issue
    • Alternative methods considered (if any)
    • How issue is being resolved
    • How issue can be reproduced
  • If this is providing a new feature (can be provided via link to issue with these details):
    • Detailed description of new feature
    • Why needed
    • Alternatives methods considered (if any)

Checklist when updating botocore and/or aiohttp versions

  • I have read and followed CONTRIBUTING.rst
  • I have updated test_patches.py where/if appropriate (also check if no changes necessary)
  • I have ensured that the awscli/boto3 versions match the updated botocore version

Copy link

codecov bot commented Jan 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.10%. Comparing base (7432338) to head (89a2089).
Report is 16 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1259      +/-   ##
==========================================
+ Coverage   88.05%   88.10%   +0.05%     
==========================================
  Files          67       67              
  Lines        5904     5904              
==========================================
+ Hits         5199     5202       +3     
+ Misses        705      702       -3     
Flag Coverage Δ
unittests 88.10% <ø> (+0.05%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@thehesiod
Copy link
Collaborator

list_objects does support pagination as well, we use it in the tests: https://github.com/boto/botocore/blob/08877232170abe910198e3c1f758ae6d0f2df6a0/tests/integration/test_s3.py#L396 but ya I see now that AWS suggests using v2 going forwards, thanks!

@thehesiod thehesiod self-requested a review January 19, 2025 18:38
@thehesiod thehesiod added this pull request to the merge queue Jan 19, 2025
Merged via the queue into aio-libs:master with commit 43f8d7c Jan 19, 2025
11 checks passed
@jakob-keller jakob-keller added the documentation Improvements or additions to documentation label Jan 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants