Move globus_sdk._testing to globus_sdk.testing

changelog.d/20250710_115829_max.tuecke_sc_26339_rename_testing.rst

@@ -0,0 +1,4 @@
+Changed
+-------
+
+- Renamed the ``globus_sdk._testing`` subpackage to ``globus_sdk.testing``. (:pr:`1251`)

docs/testing/getting_started.rst

@@ -3,15 +3,15 @@
     This component is an *alpha*. Interfaces may change outside of the
     normal semver policy.
 
-Getting Started with _testing
-=============================
+Getting Started with testing
+============================
 
 Dependencies
 ------------
 
 This toolchain requires the ``responses`` library.
 
-``globus_sdk._testing`` is tested to operate with the latest version of
+``globus_sdk.testing`` is tested to operate with the latest version of
 ``responses``.
 
 Recommended Fixtures
@@ -41,7 +41,7 @@ activated by name:
 
 .. code-block:: python
 
-    from globus_sdk._testing import load_response
+    from globus_sdk.testing import load_response
 
     # load_response will add the response to `responses` and return it
     load_response("auth.get_identities")
@@ -54,7 +54,7 @@ unbound, as in:
 .. code-block:: python
 
     import globus_sdk
-    from globus_sdk._testing import load_response
+    from globus_sdk.testing import load_response
 
     load_response(globus_sdk.AuthClient.get_identities)
     load_response(globus_sdk.AuthClient.get_identities, case="unauthorized")
@@ -71,7 +71,7 @@ load all of them at once:
 
 .. code-block:: python
 
-    from globus_sdk._testing import load_response_set
+    from globus_sdk.testing import load_response_set
 
     fixtures = load_response_set("scenario.foo")
 
@@ -86,7 +86,7 @@ response is ``"default"``.
 .. code-block:: python
 
     from globus_sdk import AuthClient
-    from globus_sdk._testing import get_response_set
+    from globus_sdk.testing import get_response_set
 
     # rset will not be activated
     rset = get_response_set(AuthClient.get_identities)
@@ -110,7 +110,7 @@ override the builtin response sets, if names match.
 
 .. code-block:: python
 
-    from globus_sdk._testing import load_response_set, register_response_set
+    from globus_sdk.testing import load_response_set, register_response_set
     import uuid
 
     # register a scenario under which Globus Auth get_identities and Globus
@@ -152,7 +152,7 @@ Loading Responses without Registering
 
 Because ``RegisteredResponse`` takes care of resolving ``"auth"`` to the Auth
 URL, ``"transfer"`` to the Transfer URL, and so forth, you might want to use
-``globus_sdk._testing`` in lieu of ``responses`` even when registering single
+``globus_sdk.testing`` in lieu of ``responses`` even when registering single
 responses for individual tests.
 
 To support this mode of usage, ``load_response`` can take a
@@ -165,7 +165,7 @@ Consider the following example of a parametrized test which uses
 
 .. code-block:: python
 
-    from globus_sdk._testing import load_response, RegisteredResponse
+    from globus_sdk.testing import load_response, RegisteredResponse
     import pytest
 
 
@@ -191,7 +191,7 @@ outside of the specific test.
 Using non-default responses.RequestsMock objects
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-By default, all methods in ``globus_sdk._testing`` which converse with
+By default, all methods in ``globus_sdk.testing`` which converse with
 ``responses`` use the default mock. This is the behavior offered by
 ``responses.add(...)`` and similar methods.
 
@@ -208,7 +208,7 @@ e.g.
 
 .. code-block:: python
 
-    from globus_sdk._testing import get_last_request
+    from globus_sdk.testing import get_last_request
     import responses
 
     custom_mock = responses.RequestsMock(...)

docs/testing/index.rst

@@ -3,14 +3,14 @@
     This component is an *alpha*. Interfaces may change outside of the
     normal semver policy.
 
-.. _testing_root:
+.. testing_root:
 
-Globus SDK _testing
-===================
+Globus SDK testing
+==================
 
 .. warning::
 
