Skip to content

Fix create-guest-collection user guide examples #1411

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
sirosen merged 1 commit into from
Aug 5, 2026
Merged

Fix create-guest-collection user guide examples #1411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions ...ge_patterns/data_transfer/create_guest_collection/create_guest_collection_client_owned.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
MAPPED_COLLECTION_ID = "6c54cade-bde5-45c1-bdea-f4bd71dba2cc"


def main():
def main() -> None:
with ClientApp(
"my-simple-client-collection",
client_id=CONFIDENTIAL_CLIENT_ID,
Expand All @@ -22,7 +22,7 @@ def main():
create_guest_collection(gcs_client)


def create_guest_collection(gcs_client: globus_sdk.GCSClient):
def create_guest_collection(gcs_client: globus_sdk.GCSClient) -> None:
# Comment out this line if the mapped collection is high assurance
attach_data_access_scope(gcs_client, MAPPED_COLLECTION_ID)

Expand All @@ -39,20 +39,20 @@ def create_guest_collection(gcs_client: globus_sdk.GCSClient):
print(f"Created guest collection. Collection ID: {collection['id']}")


def attach_data_access_scope(gcs_client, collection_id):
def attach_data_access_scope(
gcs_client: globus_sdk.GCSClient, collection_id: str
) -> None:
"""Compose and attach a ``data_access`` scope for the supplied collection"""
endpoint_scopes = gcs_client.get_gcs_endpoint_scopes(gcs_client.endpoint_client_id)
collection_scopes = gcs_client.get_gcs_collection_scopes(collection_id)

data_access = globus_sdk.Scope(collection_scopes.data_access, optional=True)
manage_collections = globus_sdk.Scope(
endpoint_scopes.manage_collections, dependencies=(data_access,)
)
data_access = collection_scopes.data_access.with_optional(True)
manage_collections = endpoint_scopes.manage_collections.with_dependency(data_access)

gcs_client.add_app_scope(manage_collections)


def ensure_user_credential(gcs_client):
def ensure_user_credential(gcs_client: globus_sdk.GCSClient) -> None:
"""
Ensure that the client has a user credential on the client.
This is the mapping between Globus Auth (OAuth2) and the local system's permissions.
Expand Down
16 changes: 8 additions & 8 deletions ...sage_patterns/data_transfer/create_guest_collection/create_guest_collection_user_owned.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@
MAPPED_COLLECTION_ID = "6c54cade-bde5-45c1-bdea-f4bd71dba2cc"


def main():
def main() -> None:
with UserApp("my-simple-user-collection", client_id=NATIVE_CLIENT_ID) as app:
with globus_sdk.GCSClient(ENDPOINT_HOSTNAME, app=app) as client:
create_guest_collection(client)


def create_guest_collection(gcs_client: globus_sdk.GCSClient):
def create_guest_collection(gcs_client: globus_sdk.GCSClient) -> None:
# Comment out this line if the mapped collection is high assurance
attach_data_access_scope(gcs_client, MAPPED_COLLECTION_ID)

Expand All @@ -34,20 +34,20 @@ def create_guest_collection(gcs_client: globus_sdk.GCSClient):
print(f"Created guest collection. Collection ID: {collection['id']}")


def attach_data_access_scope(gcs_client, collection_id):
def attach_data_access_scope(
gcs_client: globus_sdk.GCSClient, collection_id: str
) -> None:
"""Compose and attach a ``data_access`` scope for the supplied collection"""
endpoint_scopes = gcs_client.get_gcs_endpoint_scopes(gcs_client.endpoint_client_id)
collection_scopes = gcs_client.get_gcs_collection_scopes(collection_id)

data_access = globus_sdk.Scope(collection_scopes.data_access, optional=True)
manage_collections = globus_sdk.Scope(
endpoint_scopes.manage_collections, dependencies=(data_access,)
)
data_access = collection_scopes.data_access.with_optional(True)
manage_collections = endpoint_scopes.manage_collections.with_dependency(data_access)

gcs_client.add_app_scope(manage_collections)


def ensure_user_credential(gcs_client):
def ensure_user_credential(gcs_client: globus_sdk.GCSClient) -> None:
"""
Ensure that the user has a user credential on the client.
This is the mapping between Globus Auth (OAuth2) and the local system's permissions.
Expand Down
Loading