Add support for 'orjson' and introduce a 'RequestsRepresentationProvider' API for handling both serialization and deserialization

.github/workflows/test.yaml

@@ -44,6 +44,8 @@ jobs:
               - "3.14"
             tox-post-environments:
               - "py3.9-mindeps"
+              - "py3.9-orjson"
+              - "py3.14-orjson"
               - "py3.11-sphinxext"
               - "coverage_report"
 
@@ -53,6 +55,7 @@ jobs:
               - "3.11"
             tox-post-environments:
               - "py3.11-sphinxext"
+              - "py3.14-orjson"
               - "coverage_report"
 
           - name: "Windows"
@@ -62,6 +65,7 @@ jobs:
               - "3.11"
             tox-post-environments:
               - "py3.9-mindeps"
+              - "py3.14-orjson"
               - "py3.11-sphinxext"
               - "coverage_report"
 

changelog.d/20260501_170758_sirosen_define_orjson_encoder.rst

@@ -0,0 +1,31 @@
+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. (:pr:`NUMBER`)
+
+-   ``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.
+    (:pr:`NUMBER`)
+
+-   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".
+
+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.

pyproject.toml

@@ -57,6 +57,7 @@ docs = [
     "scriv",
 ]
 coverage = ["coverage[toml]"]
+orjson = ["orjson>=3"]
 test = [
     {include-group = "coverage"},
     "pytest", "pytest-xdist", "pytest-randomly", "flaky",
@@ -83,6 +84,8 @@ typing = [
     "responses",
     # similarly, sphinx is needed to type-check our sphinx extension
     "sphinx",
+    # include any optional test deps
+    {include-group = "orjson"},
 ]
 typing-mindeps = [
     {include-group = "typing"},

requirements/py3.10/test-orjson.txt

@@ -0,0 +1,55 @@
+#
+# This file is autogenerated by pip-compile with Python 3.10
+# by the following command:
+#
+#    tox p -m freezedeps
+#
+certifi==2026.5.20
+    # via requests
+charset-normalizer==3.4.7
+    # via requests
+coverage==7.14.1
+    # via -r .test.in
+exceptiongroup==1.3.1
+    # via pytest
+execnet==2.1.2
+    # via pytest-xdist
+flaky==3.8.1
+    # via -r .test.in
+idna==3.16
+    # via requests
+iniconfig==2.3.0
+    # via pytest
+orjson==3.11.9
+    # via -r .orjson.in
+packaging==26.2
+    # via pytest
+pluggy==1.6.0
+    # via pytest
+pygments==2.20.0
+    # via pytest
+pytest==9.0.3
+    # via
+    #   -r .test.in
+    #   pytest-randomly
+    #   pytest-xdist
+pytest-randomly==4.1.0
+    # via -r .test.in
+pytest-xdist==3.8.0
+    # via -r .test.in
+pyyaml==6.0.3
+    # via responses
+requests==2.34.2
+    # via responses
+responses==0.26.1
+    # via -r .test.in
+tomli==2.4.1
+    # via
+    #   coverage
+    #   pytest
+typing-extensions==4.15.0
+    # via exceptiongroup
+urllib3==2.7.0
+    # via
+    #   requests
+    #   responses

requirements/py3.10/test.txt

@@ -4,19 +4,19 @@
 #
 #    tox p -m freezedeps
 #
-certifi==2026.4.22
+certifi==2026.5.20
     # via requests
 charset-normalizer==3.4.7
     # via requests
-coverage==7.14.0
+coverage==7.14.1
     # via -r .test.in
 exceptiongroup==1.3.1
     # via pytest
 execnet==2.1.2
     # via pytest-xdist
 flaky==3.8.1
     # via -r .test.in
-idna==3.15
+idna==3.16
     # via requests
 iniconfig==2.3.0
     # via pytest
@@ -37,9 +37,9 @@ pytest-xdist==3.8.0
     # via -r .test.in
 pyyaml==6.0.3
     # via responses
-requests==2.34.1
+requests==2.34.2
     # via responses
-responses==0.26.0
+responses==0.26.1
     # via -r .test.in
 tomli==2.4.1
     # via

requirements/py3.10/typing.txt

@@ -6,17 +6,17 @@
 #
 alabaster==1.0.0
     # via sphinx
-ast-serialize==0.3.0
+ast-serialize==0.5.0
     # via mypy
 babel==2.18.0
     # via sphinx
-certifi==2026.4.22
+certifi==2026.5.20
     # via requests
 charset-normalizer==3.4.7
     # via requests
 docutils==0.21.2
     # via sphinx
-idna==3.15
+idna==3.16
     # via requests
 imagesize==2.0.0
     # via sphinx
@@ -30,6 +30,8 @@ mypy==2.1.0
     # via -r .typing.in
 mypy-extensions==1.1.0
     # via mypy
+orjson==3.11.9
+    # via -r .typing.in
 packaging==26.2
     # via sphinx
 pathspec==1.1.1
@@ -38,13 +40,13 @@ pygments==2.20.0
     # via sphinx
 pyyaml==6.0.3
     # via responses
-requests==2.34.1
+requests==2.34.2
     # via
     #   responses
     #   sphinx
-responses==0.26.0
+responses==0.26.1
     # via -r .typing.in
-snowballstemmer==3.0.1
+snowballstemmer==3.1.0
     # via sphinx
 sphinx==8.1.3
     # via -r .typing.in
@@ -66,11 +68,11 @@ tomli==2.4.1
     #   sphinx
 types-cryptography==3.3.23.2
     # via types-jwt
-types-docutils==0.22.3.20260508
+types-docutils==0.22.3.20260518
     # via -r .typing.in
 types-jwt==0.1.3
     # via -r .typing.in
-types-requests==2.33.0.20260513
+types-requests==2.33.0.20260518
     # via -r .typing.in
 typing-extensions==4.15.0
     # via

requirements/py3.11/docs.txt

@@ -14,11 +14,11 @@ babel==2.18.0
     # via sphinx
 beautifulsoup4==4.14.3
     # via furo
-certifi==2026.4.22
+certifi==2026.5.20
     # via requests
 charset-normalizer==3.4.7
     # via requests
-click==8.3.3
+click==8.4.1
     # via
     #   click-log
     #   scriv
@@ -28,7 +28,7 @@ docutils==0.22.4
     # via sphinx
 furo==2025.12.19
     # via -r .docs.in
-idna==3.15
+idna==3.16
     # via requests
 imagesize==2.0.0
     # via sphinx
@@ -51,20 +51,20 @@ pygments==2.20.0
     #   sphinx
 pyyaml==6.0.3
     # via responses
-requests==2.34.1
+requests==2.34.2
     # via
     #   responses
     #   scriv
     #   sphinx
-responses==0.26.0
+responses==0.26.1
     # via -r .docs.in
 roman-numerals==4.1.0
     # via sphinx
 scriv==1.8.0
     # via -r .docs.in
-snowballstemmer==3.0.1
+snowballstemmer==3.1.0
     # via sphinx
-soupsieve==2.8.3
+soupsieve==2.8.4
     # via beautifulsoup4
 sphinx==9.0.4
     # via

requirements/py3.11/test-orjson.txt

@@ -0,0 +1,47 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    tox p -m freezedeps
+#
+certifi==2026.5.20
+    # via requests
+charset-normalizer==3.4.7
+    # via requests
+coverage==7.14.1
+    # via -r .test.in
+execnet==2.1.2
+    # via pytest-xdist
+flaky==3.8.1
+    # via -r .test.in
+idna==3.16
+    # via requests
+iniconfig==2.3.0
+    # via pytest
+orjson==3.11.9
+    # via -r .orjson.in
+packaging==26.2
+    # via pytest
+pluggy==1.6.0
+    # via pytest
+pygments==2.20.0
+    # via pytest
+pytest==9.0.3
+    # via
+    #   -r .test.in
+    #   pytest-randomly
+    #   pytest-xdist
+pytest-randomly==4.1.0
+    # via -r .test.in
+pytest-xdist==3.8.0
+    # via -r .test.in
+pyyaml==6.0.3
+    # via responses
+requests==2.34.2
+    # via responses
+responses==0.26.1
+    # via -r .test.in
+urllib3==2.7.0
+    # via
+    #   requests
+    #   responses

requirements/py3.11/test.txt

@@ -4,17 +4,17 @@
 #
 #    tox p -m freezedeps
 #
-certifi==2026.4.22
+certifi==2026.5.20
     # via requests
 charset-normalizer==3.4.7
     # via requests
-coverage==7.14.0
+coverage==7.14.1
     # via -r .test.in
 execnet==2.1.2
     # via pytest-xdist
 flaky==3.8.1
     # via -r .test.in
-idna==3.15
+idna==3.16
     # via requests
 iniconfig==2.3.0
     # via pytest
@@ -35,9 +35,9 @@ pytest-xdist==3.8.0
     # via -r .test.in
 pyyaml==6.0.3
     # via responses
-requests==2.34.1
+requests==2.34.2
     # via responses
-responses==0.26.0
+responses==0.26.1
     # via -r .test.in
 urllib3==2.7.0
     # via