-    The exact data and payloads provided via ``_testing`` are a best
+    The exact data and payloads provided via ``testing`` are a best
     approximation of API responses. They may change in any SDK release to be
     more accurate.
 

docs/testing/methods/auth.rst

@@ -1,4 +1,4 @@
-Globus Auth _testing Method List
-================================
+Globus Auth testing Method List
+===============================
 
 .. enumeratetestingfixtures:: globus_sdk.AuthClient

docs/testing/methods/flows.rst

@@ -1,5 +1,5 @@
-Globus Flows _testing Method List
-=================================
+Globus Flows testing Method List
+================================
 
 .. enumeratetestingfixtures:: globus_sdk.FlowsClient
 

docs/testing/methods/gcs.rst

@@ -1,4 +1,4 @@
-Globus Connect Server _testing Method List
-==========================================
+Globus Connect Server testing Method List
+=========================================
 
 .. enumeratetestingfixtures:: globus_sdk.GCSClient

docs/testing/methods/groups.rst

@@ -1,4 +1,4 @@
-Globus Groups _testing Method List
-==================================
+Globus Groups testing Method List
+=================================
 
 .. enumeratetestingfixtures:: globus_sdk.GroupsClient

docs/testing/methods/index.rst

@@ -3,10 +3,10 @@
     This component is an *alpha*. Interfaces may change outside of the
     normal semver policy.
 
-_testing Method List
-====================
+testing Method List
+===================
 
-These pages list all methods which have ``globus_sdk._testing`` response data,
+These pages list all methods which have ``globus_sdk.testing`` response data,
 and the casenames for those data.
 
 .. toctree::

docs/testing/methods/search.rst

@@ -1,4 +1,4 @@
-Globus Search _testing Method List
-==================================
+Globus Search testing Method List
+=================================
 
 .. enumeratetestingfixtures:: globus_sdk.SearchClient

docs/testing/methods/timers.rst

@@ -1,4 +1,4 @@
-Globus Timers _testing Method List
-==================================
+Globus Timers testing Method List
+=================================
 
 .. enumeratetestingfixtures:: globus_sdk.TimersClient

docs/testing/methods/transfer.rst

@@ -1,4 +1,4 @@
-Globus Transfer _testing Method List
-====================================
+Globus Transfer testing Method List
+===================================
 
 .. enumeratetestingfixtures:: globus_sdk.TransferClient

docs/testing/reference.rst

@@ -3,10 +3,10 @@
     This component is an *alpha*. Interfaces may change outside of the
     normal semver policy.
 
-_testing Reference
-==================
+testing Reference
+=================
 
-.. module:: globus_sdk._testing
+.. module:: globus_sdk.testing
 
 Functions
 ---------

pyproject.toml

@@ -79,7 +79,7 @@ typing = [
     "types-requests",
     "typing-extensions>=4.0",
     # although 'responses' is provided by the test requirements, it also
-    # must be installed for proper type-checking on globus_sdk._testing
+    # must be installed for proper type-checking on globus_sdk.testing
     "responses",
     # similarly, sphinx is needed to type-check our sphinx extension
     "sphinx",
@@ -120,7 +120,7 @@ source = ["globus_sdk"]
 # omit must be specified in a way which matches the
 # tox environment installations, so lead with `**`
 omit = [
-    "**/globus_sdk/_testing/*",
+    "**/globus_sdk/testing/*",
 ]
 
 [tool.coverage.paths]

scripts/ensure_exports_are_documented.py

@@ -20,7 +20,7 @@
     "globus_sdk/globus_app/",
     "globus_sdk/scopes/",
     "globus_sdk/response.py",
-    "globus_sdk/_testing/",
+    "globus_sdk/testing/",
 )
 
 DEPRECATED_NAMES = {

src/globus_sdk/_sphinxext/directives/enumerate_testing_fixtures.py

@@ -17,7 +17,7 @@ class EnumerateTestingFixtures(AddContentDirective):
     }
 
     def gen_rst(self) -> t.Iterator[str]:
-        from globus_sdk._testing import get_response_set
+        from globus_sdk.testing import get_response_set
 
         underline_char = self.options.get("header_underline_char", "-")
 
