Skip to content

Make configure_s3_access driver aware #2087

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

Merged
merged 4 commits into from
Aug 4, 2025
Merged

Conversation

SpacemanPaul
Copy link
Contributor

@SpacemanPaul SpacemanPaul commented Aug 4, 2025

Reason for this pull request

As noted in #2081, switching between the legacy and rio drivers results in having to change the way RIO is configured for cloud access.

It is probably possible to get the legacy and rio drivers sharing the same configuration layer eventually, but not in this PR.

Proposed changes

  • Formally deprecate the datacube.utils.rio.configure_s3_access method, which just a partial wrapper around the utils.aws version (and has been deprecated in the docstring forever) and migrate tests to use the preferred location.

  • Add an optional driver argument to configure_s3_access. When it is set to "rio", the call is forwarded to the odc-loader version.

  • Closes Requirement for configure_s3_access is inconsistent between rio and default drivers #2081

  • Tests added / passed

  • Pull Request Title will make sense in ODC Release Notes


📚 Documentation preview 📚: https://opendatacube--2087.org.readthedocs.build/en/2087/

@@ -479,6 +480,7 @@ def configure_s3_access(
requester_pays: bool = False,
cloud_defaults: bool = True,
client=None,
driver: str | None = None,
Copy link
Contributor

Choose a reason for hiding this comment

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

Not having a doc string for a single parameter triggers a warning in my PyCharm and this function doesn't look deprecated, can the parameter get a doc string?

@SpacemanPaul SpacemanPaul merged commit 100e870 into develop Aug 4, 2025
20 checks passed
@SpacemanPaul SpacemanPaul deleted the consistent_s3cfg branch August 4, 2025 23:24
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.

Requirement for configure_s3_access is inconsistent between rio and default drivers
2 participants