pytest-httpx

Changed

• Requires httpx==0.28.*

Added

• is_optional parameter is now available on responses and callbacks registration. Allowing to add optional responses while keeping other responses as mandatory. Refer to documentation for more details.
• is_reusable parameter is now available on responses and callbacks registration. Allowing to add multi-match responses while keeping other responses as single-match. Refer to documentation for more details.

Fixed

• httpx_mock.get_request will now also propose to refine filters if more than one request is found instead of only proposing to switch to httpx_mock.get_requests.

Added

• Explicit support for python 3.13.
• should_mock option (callable returning a boolean) is now available, defaulting to always returning True. Refer to documentation for more details.
• Matching on the full multipart body can now be performed using match_files and match_data parameters. Refer to documentation for more details.
• Matching on extensions (including timeout) can now be performed using match_extensions parameter. Refer to documentation for more details.

Removed

• non_mocked_hosts option is not available anymore. Use should_mock instead as in the following sample:

  import pytest
  
  @pytest.mark.httpx_mock(non_mocked_hosts=["my_local_test_host"])
  def test_previous_behavior(httpx_mock):
      ...
  
  @pytest.mark.httpx_mock(should_mock=lambda request: request.url.host not in ["my_local_test_host"])
  def test_new_behavior(httpx_mock):
      ...

  Please note that your hosts might need to be prefixed with www. depending on your usage.

Added

• The following option is now available:
  • can_send_already_matched_responses (boolean), defaulting to False.
• Assertion failure message in case of unmatched responses is now linking documentation on how to deactivate the check.
• Assertion failure message in case of unmatched requests is now linking documentation on how to deactivate the check.
• httpx.TimeoutException message issued in case of unmatched request is now linking documentation on how to reuse responses (in case some responses are already matched).

Fixed

• Documentation now clearly state the risks associated with changing the default options.
• Assertion failure message in case of unmatched requests at teardown is now describing requests in a more user-friendly way.
• Assertion failure message in case of unmatched requests at teardown is now prefixing requests with - to highlight the fact that this is a list, preventing misapprehension in case only one element exists.
• Assertion failure message in case of unmatched responses at teardown is now prefixing responses with - to highlight the fact that this is a list, preventing misapprehension in case only one element exists.
• httpx.TimeoutException message issued in case of unmatched request is now prefixing available responses with - to highlight the fact that this is a list, preventing misapprehension in case only one element exists.
• httpx.TimeoutException message issued in case of unmatched request is now listing unmatched responses (in registration order) before already matched one (still in registration order).
  • The incentive behind this change is to help identify a potential mismatch faster as the first unmatched response is the most likely to be the one expected to match.
• Response description in failure messages (httpx.TimeoutException message issued in case of unmatched request or assertion failure message in case of unmatched responses at teardown) is now displaying if the response was already matched or not and less misleading in it's phrasing about what it can match (a single request by default).

Changed

• Last registered matching response will not be reused by default anymore in case all matching responses have already been sent.
  • This behavior can be changed thanks to the new pytest.mark.httpx_mock(can_send_already_matched_responses=True) option.
  • The incentive behind this change is to spot regression if a request was issued more than the expected number of times.
• HTTPXMock class was only exposed for type hinting purpose. This is now explained in the class docstring.
  • As a result this is the last time a change to __init__ signature will be documented and considered a breaking change.
  • Future changes will not be documented and will be considered as internal refactoring not worth a version bump.
  • __init__ now expects one parameter, the newly introduced (since [0.31.0]) options.
• HTTPXMockOptions class was never intended to be exposed and is now marked as private.

Fixed

• httpx_mock marker can now be defined at different levels for a single test.

Fixed

• It is now possible to match on content provided as async iterable by the client.

Changed

• Tests will now fail at teardown by default if some requests were issued but were not matched.
  • This behavior can be changed thanks to the new pytest.mark.httpx_mock(assert_all_requests_were_expected=False) option.
• The httpx_mock fixture is now configured using a marker (many thanks to Frazer McLean).

  # Apply marker to whole module
  pytestmark = pytest.mark.httpx_mock(assert_all_responses_were_requested=False)
  
  # Or to specific tests
  @pytest.mark.httpx_mock(non_mocked_hosts=[...])
  def test_foo(httpx_mock):
      ...

  • The following options are available:
    • assert_all_responses_were_requested (boolean), defaulting to True.
    • assert_all_requests_were_expected (boolean), defaulting to True.
    • non_mocked_hosts (iterable), defaulting to an empty list, meaning all hosts are mocked.
• httpx_mock.reset do not expect any parameter anymore and will only reset the mock state (no assertions will be performed).

Removed

