Skip to content

proxystore.globus.client

Create Globus Service clients.

get_confidential_app_auth_client 

get_confidential_app_auth_client(
    client_id: str | None = None,
    client_secret: str | None = None,
) -> ConfidentialAppAuthClient

Create a confidential application authentication client.

Note

See the Globus SDK docs to learn how to create a confidential application and get the ID and secret.

Note

This function will not perform the OAuth2 flow.

Parameters:

  • client_id (str | None, default: None ) –

    Client ID. If either client_id or client_secret is None, the values will be read from the environment using get_client_credentials_from_env().

  • client_secret (str | None, default: None ) –

    Client secret.

Returns:

Raises:

  • ValueError –

    if client_id or client_secret are not provided and one or both of PROXYSTORE_GLOBUS_CLIENT_ID and PROXYSTORE_GLOBUS_CLIENT_SECRET are not set.

Source code in proxystore/globus/client.py 
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
def get_confidential_app_auth_client(
    client_id: str | None = None,
    client_secret: str | None = None,
) -> globus_sdk.ConfidentialAppAuthClient:
    """Create a confidential application authentication client.

    Note:
        See the [Globus SDK docs](https://globus-sdk-python.readthedocs.io/en/stable/examples/client_credentials.html#get-a-client)
        to learn how to create a confidential application and get the ID
        and secret.

    Note:
        This function will not perform the OAuth2 flow.

    Args:
        client_id: Client ID. If either `client_id` or `client_secret` is
            `None`, the values will be read from the environment using
            [`get_client_credentials_from_env()`][proxystore.globus.app.get_client_credentials_from_env].
        client_secret: Client secret.

    Returns:
        Authorization client.

    Raises:
        ValueError: if `client_id` or `client_secret` are not provided and
            one or both of `PROXYSTORE_GLOBUS_CLIENT_ID` and
            `PROXYSTORE_GLOBUS_CLIENT_SECRET` are not set.
    """
    if client_id is None or client_secret is None:
        client_id, client_secret = get_client_credentials_from_env()

    return globus_sdk.ConfidentialAppAuthClient(
        client_id=str(client_id),
        client_secret=str(client_secret),
    )

get_native_app_auth_client 

get_native_app_auth_client(
    client_id: str = PROXYSTORE_GLOBUS_CLIENT_ID,
    app_name: str | None = None,
) -> NativeAppAuthClient

Create a native app authentication client.

Note

This function will not perform the OAuth2 flow.

Parameters:

  • client_id (str, default: PROXYSTORE_GLOBUS_CLIENT_ID ) –

    Application ID. Defaults to the ProxyStore application ID.

  • app_name (str | None, default: None ) –

    Application name.

Returns:

Source code in proxystore/globus/client.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
def get_native_app_auth_client(
    client_id: str = PROXYSTORE_GLOBUS_CLIENT_ID,
    app_name: str | None = None,
) -> globus_sdk.NativeAppAuthClient:
    """Create a native app authentication client.

    Note:
        This function will not perform the OAuth2 flow.

    Args:
        client_id: Application ID. Defaults to the ProxyStore application ID.
        app_name: Application name.

    Returns:
        Authorization client.
    """
    return globus_sdk.NativeAppAuthClient(
        client_id=client_id,
        app_name=_APP_NAME if app_name is None else app_name,
    )

get_transfer_client 

get_transfer_client(
    globus_app: GlobusApp | None = None,
    collections: Iterable[str] = (),
) -> TransferClient

Create a transfer client.

Parameters:

Returns:

Source code in proxystore/globus/client.py 
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
def get_transfer_client(
    globus_app: GlobusApp | None = None,
    collections: Iterable[str] = (),
) -> globus_sdk.TransferClient:
    """Create a transfer client.

    Args:
        globus_app: [`GlobusApp`][globus_sdk.GlobusApp] used to initialize
            the transfer client. If `None`, a default
            [`UserApp`][globus_sdk.UserApp] is created using
            [`get_user_app()`][proxystore.globus.app.get_user_app].
        collections: Iterable of collection UUIDs to add dependent
            `data_access` scopes for (via
            [`add_app_data_access_scope()`][globus_sdk.TransferClient.add_app_data_access_scope].

    Returns:
        Transfer client.
    """
    if globus_app is None:
        globus_app = get_user_app()

    client = globus_sdk.TransferClient(app=globus_app)
    client.add_app_data_access_scope(collections)

    return client