File: transport.rst

package info (click to toggle)
python-globus-sdk 4.3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,172 kB
  • sloc: python: 35,227; sh: 44; makefile: 35
file content (68 lines) | stat: -rw-r--r-- 1,860 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
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
66
67
68
Transport Layer
===============

The transport consists of a transport object (
:class:`RequestsTransport <globus_sdk.transport.RequestsTransport>`), but also
tooling for handling retries. It is possible to either register custom retry
check methods, or to override the Transport used by a client in order to
customize this behavior.

Transport
~~~~~~~~~

.. autoclass:: globus_sdk.transport.RequestsTransport
   :members:
   :member-order: bysource

``RequestsTransport`` objects include an attribute, ``globus_client_info`` which
provides the ``X-Globus-Client-Info`` header which is sent to Globus services.
It is an instance of ``GlobusClientInfo``:

.. autoclass:: globus_sdk.transport.GlobusClientInfo
   :members:
   :member-order: bysource

Retries
~~~~~~~

These are the components used by the ``RequestsTransport`` to implement retry
logic.

.. autoclass:: globus_sdk.transport.RetryContext
   :members:
   :member-order: bysource

.. autoclass:: globus_sdk.transport.RetryCheckResult
   :members:
   :member-order: bysource

.. data:: globus_sdk.transport.RetryCheck

   The type for a retry check, a callable which takes a
   ``RetryContext`` and returns a ``RetryCheckResult``. Equivalent to
   ``Callable[[globus_sdk.transport.RetryContext], globus_sdk.transport.RetryCheckResult]``

.. autoclass:: globus_sdk.transport.RetryCheckRunner
   :members:
   :member-order: bysource

.. autoclass:: globus_sdk.transport.RetryCheckFlags
   :members:
   :member-order: bysource

.. autodecorator:: globus_sdk.transport.set_retry_check_flags

Data Encoders
~~~~~~~~~~~~~

.. autoclass:: globus_sdk.transport.RequestEncoder
   :members:
   :member-order: bysource

.. autoclass:: globus_sdk.transport.JSONRequestEncoder
   :members:
   :member-order: bysource

.. autoclass:: globus_sdk.transport.FormRequestEncoder
   :members:
   :member-order: bysource