• pytest 7 is not supported anymore (pytest 8 has been out for 9 months already).
• assert_all_responses_were_requested fixture is not available anymore, use pytest.mark.httpx_mock(assert_all_responses_were_requested=False) instead.
• non_mocked_hosts fixture is not available anymore, use pytest.mark.httpx_mock(non_mocked_hosts=[]) instead.

Changed

• Requires httpx==0.27.*

Fixed

• Switch from setup.py to pyproject.toml (many thanks to Felix Scherz).

Added

• Add support for pytest==8.* (pytest==7.* is still supported for now). (many thanks to Yossi Rozantsev)

Changed

• Requires httpx==0.26.*

Added

• Explicit support for python 3.12.

Fixed

• Custom HTTP transport are now handled (parent call to handle_async_request or handle_request).

Changed

• Only HTTP transport are now mocked, this should not have any impact, however if it does, please feel free to open an issue describing your use case.

Added

• Added proxy_url parameter which allows matching on proxy URL.

Changed

• Requires httpx==0.25.*

Removed

• pytest 6 is no longer supported.

Added

• Added match_json parameter which allows matching on JSON decoded body (matching against python representation instead of bytes).

Changed

• Even if it was never documented as a feature, the match_headers parameter was not considering header names case when matching.
  • As this might have been considered a feature by some users, the fact that match_headers will now respect casing is documented as a breaking change.

Fixed

• Matching on headers does not ignore name case anymore, the name must now be cased as sent (as some servers might expect a specific case).
• Error message in case a request does not match will now include request headers with mismatching name case as well.
• Error message in case a request does not match will now include request headers when not provided as lower-cased to match_headers.
• Add :Any type hint to **matchers function arguments to satisfy strict type checking mode in pyright.

Fixed

• Version 0.23.0 introduced a regression removing the support for mutating json content provided in httpx_mock.add_response.
  • This is fixed, you can now expect the JSON return being as it was when provided to httpx_mock.add_response:

    mutating_json = {"content": "request 1"}
    # This will return {"content": "request 1"}
    httpx_mock.add_response(json=mutating_json)

    mutating_json["content"] = "request 2"
    # This will return {"content": "request 2"}
    httpx_mock.add_response(json=mutating_json)

Removed

• Python 3.7 and 3.8 are no longer supported.

Fixed

• httpx_mock.add_response is now returning a new httpx.Response instance upon each matching request. Preventing unnecessary recursion in streams.

Changed

• Requires httpx==0.24.*

Fixed

• Update version specifiers for pytest dependency to support packaging 23.
• Add explicit support for python 3.11.

Fixed

• URL containing non ASCII characters in query can now be matched.
• Requests are now cleared when calling httpx_mock.reset.

Fixed

• httpx_mock.add_callback now handles async callbacks.

Changed

• Requires httpx==0.23.*

Removed

• Python 3.6 is no longer supported.

Added

• Add support for pytest==7.* (pytest==6.* is still supported for now). (many thanks to Craig Blaszczyk)

Changed

• Requires httpx==0.22.*

Removed

• Python 3.6 is no longer supported.

Fixed

• Callback are now executed as expected when there is a matching already sent response.

Changed

• Registration order is now looking at responses and callbacks. Prior to this version, registration order was looking at responses before callbacks.

Removed

• httpx_mock.add_response data, files and boundary parameters have been removed. It was deprecated since 0.17.0. Refer to this version changelog entry for more details on how to update your code.

Fixed

• A callback can now raise an exception again (regression in mypy check since [0.16.0]).

Added

• An exception can now be raised without creating a callback by using httpx_mock.add_exception method.

Fixed

• Do not consider a callback response as read, even if it is not a stream, before returning to httpx. Allowing any specific httpx handling to be triggered such as httpx.Response.elapsed computing.

Fixed

• Do not consider a response as read, even if it is not a stream, before returning to httpx. Allowing any specific httpx handling to be triggered such as httpx.Response.elapsed computing.

Changed

• httpx_mock.add_response data parameter is only used for multipart content. It was deprecated since 0.14.0. Refer to this version changelog entry for more details on how to update your code.

Removed

• pytest_httpx.to_response function has been removed. It was deprecated since 0.14.0. Refer to this version changelog entry for more details on how to update your code.

Deprecated

• httpx_mock.add_response data, files and boundary parameters that were only used for multipart content. Instead, provide the stream parameter with an instance of the httpx._multipart.MultipartStream.

Fixed

• Responses are no more read or closed when returned to the client. Allowing to add a response once and reading it as a new response on every request.

Changed

• Callbacks are now expected to have a single parameter, the request. The previously second parameter extensions, can still be accessed via request.extensions.

Fixed

• Allow for users to run mypy --strict.

Changed

• Requires httpx==0.21.*

Changed

