Skip to content

Distinguish JSON booleans from numbers in request matching #842

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
galafis wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Distinguish JSON booleans from numbers in request matching #842

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGES
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Unreleased
----------

* Fixed ``json_params_matcher`` treating JSON booleans as equal to the numbers
0 and 1, including inside nested objects and arrays.
* Fixed ``fragment_identifier_matcher`` ignoring blank-valued fragment
parameters, which allowed missing or different parameters to match.
* Added Python 3.14 support (classifiers, tox envlist, and CI test matrix). See #810
Expand Down
20 changes: 19 additions & 1 deletion responses/matchers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,20 @@ def _filter_dict_recursively(
return filtered_dict


def _json_values_equal(expected: Any, actual: Any) -> bool:
if isinstance(expected, bool) or isinstance(actual, bool):
return type(expected) is type(actual) and expected == actual
if isinstance(expected, dict) and isinstance(actual, dict):
return expected.keys() == actual.keys() and all(
_json_values_equal(value, actual[key]) for key, value in expected.items()

@Pavel-Shcherbo Pavel-Shcherbo Nov 5, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The recursive helper reduces the nesting depth accepted by strict matching. With the default recursion limit of 1000, a roughly 7 KB payload nested 600 levels is serialized and parsed successfully, and matches on base e68019c. On this head it raises RecursionError instead of matching, including through RequestsMock. Reproduced on CPython 3.14.6 / requests 2.34.2:

import requests
import responses
from responses import matchers

payload = {"enabled": True}
for _ in range(600):
    payload = {"nested": payload}

with responses.RequestsMock(assert_all_requests_are_fired=False) as mock:
    mock.post(
        "https://example.invalid/check",
        json={"ok": True},
        match=[matchers.json_params_matcher(payload, strict_match=True)],
    )
    assert requests.post("https://example.invalid/check", json=payload).status_code == 200

An explicit stack of pending value pairs would preserve the boolean/number distinction without consuming two Python frames per nested mapping. Could this case be retained as a regression control?

)
if isinstance(expected, list) and isinstance(actual, list):
return len(expected) == len(actual) and all(
_json_values_equal(left, right) for left, right in zip(expected, actual)
)
return expected == actual


def body_matcher(params: str, *, allow_blank: bool = False) -> Callable[..., Any]:
def match(request: PreparedRequest) -> Tuple[bool, str]:
reason = ""
Expand Down Expand Up @@ -152,7 +166,11 @@ def match(request: PreparedRequest) -> Tuple[bool, str]:
# filter down to just the params specified in the matcher
json_body = _filter_dict_recursively(json_body, json_params)

valid = params is None if request_body is None else json_params == json_body
valid = (
params is None
if request_body is None
else _json_values_equal(json_params, json_body)
)

if not valid:
reason = f"request.body doesn't match: {json_body} doesn't match {json_params}"
Expand Down
35 changes: 35 additions & 0 deletions responses/tests/test_matchers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,41 @@
from responses.tests.test_responses import assert_response


@pytest.mark.parametrize("strict_match", [False, True])
@pytest.mark.parametrize(
"expected, actual",
[
({"enabled": True}, {"enabled": 1}),
({"enabled": 1}, {"enabled": True}),
({"enabled": False}, {"enabled": 0}),
({"enabled": 0}, {"enabled": False}),
([True], [1]),
({"nested": [{"enabled": False}]}, {"nested": [{"enabled": 0.0}]}),
],
)
def test_json_boolean_number_mismatch(expected, actual, strict_match): # type: ignore[misc]
request = requests.Request("POST", "http://example.com", json=actual).prepare()
matched, reason = matchers.json_params_matcher(expected, strict_match=strict_match)(
request
)
assert not matched
assert "request.body doesn't match" in reason


@pytest.mark.parametrize("value", [1, 1.0, True, False])
def test_json_scalar_equality(value): # type: ignore[misc]
expected = {"value": value}
request = requests.Request("POST", "http://example.com", json=expected).prepare()
assert matchers.json_params_matcher(expected)(request) == (True, "")


def test_json_params_matcher_preserves_numeric_equality():
request = requests.Request(
"POST", "http://example.com", json={"value": [1.0]}
).prepare()
assert matchers.json_params_matcher({"value": [1]})(request) == (True, "")


def test_body_match_get():
@responses.activate
def run():
Expand Down