Skip to content
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.

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

Bump to v2.0.0 #136

Merged
merged 1 commit into from
Jul 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 7 additions & 5 deletions History.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
History
=======

Draft v2.0.0 / Unreleased
v2.0.0 / 2024-07-01
-------------------------

* **Breaking change**: Remove ``Response::body``'s ``binary`` parameter and enforce a keyword argument for ``chunked``
See https://github.com/h2non/pook/issues/128 for a summary of the breaking changes and how to update your code if you are affected.

* **Breaking change**: Remove ``Response::body``'s ``binary`` parameter and enforce a keyword argument for ``chunked``.

* The ``binary`` parameter is no longer needed since responses are now always byte-encoded in all cases (see below).
* A keyword argument is now enforced for ``chunked`` to ensure unnamed arguments meant for the removed ``binary`` parameter cannot be confused as ``chunked`` arguments.

* Only return byte-encoded response bodies, matching the bahviour of all supported client libraries
* Only return byte-encoded response bodies, matching the bahviour of all supported client libraries.

* This is possible because for all supported client libraries, pook mocks the actual response sent to the
client library over the wire, which will, in all cases, be bytes. Client libraries that support reading
Expand All @@ -29,9 +31,9 @@ Draft v2.0.0 / Unreleased
of any interecepted request will always be stored as bytes, and only decoded when necessary for individual downstream
matchers (JSON, XML).

* Correct documentation strings for ``XMLMatcher`` and ``JSONMatcher`` to no longer suggest they can handle regex matchers
* Correct documentation strings for ``XMLMatcher`` and ``JSONMatcher`` to no longer suggest they can handle regex matchers.

* These classes never implemented regex matching
* These classes never implemented regex matching.

* Add a pytest fixture to the package.

Expand Down
2 changes: 1 addition & 1 deletion src/pook/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@
__license__ = "MIT"

# Current version
__version__ = "1.4.3"
__version__ = "2.0.0"
Loading