Globus-sdk

-------------------

Added
~~~~~

* Add helper objects and methods for interacting with Globus Connect Server
Storage Gateways (:pr:`554`)

* New methods on ``GCSClient``: ``create_storage_gateway``, ``get_storage_gateway``,
``get_storage_gateway_list``, ``update_storage_gateway``,
``delete_storage_gateway``

* New helper classes for constructing storage gateway documents.
``StorageGatewayDocument`` is the main one, but also
``POSIXStoragePolicies`` and ``POSIXStagingStoragePolicies`` are added for
declaring the storage gateway ``policies`` field. More policy helpers will
be added in future versions.

* Add support for more ``StorageGatewayPolicies`` documents. (:pr:`562`)
The following types are now available:

* ``BlackPearlStoragePolicies``
* ``BoxStoragePolicies``
* ``CephStoragePolicies``
* ``GoogleDriveStoragePolicies``
* ``GoogleCloudStoragePolicies``
* ``OneDriveStoragePolicies``
* ``AzureBlobStoragePolicies``
* ``S3StoragePolicies``
* ``ActiveScaleStoragePolicies``
* ``IrodsStoragePolicies``
* ``HPSSStoragePolicies``

* Add ``https`` scope to ``GCSCollectionScopeBuilder`` (:pr:`563`)

* ``ScopeBuilder`` objects now implement ``__str__`` for easy viewing.
For example, ``print(globus_sdk.TransferClient.scopes)`` (:pr:`568`)

* Several improvements to Transfer helper objects (:pr:`573`)

* Add ``TransferData.add_filter_rule`` for adding filter rules (exclude
rules) to transfers

* Add ``skip_activation_check`` as an argument to ``DeleteData`` and
``TransferData``

* The ``sync_level`` argument to ``TransferData`` is now annotated more
accurately to reject bad strings

Changed
~~~~~~~

* Update the fields used to extract ``AuthAPIError`` messages (:pr:`566`)

* Imports from ``globus_sdk`` are now evaluated lazily via module-level
``__getattr__`` on python 3.7+ (:pr:`571`)

* This improves the performance of imports for almost all use-cases, in some
cases by over 80%

* The method ``globus_sdk._force_eager_imports()`` can be used to force
non-lazy imports, for latency sensitive applications which wish to control
when the time cost of import evaluation is paid. This method is private and is
therefore is not covered under the ``globus-sdk``'s SemVer guarantees, but it is
expected to remain stable for the foreseeable future.

* Improve handling of array-style API responses (:pr:`575`)

* Response objects now define ``__bool__`` as ``bool(data)``. This
means that ``bool(response)`` could be ``False`` if the data is ``{}``,
``[]``, ``0``, or other falsey-types. Previously,
``__bool__`` was not defined, meaning it was always ``True``

* ``globus_sdk.response.ArrayResponse`` is a new class which describes
responses which are expected to hold a top-level array. It satisfies the
sequence protocol, allowing indexing with integers and slices, iteration
over the array data, and length checking with ``len(response)``

* ``globus_sdk.GroupsClient.get_my_groups`` returns an ``ArrayResponse``,
meaning the response data can now be iterated and otherwise used

.. _changelog-3.8.0:

-------------------

Added
~~~~~

* Several changes expose more details of HTTP requests (:pr:`551`)

* ``GlobusAPIError`` has a new property ``headers`` which provides the
case-insensitive mapping of header values from the response

* ``GlobusAPIError`` and ``GlobusHTTPResponse`` now include ``http_reason``,
a string property containing the "reason" from the response

* ``BaseClient.request`` and ``RequestsTransport.request`` now have options
for setting boolean options ``allow_redirects`` and ``stream``, controlling
how requests are processed

* New tools for working with optional and dependent scope strings (:pr:`553`)

* A new class is provided for constructing optional and dependent scope
strings, ``MutableScope``. Import as in
``from globus_sdk.scopes import MutableScope``

* ``ScopeBuilder`` objects provide a method, ``make_mutable``, which converts
from a scope name to a ``MutableScope`` object. See documentation on scopes
for usage details

.. _changelog-3.7.0:

-------------------

Added
~~~~~

* Add a client for the Timer service (:pr:`548`)

* Add ``TimerClient`` class, along with ``TimerJob`` for constructing data
to pass to the Timer service for job creation, and ``TimerAPIError``
* Modify ``globus_sdk.config`` utilities to provide URLs for Actions and
Timer services

Fixed
~~~~~

* Fix annotations to allow request data to be a string. This is
supported at runtime but was missing from annotations. (:pr:`549`)

.. _changelog-3.6.0:

-------------------

Added
~~~~~

* ``ScopeBuilder`` objects now support ``known_url_scopes``, and known scope
arguments to a ``ScopeBuilder`` may now be of type ``str`` in addition to
``list[str]`` (:pr:`536`)

* Add the ``RequestsTransport.tune`` contextmanager to the transport layer,
allowing the settings on the transport to be set temporarily (:pr:`540`)

.. _changelog-3.5.0:

-------------------

Added
~~~~~

* ``globus_sdk.IdentityMap`` can now take a cache as an input. This allows
multiple ``IdentityMap`` instances to share the same storage cache. Any
mutable mapping type is valid, so the cache can be backed by a database or
other storage (:pr:`500`)

* Add support for ``include`` as a parameter to ``GroupsClient.get_group``.
``include`` can be a string or iterable of strings (:pr:`528`)

* Add a new method to tokenstorage, ``SQLiteAdapter.iter_namespaces``, which
iterates over all namespaces visible in the token database (:pr:`529`)

Changed
~~~~~~~

* Add ``TransferRequestsTransport`` class that does not retry ExternalErrors.
This fixes cases in which the ``TransferClient`` incorrectly retried requests (:pr:`522`)

* Use the "reason phrase" as a failover for stringified API errors with no body (:pr:`524`)

Documentation
~~~~~~~~~~~~~

* Enhance documentation for all of the parameters on methods of ``GroupsClient``

.. _changelog-3.4.2:

-------------------

Fixed
~~~~~

* Fix the pagination behavior for ``TransferClient`` on ``task_skipped_errors`` and
``task_successful_transfers``, and apply the same fix to the endpoint manager
variants of these methods. Prior to the fix, paginated calls would return a
single page of results and then stop (:pr:`520`)

.. _changelog-3.4.1: