vee1e/mitmproxy
1
0
Fork 0
mirror of https://github.com/vee1e/mitmproxy.git synced 2026-09-03 19:27:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

improve .stream docs

Browse source
This commit is contained in:
Maximilian Hils 2021-08-02 14:01:34 +02:00
parent c7e8b82420
commit df797cd1b0
1 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
mitmproxy/http.py
View file

@ -252,10 +252,14 @@ class Message(serializable.Serializable):
data: MessageData
stream: Union[Callable[[bytes], Union[Iterable[bytes], bytes]], bool] = False
"""
This attribute controls if the message body should be streamed.
If `False`, mitmproxy will buffer the entire body before forwarding it to the destination.
This makes it possible to perform string replacements on the entire body.
If `True`, the message body will not be buffered on the proxy
but immediately streamed to the destination instead.
Alternatively, a transformation function can be specified, but please note
that packet should not be relied upon.
but immediately forwarded instead.
Alternatively, a transformation function can be specified, which will be called for each chunk of data.
Please note that packet boundaries generally should not be relied upon.
This attribute must be set in the `requestheaders` or `responseheaders` hook.
Setting it in `request` or `response` is already too late, mitmproxy has buffered the message body already.