Skip to content

Commit

Permalink
update changelogs in docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
davidism committed Apr 28, 2023
1 parent 447d4a8 commit a83b56a
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 5 deletions.
5 changes: 4 additions & 1 deletion src/werkzeug/http.py
Original file line number Diff line number Diff line change
Expand Up @@ -1388,9 +1388,12 @@ def dump_cookie(
.. _`cookie`: http://browsercookielimits.squawky.net/
.. versionchanged:: 2.3.1
.. versionchanged:: 2.3.2
The ``path`` parameter is ``/`` by default.
.. versionchanged:: 2.3.1
The value allows more characters without quoting.
.. versionchanged:: 2.3
``localhost`` and other names without a dot are allowed for the domain. A
leading dot is ignored.
Expand Down
6 changes: 2 additions & 4 deletions src/werkzeug/wrappers/request.py
Original file line number Diff line number Diff line change
Expand Up @@ -330,10 +330,8 @@ def stream(self) -> t.IO[bytes]:
Unlike :attr:`input_stream`, this stream guards against infinite streams or
reading past :attr:`content_length` or :attr:`max_content_length`.
If :attr:`max_content_length` is set and the request has a
:attr:`content_length` (is not a streaming request), this will raise
:exc:`.RequestEntityTooLarge` if the max length is exceeded. Otherwise, the
limit will be checked during reads.
If ``max_content_length`` is set, it can be enforced on streams if
``wsgi.input_terminated`` is set. Otherwise, an empty stream is returned.
If the limit is reached before the underlying stream is exhausted (such as a
file that is too large, or an infinite stream), the remaining contents of the
Expand Down
4 changes: 4 additions & 0 deletions src/werkzeug/wsgi.py
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,10 @@ def get_input_stream(
:param max_content_length: The maximum length that content-length or streaming
requests may not exceed.
.. versionchanged:: 2.3.2
``max_content_length`` is only applied to streaming requests if the server sets
``wsgi.input_terminated``.
.. versionchanged:: 2.3
Check ``max_content_length`` and raise an error if it is exceeded.
Expand Down

0 comments on commit a83b56a

Please sign in to comment.