• Requires httpx==0.20.* (many thanks to Terence Honles)
• Callbacks are now expected to return a httpx.Response instance instead of the previous httpcore.Response tuple. As a consequence, pytest_httpx.to_response now returns a httpx.Response instance.

Added

• httpx_mock.add_response now allows to explicitly provide bytes using content parameter.
• httpx_mock.add_response now allows to explicitly provide string using text parameter.
• httpx_mock.add_response now allows to explicitly provide HTML string content using html parameter.
• httpx_mock.add_response now allows to explicitly provide streamed content using stream parameter and the new pytest_httpx.IteratorStream class.

Deprecated

• pytest_httpx.to_response is now deprecated in favor of httpx.Response. This function will be removed in a future release.
• httpx_mock.add_response data parameter should now only be used for multipart content. Instead, use the appropriate parameter amongst content, text, html or stream.

Changed

• Requires httpx==0.19.*
• files parameter of httpx_mock.add_response now expect dictionary values to be binary (as per httpx new requirement).

Fixed

• Type information is now provided following PEP 561 (many thanks to Caleb Ho).

Changed

• Requires httpx==0.18.*
• ext callback parameter was renamed into extensions.

Changed

• Requires httpx==0.17.*

Fixed

• Order of different parameters does not matters anymore for URL matching. It does however still matter for a same parameter.

Added

• Document how to assert that no requests were issued.
• Document how to send cookies.
• Explicit support for python 3.9

Changed

• Requires httpx==0.16.*
• Update documentation to reflect the latest way of sending bytes using httpx. Via content parameter instead of data.
• Code now follow black==20.8b1 formatting instead of the git master version.
• Sending a JSON response using json parameter will now set the application/json content-type header by default.

Fixed

• Allow to provide any supported httpx headers type in headers parameter for httpx_mock.add_response and pytest_httpx.to_response. Previously only dict was supported.

Changed

• Requires httpx==0.15.*
• Callbacks are now called with ext dictionary instead of timeout. To follow httpcore design changes. You can still retrieve timeout by using ext['timeout']

Added

• non_mocked_hosts fixture allowing to avoid mocking requests sent on some specific hosts.

Changed

• Display the matchers that were not matched instead of the responses that were not sent.

Changed

• The httpx.HTTPError message issued in case no mock could be found is now a httpx.TimeoutException containing all information required to fix the test case (if needed).

Changed

• Requires httpx==0.14.*

Changed

• requires pytest 6.
• assert_and_reset mock method has been renamed to reset and now takes a boolean parameter to specify if assertion should be performed.

Added

• It is now possible to disable the assertion that all registered responses were requested thanks to the assert_all_responses_were_requested fixture. Refer to documentation for more details.

Removed

• It is not possible to provide an URL encoded response anymore by providing a dictionary in data parameter.

Changed

• httpx_mock pytest fixture does not need to be explicitly imported anymore (many thanks to Thomas LÉVEIL).

Changed

• Requires httpx==0.13.*
• requires pytest 5.4.0 (at least)
• callbacks must now return a tuple as per httpcore specifications. Refer to documentation for more details.
• callbacks timeout parameter is now a dict as per httpcore specifications.

Fixed

• Handle the fact that some classes and functions we use are now part of internals within httpx.

Changed

• Requires httpx==0.12.*

Added

• Consider as stable.

Added

• match_headers parameter now allows matching on headers.
• match_content parameter now allows matching on full body.

Changed

• httpx.HTTPError is now raised instead of Exception in case a request cannot be matched.

Changed

• url is not a mandatory parameter for response registration anymore.
• url is not a mandatory parameter for callback registration anymore.
• url is not a mandatory parameter for request retrieval anymore.
• method does not have a default value for response registration anymore.
• method does not have a default value for callback registration anymore.
• method does not have a default value for request retrieval anymore.
• url and methods are not positional arguments anymore.

Added

• Allow to provide JSON response as python values.
• Mock async httpx requests as well.
• Allow to provide files and boundary for multipart response.
• Allow to provide data as a dictionary for multipart response.
• Allow to provide callbacks that are executed upon reception of a request.
• Handle the fact that parameters may be introduced in httpx *Dispatcher.send method.
• Allow to retrieve all matching requests with HTTPXMock.get_requests

Changed

• method can now be provided even if not entirely upper cased.
• content parameter renamed into data.
• HTTPXMock.get_request now fails if more than one request match. Use HTTPXMock.get_request instead.
• HTTPXMock.requests is now private, use HTTPXMock.get_requests instead.
• HTTPXMock.responses is now private, it should not be accessed anyway.
• url can now be a re.Pattern instance.

Added

• Allow to retrieve requests.

Added

• First release, should be considered as unstable for now as design might change.