Docs and examples to top level

1 files changed, 20 insertions, 0 deletions

diff --git a/examples/stream_modify.py b/examples/stream_modify.py
new file mode 100644
index 00000000..aa395c03
--- /dev/null
+++ b/examples/stream_modify.py
@@ -0,0 +1,20 @@
+"""
+This inline script modifies a streamed response.
+If you do not need streaming, see the modify_response_body example.
+Be aware that content replacement isn't trivial:
+    - If the transfer encoding isn't chunked, you cannot simply change the content length.
+    - If you want to replace all occurences of "foobar", make sure to catch the cases
+      where one chunk ends with [...]foo" and the next starts with "bar[...].
+"""
+
+
+def modify(chunks):
+    """
+    chunks is a generator that can be used to iterate over all chunks.
+    """
+    for chunk in chunks:
+        yield chunk.replace("foo", "bar")
+
+
+def responseheaders(context, flow):
+    flow.response.stream = modify