Skip to content

utils

DSaaS client util module

PolicyEnum

Bases: IntEnum

Enum for the types of policies supported by AERO.

ALL class-attribute instance-attribute

ALL = 3

...

ANY class-attribute instance-attribute

ANY = 2

...

INGESTION class-attribute instance-attribute

INGESTION = 0

Data ingestion policy.

NONE class-attribute instance-attribute

NONE = -1

No policy.

TIMER class-attribute instance-attribute

TIMER = 1

Timer-based policy.

aero_format()

aero_format(fn: callable)

AERO decorator that wraps user analysis function to capture provenance information.

authenticate()

authenticate(client: NativeAppAuthClient, scope: str)

Perform Globus Authentication.

download()

download(*args, **kwargs)

Download data from user-specified repository.

RETURNS DESCRIPTION

tuple[str, str]: Path to the data and its associated extension.

get_transfer_token()

get_transfer_token(collection_uuid: str) -> str

Get the transfer token belonging to the Globus Guest Collection.

This function first verifies whether the token already exists. If it does not, it generates the tokens and updates the token file.

PARAMETER DESCRIPTION
collection_uuid

The UUID of the Globus Guest Collection.

TYPE: str

RETURNS DESCRIPTION
str

The transfer token for the guest collection

TYPE: str

register_function()

register_function(fn: callable)

Registers function with Globus Compute by registering the function with the wrapper