v4.8.1

Fixed

• Fix a crash bug in the orjson compatibility module. (#1396)

  This manifested as a RuntimeError when code inspected the module.

v4.8.0

Added

• The SDK now supports use of orjson as an alternative JSON encoder and decoder. When orjson is installed, the SDK will automatically use it in place of the stdlib json module. (#1385)

• RequestsTransport objects are now visible via RequestsTransport.get_current_transport(), a staticmethod, while the transport is sending a request or being used to handle a response. This method raises a LookupError if there is no currently active transport. (#1385)

• The request encoders defined in globus_sdk.transport have been refactored into RequestsRepresentationProvider\s, objects responsible for encoding and decoding requests data in specific formats. In order to retain compatibility, they are still available aliased under their previous names, as "encoders". (#1385)

Removed

• The pinned field was removed from the experimental BookmarkCreateDocument and BookmarkUpdateDocument classes to align with the API, which does not support the field.

Deprecated

• The RequestsTransport class supports configuration of request encoding via a class-variable mapping, encoders. This limits the ability of the SDK to apply per-object customizations, as in the case of orjson support. The class variable encoders is deprecated. Users who wish to customize request encoding and response decoding should leverage the new representation_providers instance variable instead.

• The globus_sdk.transport.encoders module is deprecated. Use globus_sdk.transport.representation_providers instead.

v4.7.0

Added

• Add a per_page parameter to the FlowsClient.list_registered_apis() method. (#1390)

v4.6.0

Added

• Support for managing bookmarks via the Transfer v2 client (#1379)

• Added FlowsClient.get_registered_api(), which retrieves a registered API by ID. (#1386)

• Added FlowsClient.list_registered_apis(), which retrieves a list of registered APIs. (#1387)

Fixed

• Switch to lazy reading of response json to work with streaming responses. (#1381)

v4.5.0

Added

• Added a new globus_sdk.experimental.gcs_downloader module which provides experimental tooling for downloading files from HTTPS GCS Collections. The new module provides a GCSDownloader class for detecting requirements and downloading files. (#1342)

• Added the experimental TransferClientV2 client class along with helper classes TunnelCreateDocument and TunnelUpdateDocument (#1370)

• JSON:API iteration and pagination is now supported through IterableJSONAPIResponse and JSONAPIPaginator (#1370)

• Added a new GCSCollectionClient class in globus_sdk.experimental.gcs_collection_client.
  The new client has no methods other than the base HTTP ones, but contains the collection ID and scopes in the correct locations for the SDK token management mechanisms to use. (#1375)

• Added support for filter_roles as a parameter to SearchClient.index_list. (#1376)

Changed

• All tunnels support in TransferClient has been labeled as Beta as the underlying API is still in development. For the most up to date interfaces it is recommended to use the TransferClientV2 (#1370)

Fixed

• Various fixes for tunnels support in TransferClient (#1370)

v4.4.1

Fixed

• Fixed a bug in globus_sdk.TransferData which failed to convert deadline to a string when a datetime.datetime object is given. (#1372)

v4.4.0

Added

• Added TransferClient.get_tunnel_events(), which fetches the events associated with a tunnel

v4.3.1

Fixed

• The type of scope_requirements in the init signature for ClientApp has been expanded to typing.Mapping to match other locations where a scope_requirements mapping is accepted. (#1360)

Development

• Update the Streams-related type annotations to accept UUIDs. (#1353)

v4.3.0

Added

• Added support to the TransferClient for the Streams API (#1351)

  • CreateTunnelData is a payload builder for tunnel creation documents
  • TransferClient.create_tunnel() supports tunnel creation
  • TransferClient.update_tunnel() supports updates to a tunnel
  • TransferClient.get_tunnel() fetches a tunnel by ID
  • TransferClient.delete_tunnel() deletes a tunnel
  • TransferClient.list_tunnels() fetches all of the current user's tunnels
  • TransferClient.get_stream_access_point() fetches a Stream Access Point by ID

v4.2.0

Python Support

• Add support for Python 3.14. (#1340)

• Remove support for Python 3.8. (#1341)

Added

• GlobusApp and SDK client classes now support usage as context managers, and feature a new close() method to close internal resources. close() is automatically called on exit. (#1326)

  • In support of this, token storages now all feature a close() method, which does nothing in the default implementation.
    Previously, only storages with underlying resources to manage featured a close() method.

  • GlobusApp will close any token storage via close() if the token storage was created by the app on init. Explicitly created storages will not be closed and must be explicitly closed via their close() method.

  • Any class inheriting from BaseClient features close(), which will close any transport object created during client construction.

  • Transports which are created explicitly will not be closed by their clients, and must be explicitly closed.

• Add TimersClient.add_app_flow_user_scope for TimersClient instances which are integrated with GlobusApp. This method registers the specific flow user scope dependency needed for a flow timer. (#1333)

• Added automatic Globus Auth Requirements Error (GARE) redriving to GlobusApp (#1339).

  • More details available at globus_app_gare_integration
  • This feature is disabled by default but can be turned on by setting auto_retry_gares=True in a GlobusAppConfig.

Fixed

• Fixed a resource leak in which a GlobusApp would create internal client objects and never close the associated transports. (#1326)

Development

• Added a new make install recipe.