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 s3 head object function. #5020

Open
wants to merge 22 commits into
base: master
Choose a base branch
from
Open

Conversation

DailyDreaming
Copy link
Member

We use this functionality already, this just centralizes it into its own function in an s3 lib.

TODO: What is the "Right Way" to invoke boto3 sessions with proper credential caching?

Changelog Entry

To be copied to the draft changelog by merger:

  • Add s3 head object function.

Reviewer Checklist

  • Make sure it is coming from issues/XXXX-fix-the-thing in the Toil repo, or from an external repo.
    • If it is coming from an external repo, make sure to pull it in for CI with:
      contrib/admin/test-pr otheruser theirbranchname issues/XXXX-fix-the-thing
      
    • If there is no associated issue, create one.
  • Read through the code changes. Make sure that it doesn't have:
    • Addition of trailing whitespace.
    • New variable or member names in camelCase that want to be in snake_case.
    • New functions without type hints.
    • New functions or classes without informative docstrings.
    • Changes to semantics not reflected in the relevant docstrings.
    • New or changed command line options for Toil workflows that are not reflected in docs/running/{cliOptions,cwl,wdl}.rst
    • New features without tests.
  • Comment on the lines of code where problems exist with a review comment. You can shift-click the line numbers in the diff to select multiple lines.
  • Finish the review with an overall description of your opinion.

Merger Checklist

  • Make sure the PR passes tests.
  • Make sure the PR has been reviewed since its last modification. If not, review it.
  • Merge with the Github "Squash and merge" feature.
    • If there are multiple authors' commits, add Co-authored-by to give credit to all contributing authors.
  • Copy its recommended changelog entry to the Draft Changelog.
  • Append the issue number in parentheses to the changelog entry.

@adamnovak
Copy link
Member

@DailyDreaming The right way to get a global boto3 session is not bound out; we only have module-level client and resource getters. So right now you can either hold your own AWSConnectionManager for its session() function, or you could add something to the session.py module to get at the global AWSConnectionManager's session().

Copy link
Member

@adamnovak adamnovak left a comment

Choose a reason for hiding this comment

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

This looks good in general, but it needs a docstring and I think we need to quiet down some warnings it adds.

src/toil/jobStores/aws/jobStore.py Outdated Show resolved Hide resolved
src/toil/jobStores/aws/jobStore.py Show resolved Hide resolved
src/toil/lib/aws/s3.py Outdated Show resolved Hide resolved
src/toil/lib/aws/s3.py Show resolved Hide resolved
@DailyDreaming DailyDreaming marked this pull request as ready for review August 19, 2024 18:12
Copy link
Member

@adamnovak adamnovak left a comment

Choose a reason for hiding this comment

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

This looks OK to me now.

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.

2 participants