@@ -46,7 +46,7 @@ def gen_rst(self) -> t.Iterator[str]:
             for casename in rset.cases():
                 # use "attr" rather than "meth" so that sphinx does not add parens
                 # the use of the method as an attribute of the class or instance better
-                # matches how `_testing` handles things
+                # matches how `testing` handles things
                 yield (
                     ".. dropdown:: "
                     f':py:attr:`~{classname}.{methodname}` (``case="{casename}"``)'

src/globus_sdk/_sphinxext/directives/expand_testing_fixture.py

@@ -3,7 +3,7 @@
 
 from docutils.parsers.rst import directives
 
-from globus_sdk._testing import ResponseList
+from globus_sdk.testing import ResponseList
 
 from .add_content_directive import AddContentDirective
 
@@ -17,7 +17,7 @@ class ExpandTestingFixture(AddContentDirective):
     }
 
     def gen_rst(self) -> t.Iterator[str]:
-        from globus_sdk._testing import get_response_set
+        from globus_sdk.testing import get_response_set
 
         response_set_name = self.arguments[0]
         casename = "default"

src/globus_sdk/_testing/data/auth/create_child_client.py → src/globus_sdk/testing/data/auth/create_child_client.py

@@ -3,7 +3,7 @@
 
 from responses.matchers import json_params_matcher
 
