Add HTTPX2 in-process mock support (#3543)

* Add HTTPX2 in-process mock support

``MockVWS`` now intercepts ``httpx2`` requests, synchronous and
asynchronous, alongside ``requests`` and ``httpx``.

``respx`` speaks ``httpx``, whose request, response and exception classes
are distinct from the ``httpx2`` ones, so ``httpx2`` gets a mock path of
its own. That path patches the method which ``httpx2`` clients use to
choose a transport for a request, so requests and responses on it are
native ``httpx2`` objects from end to end, every client is intercepted
whether it was made before or after the mock started, and no process-wide
``httpx2.alias_httpx()`` call is needed.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

* Bring the HTTPX2 paths to full coverage

CI requires 100% coverage, and the asynchronous refuse and pass-through
branches of the HTTPX2 transport were not exercised, nor were the
``(connect, read)`` timeout tuple and the close methods of the test
transports.

Add asynchronous blocking and ``real_http`` tests, close tests for both
test transports, and give the synchronous timeout test a timeout tuple.
Drop the context manager methods of the test transports, which the
``vws-python`` transport protocols do not ask for.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

* Point the stand-in transports at their follow-up issue

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>

Author: adamtheturtle

.github/workflows/test.yml

@@ -130,6 +130,7 @@ jobs:
           - tests/mock_vws/test_target_validators.py
           - tests/mock_vws/test_requests_mock_usage.py
           - tests/mock_vws/test_respx_mock_usage.py
+          - tests/mock_vws/test_httpx2_mock_usage.py
           - tests/mock_vws/test_flask_app_usage.py
           - tests/mock_vws/test_healthcheck.py
           - tests/mock_vws/test_docker.py

README.rst

@@ -11,7 +11,7 @@ Mock for the Vuforia Web Services (VWS) API, the Vuforia Web Query API, and the
 Mocking calls made to Vuforia
 ------------------------------
 
-``MockVWS`` intercepts requests made with `requests`_ or `httpx`_.
+``MockVWS`` intercepts requests made with `requests`_, `httpx`_ or `HTTPX2`_.
 
 .. code-block:: shell
 
@@ -51,10 +51,30 @@ This requires Python |minimum-python-version|\+.
         # This will use the Vuforia mock.
         httpx.get(url="https://vws.vuforia.com/summary", timeout=30)
 
+``MockVWS`` also intercepts `HTTPX2`_ requests, with no need for ``httpx2.alias_httpx()``:
+
+.. code-block:: python
+
+    """Make a request to the Vuforia Web Services API mock using httpx2."""
+
+    import httpx2
+
+    from mock_vws import MockVWS
+    from mock_vws.database import CloudDatabase
+
+    with MockVWS() as mock:
+        database = CloudDatabase()
+        mock.add_cloud_database(cloud_database=database)
+        # This will use the Vuforia mock.
+        httpx2.get(url="https://vws.vuforia.com/summary", timeout=30)
+
+Asynchronous ``httpx`` and `HTTPX2`_ clients are intercepted as well.
+
 By default, an exception will be raised if any requests to unmocked addresses are made.
 
 .. _requests: https://pypi.org/project/requests/
 .. _httpx: https://pypi.org/project/httpx/
+.. _HTTPX2: https://httpx2.pydantic.dev/
 
 Using Docker to mock calls to Vuforia from any language
 -------------------------------------------------------

docs/source/basic-example.rst

@@ -1,4 +1,4 @@
-``MockVWS`` intercepts requests to Vuforia made with `requests`_ or `httpx`_.
+``MockVWS`` intercepts requests to Vuforia made with `requests`_, `httpx`_ or `HTTPX2`_.
 
 .. code-block:: python
 
@@ -47,3 +47,4 @@ See :ref:`mock-api-reference` for details of what can be changed and how.
 
 .. _requests: https://pypi.org/project/requests/
 .. _httpx: https://pypi.org/project/httpx/
+.. _HTTPX2: https://httpx2.pydantic.dev/

docs/source/differences-to-vws.rst

@@ -193,7 +193,7 @@ The Vuforia Cloud Query API documents failure responses with JSON, arbitrary
 content, or no body. Use
 :paramref:`mock_vws.MockVWS.cloud_query_failure_response` to make every Cloud
 Query request return a particular documented failure shape through the
-in-process ``requests`` and ``httpx`` backends::
+in-process ``requests``, ``httpx`` and ``httpx2`` backends::
 
     from mock_vws import CloudQueryFailureResponse, MockVWS
 
@@ -238,8 +238,8 @@ behavior after successful token acquisition::
 
 Omit ``requests`` to affect create, status, download, and delete requests.
 Other phases retain their normal behavior. This configuration works with
-the in-process ``requests`` and ``httpx`` backends and is not supported by the
-Flask/Docker backend.
+the in-process ``requests``, ``httpx`` and ``httpx2`` backends and is not
+supported by the Flask/Docker backend.
 
 Other configurable result codes
 -------------------------------
@@ -446,9 +446,9 @@ For any other request which it does not serve, such as ``DELETE /summary`` or
 and the path of the request.
 The Flask and Docker mock reproduces both response shapes.
 
-The ``requests`` and ``httpx`` backends mock only the paths which the mock
-serves, so a request to any other path raises a connection error rather than
-giving the 404 response which real Vuforia gives.
+The ``requests``, ``httpx`` and ``httpx2`` backends mock only the paths which
+the mock serves, so a request to any other path raises a connection error
+rather than giving the 404 response which real Vuforia gives.
 
 Header cases
 ------------

docs/source/getting-started.rst

@@ -7,3 +7,5 @@ Mocking calls made to Vuforia
 .. include:: basic-example.rst
 
 .. include:: httpx-example.rst
+
+.. include:: httpx2-example.rst

docs/source/httpx2-example.rst

@@ -0,0 +1,20 @@
+``MockVWS`` also intercepts requests made with `HTTPX2`_, with no need for ``httpx2.alias_httpx()``.
+
+.. code-block:: python
+
+   """Make a request to the Vuforia Web Services API mock using httpx2."""
+
+   import httpx2
+
+   from mock_vws import MockVWS
+   from mock_vws.database import CloudDatabase
+
+   with MockVWS() as mock:
+       database = CloudDatabase()
+       mock.add_cloud_database(cloud_database=database)
+       # This will use the Vuforia mock.
+       httpx2.get(url="https://vws.vuforia.com/summary", timeout=30)
+
+Asynchronous ``httpx`` and `HTTPX2`_ clients are intercepted as well.
+
+.. _HTTPX2: https://httpx2.pydantic.dev/

docs/source/index.rst

@@ -14,6 +14,8 @@ This requires Python |minimum-python-version|\+.
 
 .. include:: httpx-example.rst
 
+.. include:: httpx2-example.rst
+
 Using Docker to mock calls to Vuforia from any language
 -------------------------------------------------------
 

newsfragments/3507.change

@@ -0,0 +1 @@
+``MockVWS`` now intercepts ``httpx2`` requests, synchronous and asynchronous, alongside ``requests`` and ``httpx``. The ``httpx2`` path uses native ``httpx2`` requests and responses, and does not need ``httpx2.alias_httpx()``.

pyproject.toml

@@ -37,6 +37,7 @@ dependencies = [
     "beartype>=0.22.9",
     "flask>=3.0.3",
     "httpx>=0.27.0",
+    "httpx2>=2.12",
     "numpy>=2.4.4",
     "opencv-contrib-python-headless>=5.0.0.93",
     "pillow>=12.2.0",

spelling_private_dict.txt

@@ -29,6 +29,7 @@ chunked
 cmyk
 config
 connectionerror
+coroutine
 customizable
 dataclass
 dataclasses
@@ -56,6 +57,7 @@ html
 http
 https
 httpx
+httpx2
 iff
 io
 issuecomment
@@ -106,6 +108,7 @@ reportAttributeAccessIssue
 reportGeneralTypeIssues
 reportMissingTypeStubs
 reportPrivateImportUsage
+reportPrivateUsage
 reportUnknownArgumentType
 reportUnknownMemberType
 reportUnknownVariableType