Skip to content

proxystore.globus.transfer

Create and authenticate a Globus Transfer client.

get_transfer_client_flow 

get_transfer_client_flow(
    check_collections: Iterable[str] = (),
) -> TransferClient

Create a transfer client with consent handling.

Performs a transfer client creation flow. The user is first prompted to authenticate with Globus if the user has not already authenticated. Then all collections in check_collections are checked to make sure that they are accessible. If any ConsentRequired errors are caught, the user is asked to re-authenticate with the required additional scopes.

Parameters:

  • check_collections (Iterable[str], default: () ) –

    An iterable of collection UUIDs to ensure the user's tokens have consent for.

Returns:

Source code in proxystore/globus/transfer.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def get_transfer_client_flow(
    check_collections: Iterable[str] = (),
) -> globus_sdk.TransferClient:
    """Create a transfer client with consent handling.

    Performs a transfer client creation flow. The user is first prompted to
    authenticate with Globus if the user has not already authenticated.
    Then all collections in `check_collections` are checked to make sure that
    they are accessible. If any `ConsentRequired` errors are caught, the
    user is asked to re-authenticate with the required additional scopes.

    Args:
        check_collections: An iterable of collection UUIDs to ensure the
            user's tokens have consent for.

    Returns:
        Transfer client.
    """
    scopes = get_transfer_scopes_by_resource_server()
    manager = NativeAppAuthManager(resource_server_scopes=scopes)
    manager.login()

    authorizer = manager.get_authorizer(
        globus_sdk.scopes.TransferScopes.resource_server,
    )
    transfer_client = globus_sdk.TransferClient(authorizer=authorizer)

    consent_required_scopes: list[str] = []
    for collection in check_collections:
        try:
            transfer_client.operation_ls(collection, path='/')
        except globus_sdk.TransferAPIError as e:
            if (
                e.info.consent_required
                and e.info.consent_required.required_scopes is not None
            ):
                consent_required_scopes.extend(
                    e.info.consent_required.required_scopes,
                )

    if len(consent_required_scopes) == 0:
        return transfer_client

    click.echo(
        'One or more collections require consent in order to be used. '
        'Login again to to grant the remaining consents.',
    )
    manager.login(additional_scopes=consent_required_scopes)
    authorizer = manager.get_authorizer(
        globus_sdk.scopes.TransferScopes.resource_server,
    )
    return globus_sdk.TransferClient(authorizer=authorizer)