Skip to content

Commit 0117dd0

Browse files
csernazscsernazs
committed
hooks: rename with_hook to with_post_hook
This is to make it possible to implement with_pre_hook in the future.
1 parent 0d6baf7 commit 0117dd0

5 files changed

Lines changed: 15 additions & 13 deletions

File tree

‎doc/howto.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -654,7 +654,7 @@ Example:
654654
.. literalinclude :: ../tests/examples/test_howto_custom_hooks.py
655655
:language: python
656656
657-
``with_hook`` can be called multiple times, in this case *pytest-httpserver*
657+
``with_post_hook`` can be called multiple times, in this case *pytest-httpserver*
658658
will register the hooks, and hooks will be called sequentially, one by one. Each
659659
hook will receive the response what the previous hook returned, and the last
660660
hook called will return the final response which will be sent back to the client.

‎pytest_httpserver/httpserver.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -531,7 +531,7 @@ def __init__(self, matcher: RequestMatcher):
531531
self.request_handler: Callable[[Request], Response] | None = None
532532
self._hooks: list[Callable[[Request, Response], Response]] = []
533533

534-
def with_hook(self, hook: Callable[[Request, Response], Response]):
534+
def with_post_hook(self, hook: Callable[[Request, Response], Response]):
535535
self._hooks.append(hook)
536536
return self
537537

‎tests/examples/test_howto_custom_hooks.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ def my_hook(_request: Request, response: Response) -> Response:
1212

1313

1414
def test_custom_hook(httpserver: HTTPServer):
15-
httpserver.expect_request("/foo").with_hook(my_hook).respond_with_data(b"OK")
15+
httpserver.expect_request("/foo").with_post_hook(my_hook).respond_with_data(b"OK")
1616

1717
assert requests.get(httpserver.url_for("/foo")).headers["X-Example"] == "Example"

‎tests/examples/test_howto_hooks.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66

77
def test_delay(httpserver: HTTPServer):
88
# this adds 0.5 seconds delay to the server response
9-
httpserver.expect_request("/foo").with_hook(Delay(0.5)).respond_with_json({"example": "foo"})
9+
httpserver.expect_request("/foo").with_post_hook(Delay(0.5)).respond_with_json({"example": "foo"})
1010

1111
assert requests.get(httpserver.url_for("/foo")).json() == {"example": "foo"}

‎tests/test_hooks.py‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,23 +36,25 @@ def hook(_request: Request, response: Response) -> Response:
3636

3737
def test_hook(httpserver: HTTPServer):
3838
my_hook = suffix_hook_factory(b"-SUFFIX")
39-
httpserver.expect_request("/foo").with_hook(my_hook).respond_with_data("OK")
39+
httpserver.expect_request("/foo").with_post_hook(my_hook).respond_with_data("OK")
4040

4141
assert requests.get(httpserver.url_for("/foo")).text == "OK-SUFFIX"
4242

4343

4444
def test_delay_hook(httpserver: HTTPServer):
4545
delay = MyDelay(10)
46-
httpserver.expect_request("/foo").with_hook(delay).respond_with_data("OK")
46+
httpserver.expect_request("/foo").with_post_hook(delay).respond_with_data("OK")
4747
assert requests.get(httpserver.url_for("/foo")).text == "OK"
4848
assert delay.evidence == 10
4949

5050

5151
def test_garbage_hook(httpserver: HTTPServer):
52-
httpserver.expect_request("/prefix").with_hook(Garbage(prefix_size=128)).respond_with_data("OK")
53-
httpserver.expect_request("/suffix").with_hook(Garbage(suffix_size=128)).respond_with_data("OK")
54-
httpserver.expect_request("/both").with_hook(Garbage(prefix_size=128, suffix_size=128)).respond_with_data("OK")
55-
httpserver.expect_request("/large_prefix").with_hook(Garbage(prefix_size=10 * 1024 * 1024)).respond_with_data("OK")
52+
httpserver.expect_request("/prefix").with_post_hook(Garbage(prefix_size=128)).respond_with_data("OK")
53+
httpserver.expect_request("/suffix").with_post_hook(Garbage(suffix_size=128)).respond_with_data("OK")
54+
httpserver.expect_request("/both").with_post_hook(Garbage(prefix_size=128, suffix_size=128)).respond_with_data("OK")
55+
httpserver.expect_request("/large_prefix").with_post_hook(Garbage(prefix_size=10 * 1024 * 1024)).respond_with_data(
56+
"OK"
57+
)
5658

5759
resp_content = requests.get(httpserver.url_for("/prefix")).content
5860
assert len(resp_content) == 130
@@ -79,14 +81,14 @@ def test_garbage_hook(httpserver: HTTPServer):
7981

8082
def test_chain(httpserver: HTTPServer):
8183
delay = MyDelay(10)
82-
httpserver.expect_request("/foo").with_hook(Chain(delay, Garbage(128))).respond_with_data("OK")
84+
httpserver.expect_request("/foo").with_post_hook(Chain(delay, Garbage(128))).respond_with_data("OK")
8385
assert len(requests.get(httpserver.url_for("/foo")).content) == 130
8486
assert delay.evidence == 10
8587

8688

8789
def test_multiple_hooks(httpserver: HTTPServer):
8890
delay = MyDelay(10)
89-
httpserver.expect_request("/foo").with_hook(delay).with_hook(Garbage(128)).respond_with_data("OK")
91+
httpserver.expect_request("/foo").with_post_hook(delay).with_post_hook(Garbage(128)).respond_with_data("OK")
9092
assert len(requests.get(httpserver.url_for("/foo")).content) == 130
9193
assert delay.evidence == 10
9294

@@ -95,6 +97,6 @@ def test_multiple_hooks_correct_order(httpserver: HTTPServer):
9597
hook1 = suffix_hook_factory(b"-S1")
9698
hook2 = suffix_hook_factory(b"-S2")
9799

98-
httpserver.expect_request("/foo").with_hook(hook1).with_hook(hook2).respond_with_data("OK")
100+
httpserver.expect_request("/foo").with_post_hook(hook1).with_post_hook(hook2).respond_with_data("OK")
99101

100102
assert requests.get(httpserver.url_for("/foo")).text == "OK-S1-S2"

0 commit comments

Comments
 (0)