-from globus_sdk._testing.models import RegisteredResponse, ResponseSet
+from globus_sdk.testing.models import RegisteredResponse, ResponseSet
 
 _COMMON_RESPONSE_RECORD = {
     "fqdns": [],

src/globus_sdk/_testing/data/auth/create_client.py → src/globus_sdk/testing/data/auth/create_client.py

@@ -3,7 +3,7 @@
 
 from responses.matchers import json_params_matcher
 
-from globus_sdk._testing.models import RegisteredResponse, ResponseSet
+from globus_sdk.testing.models import RegisteredResponse, ResponseSet
 
 _COMMON_RESPONSE_RECORD = {
     "fqdns": [],

src/globus_sdk/_testing/data/auth/create_client_credential.py → src/globus_sdk/testing/data/auth/create_client_credential.py

@@ -1,6 +1,6 @@
 import uuid
 
-from globus_sdk._testing.models import RegisteredResponse, ResponseSet
+from globus_sdk.testing.models import RegisteredResponse, ResponseSet
 
 NEW_CREDENTIAL_NAME = str(uuid.uuid4()).replace("-", "")
 

src/globus_sdk/_testing/data/auth/create_native_app_instance.py → src/globus_sdk/testing/data/auth/create_native_app_instance.py

@@ -3,7 +3,7 @@
 
 from responses.matchers import json_params_matcher
 
-from globus_sdk._testing.models import RegisteredResponse, ResponseSet
+from globus_sdk.testing.models import RegisteredResponse, ResponseSet
 
 APP_REQUEST_ARGS = {
     "template_id": str(uuid.uuid1()),

src/globus_sdk/_testing/data/auth/create_policy.py → src/globus_sdk/testing/data/auth/create_policy.py

@@ -3,7 +3,7 @@
 
 from responses.matchers import json_params_matcher
 
-from globus_sdk._testing.models import RegisteredResponse, ResponseSet
+from globus_sdk.testing.models import RegisteredResponse, ResponseSet
 
 POLICY_REQUEST_ARGS = {
     "project_id": str(uuid.uuid1()),

src/globus_sdk/_testing/data/auth/create_project.py → src/globus_sdk/testing/data/auth/create_project.py

@@ -1,6 +1,6 @@
 import uuid
 
-from globus_sdk._testing.models import RegisteredResponse, ResponseSet
+from globus_sdk.testing.models import RegisteredResponse, ResponseSet
 
 project_id = str(uuid.uuid1())
 star_lord = {

src/globus_sdk/_testing/data/auth/create_scope.py → src/globus_sdk/testing/data/auth/create_scope.py

@@ -4,7 +4,7 @@
 from responses.matchers import json_params_matcher
 
 from globus_sdk import DependentScopeSpec
-from globus_sdk._testing.models import RegisteredResponse, ResponseSet
+from globus_sdk.testing.models import RegisteredResponse, ResponseSet
 
 SCOPE_REQUEST_ARGS = {
     "client_id": str(uuid.uuid1()),

src/globus_sdk/_testing/data/auth/delete_client.py → src/globus_sdk/testing/data/auth/delete_client.py

@@ -1,6 +1,6 @@
 import uuid
 
-from globus_sdk._testing.models import RegisteredResponse, ResponseSet
+from globus_sdk.testing.models import RegisteredResponse, ResponseSet
 
 CLIENT = {
     "required_idp": None,

src/globus_sdk/_testing/data/auth/delete_client_credential.py → src/globus_sdk/testing/data/auth/delete_client_credential.py

@@ -1,6 +1,6 @@
 import uuid
 
-from globus_sdk._testing.models import RegisteredResponse, ResponseSet
+from globus_sdk.testing.models import RegisteredResponse, ResponseSet
 
 CREDENTIAL = {
     "name": "foo",

src/globus_sdk/_testing/data/auth/delete_policy.py → src/globus_sdk/testing/data/auth/delete_policy.py

@@ -1,6 +1,6 @@
 import uuid
 
-from globus_sdk._testing.models import RegisteredResponse, ResponseSet
+from globus_sdk.testing.models import RegisteredResponse, ResponseSet
 
 POLICY = {
     "high_assurance": False,

src/globus_sdk/_testing/data/auth/delete_project.py → src/globus_sdk/testing/data/auth/delete_project.py

@@ -1,6 +1,6 @@
 import uuid
 
-from globus_sdk._testing.models import RegisteredResponse, ResponseSet
+from globus_sdk.testing.models import RegisteredResponse, ResponseSet
 
 project_id = str(uuid.uuid1())
 star_lord = {

src/globus_sdk/_testing/data/auth/delete_scope.py → src/globus_sdk/testing/data/auth/delete_scope.py

@@ -1,6 +1,6 @@
 import uuid
 
-from globus_sdk._testing.models import RegisteredResponse, ResponseSet
+from globus_sdk.testing.models import RegisteredResponse, ResponseSet
 
 SCOPE = {
     "scope_string": "https://auth.globus.org/scopes/3f33d83f-ec0a-4190-887d-0622e7c4ee9a/manager",  # noqa: E501

src/globus_sdk/_testing/data/auth/get_client.py → src/globus_sdk/testing/data/auth/get_client.py

@@ -1,6 +1,6 @@
 import uuid
 
-from globus_sdk._testing.models import RegisteredResponse, ResponseSet
+from globus_sdk.testing.models import RegisteredResponse, ResponseSet
 
 FQDN = "globus.org"
 

src/globus_sdk/_testing/data/auth/get_client_credentials.py → src/globus_sdk/testing/data/auth/get_client_credentials.py

@@ -1,6 +1,6 @@
 import uuid
 
-from globus_sdk._testing.models import RegisteredResponse, ResponseSet
+from globus_sdk.testing.models import RegisteredResponse, ResponseSet
 
 CREDENTIAL = {
     "name": "foo",

src/globus_sdk/_testing/data/auth/get_clients.py → src/globus_sdk/testing/data/auth/get_clients.py

@@ -1,6 +1,6 @@
 import uuid
 
-from globus_sdk._testing.models import RegisteredResponse, ResponseSet
+from globus_sdk.testing.models import RegisteredResponse, ResponseSet
 
 FOO_CLIENT = {
     "required_idp": None,

src/globus_sdk/_testing/data/auth/get_consents.py → src/globus_sdk/testing/data/auth/get_consents.py

@@ -1,4 +1,4 @@
-from globus_sdk._testing.models import RegisteredResponse, ResponseSet
+from globus_sdk.testing.models import RegisteredResponse, ResponseSet
 
 _DATA_ACCESS = (
     "https://auth.globus.org/scopes/542a86fc-1766-450d-841f-065488a2ec01/data_access"