Skip to content

Make parameter name more consistent for S3 utility functions #848

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.

Sign up for GitHub

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 2 commits into from
Oct 7, 2025
Merged

Make parameter name more consistent for S3 utility functions #848

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f572fff
Make parameter name more consistent
kingcrimsontianyu Oct 7, 2025
d41aace
Reformat
kingcrimsontianyu Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions python/kvikio/kvikio/_lib/remote_handle.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ cdef class RemoteFile:
aws_access_key_id: Optional[str] = None,
aws_secret_access_key: Optional[str] = None,
aws_endpoint_url: Optional[str] = None,
session_token: Optional[str] = None,
aws_session_token: Optional[str] = None,
):
cdef pair[string, string] bucket_and_object_names = _to_string_pair(
bucket_name, object_name
Expand All @@ -209,7 +209,9 @@ cdef class RemoteFile:
cdef optional[string] cpp_aws_endpoint_url = _to_optional_string(
aws_endpoint_url
)
cdef optional[string] cpp_aws_session_token = _to_optional_string(session_token)
cdef optional[string] cpp_aws_session_token = _to_optional_string(
aws_session_token
)
cdef unique_ptr[cpp_RemoteEndpoint] cpp_endpoint

with nogil:
Expand All @@ -236,7 +238,7 @@ cdef class RemoteFile:
aws_region_name: Optional[str] = None,
aws_access_key_id: Optional[str] = None,
aws_secret_access_key: Optional[str] = None,
session_token: Optional[str] = None,
aws_session_token: Optional[str] = None,
):
cdef string cpp_url = _to_string(url)
cdef optional[string] cpp_aws_region = _to_optional_string(aws_region_name)
Expand All @@ -247,7 +249,7 @@ cdef class RemoteFile:
_to_optional_string(aws_secret_access_key)
)
cdef optional[string] cpp_aws_session_token = _to_optional_string(
session_token
aws_session_token
)
cdef unique_ptr[cpp_RemoteEndpoint] cpp_endpoint

Expand Down Expand Up @@ -275,7 +277,7 @@ cdef class RemoteFile:
aws_access_key_id: Optional[str] = None,
aws_secret_access_key: Optional[str] = None,
aws_endpoint_url: Optional[str] = None,
session_token: Optional[str] = None,
aws_session_token: Optional[str] = None,
):
cdef string cpp_url = _to_string(url)
cdef pair[string, string] bucket_and_object_names
Expand All @@ -290,7 +292,7 @@ cdef class RemoteFile:
aws_endpoint_url
)
cdef optional[string] cpp_aws_session_token = _to_optional_string(
session_token
aws_session_token
)
cdef unique_ptr[cpp_RemoteEndpoint] cpp_endpoint

Expand Down
10 changes: 5 additions & 5 deletions python/kvikio/kvikio/remote_file.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ def open_s3(
- ``AWS_DEFAULT_REGION`` (or region_name parameter)
- ``AWS_ACCESS_KEY_ID`` (or access_key_id parameter)
- ``AWS_SECRET_ACCESS_KEY`` (or secret_access_key parameter)
- ``AWS_SESSION_TOKEN`` (or session_token parameter, when using
- ``AWS_SESSION_TOKEN`` (or aws_session_token parameter, when using
temporary credentials)

Additionally, to overwrite the AWS endpoint, set `AWS_ENDPOINT_URL`
Expand Down Expand Up @@ -196,7 +196,7 @@ def open_s3_url(
aws_access_key_id: Optional[str] = None,
aws_secret_access_key: Optional[str] = None,
aws_endpoint_url: Optional[str] = None,
session_token: Optional[str] = None,
aws_session_token: Optional[str] = None,
) -> RemoteFile:
"""Open a AWS S3 file from an URL.

Expand All @@ -210,7 +210,7 @@ def open_s3_url(
- ``AWS_DEFAULT_REGION`` (or region_name parameter)
- ``AWS_ACCESS_KEY_ID`` (or access_key_id parameter)
- ``AWS_SECRET_ACCESS_KEY`` (or secret_access_key parameter)
- ``AWS_SESSION_TOKEN`` (or session_token parameter, when using
- ``AWS_SESSION_TOKEN`` (or aws_session_token parameter, when using
temporary credentials)

Additionally, if `url` is a S3 url, it is possible to overwrite the AWS endpoint
Expand Down Expand Up @@ -252,7 +252,7 @@ def open_s3_url(
aws_region_name,
aws_access_key_id,
aws_secret_access_key,
session_token,
aws_session_token,
)
)
if parsed_result.scheme == "s3":
Expand All @@ -264,7 +264,7 @@ def open_s3_url(
aws_access_key_id,
aws_secret_access_key,
aws_endpoint_url,
session_token,
aws_session_token,
)
)
raise ValueError(f"Unsupported protocol: {url}")
Expand Down