Merge pull request #2221 from iharsh234/mypy-master-example/simple

Extend mypy example/simple (#2194)

examples/simple/add_header.py

@@ -1,2 +1,5 @@
-def response(flow):
+from mitmproxy import http
+
+
+def response(flow: http.HTTPFlow) -> None:
     flow.response.headers["newheader"] = "foo"

examples/simple/add_header_class.py

@@ -1,5 +1,8 @@
+from mitmproxy import http
+
+
 class AddHeader:
-    def response(self, flow):
+    def response(self, flow: http.HTTPFlow) -> None:
         flow.response.headers["newheader"] = "foo"
 
 

examples/simple/custom_contentview.py

@@ -3,6 +3,7 @@ This example shows how one can add a custom contentview to mitmproxy.
 The content view API is explained in the mitmproxy.contentviews module.
 """
 from mitmproxy import contentviews
+from typing import Tuple, Iterable, AnyStr, List
 
 
 class ViewSwapCase(contentviews.View):
@@ -13,7 +14,7 @@ class ViewSwapCase(contentviews.View):
     prompt = ("swap case text", "z")
     content_types = ["text/plain"]
 
-    def __call__(self, data: bytes, **metadata):
+    def __call__(self, data: bytes, **metadata) -> Tuple[str, Iterable[List[Tuple[str, AnyStr]]]]:
         return "case-swapped text", contentviews.format_text(data.swapcase())
 
 

examples/simple/filter_flows.py

@@ -2,12 +2,12 @@
 This scripts demonstrates how to use mitmproxy's filter pattern in scripts.
 """
 from mitmproxy import flowfilter
-from mitmproxy import ctx
+from mitmproxy import ctx, http
 
 
 class Filter:
     def __init__(self):
-        self.filter = None
+        self.filter = None  # type: flowfilter.TFilter
 
     def configure(self, updated):
         self.filter = flowfilter.parse(ctx.options.flowfilter)
@@ -17,7 +17,7 @@ class Filter:
             "flowfilter", str, "", "Check that flow matches filter."
         )
 
-    def response(self, flow):
+    def response(self, flow: http.HTTPFlow) -> None:
         if flowfilter.match(self.filter, flow):
             print("Flow matches filter:")
             print(flow)

examples/simple/io_read_dumpfile.py

@@ -8,6 +8,7 @@ from mitmproxy.exceptions import FlowReadException
 import pprint
 import sys
 
+
 with open(sys.argv[1], "rb") as logfile:
     freader = io.FlowReader(logfile)
     pp = pprint.PrettyPrinter(indent=4)

examples/simple/io_write_dumpfile.py

@@ -7,18 +7,18 @@ to multiple files in parallel.
 """
 import random
 import sys
-from mitmproxy import io
+from mitmproxy import io, http
 
 
 class Writer:
-    def __init__(self, path):
+    def __init__(self, path: str) -> None:
         if path == "-":
-            f = sys.stdout
+            f = sys.stdout  # type: io.TextIO
         else:
             f = open(path, "wb")
         self.w = io.FlowWriter(f)
 
-    def response(self, flow):
+    def response(self, flow: http.HTTPFlow) -> None:
         if random.choice([True, False]):
             self.w.add(flow)
 

examples/simple/modify_body_inject_iframe.py

@@ -1,6 +1,6 @@
 # (this script works best with --anticache)
 from bs4 import BeautifulSoup
-from mitmproxy import ctx
+from mitmproxy import ctx, http
 
 
 class Injector:
@@ -9,7 +9,7 @@ class Injector:
             "iframe", str, "", "IFrame to inject"
         )
 
-    def response(self, flow):
+    def response(self, flow: http.HTTPFlow) -> None:
         if ctx.options.iframe:
             html = BeautifulSoup(flow.response.content, "html.parser")
             if html.body:

examples/simple/modify_form.py

@@ -1,4 +1,7 @@
-def request(flow):
+from mitmproxy import http
+
+
+def request(flow: http.HTTPFlow) -> None:
     if flow.request.urlencoded_form:
         # If there's already a form, one can just add items to the dict:
         flow.request.urlencoded_form["mitmproxy"] = "rocks"

examples/simple/modify_querystring.py

@@ -1,2 +1,5 @@
-def request(flow):
+from mitmproxy import http
+
+
+def request(flow: http.HTTPFlow) -> None:
     flow.request.query["mitmproxy"] = "rocks"

examples/simple/redirect_requests.py

@@ -1,9 +1,10 @@
 """
 This example shows two ways to redirect flows to another server.
 """
+from mitmproxy import http
 
 
-def request(flow):
+def request(flow: http.HTTPFlow) -> None:
     # pretty_host takes the "Host" header of the request into account,
     # which is useful in transparent mode where we usually only have the IP
     # otherwise.

examples/simple/send_reply_from_proxy.py

@@ -5,7 +5,7 @@ without sending any data to the remote server.
 from mitmproxy import http
 
 
-def request(flow):
+def request(flow: http.HTTPFlow) -> None:
     # pretty_url takes the "Host" header of the request into account, which
     # is useful in transparent mode where we usually only have the IP otherwise.
 

examples/simple/upsidedownternet.py

@@ -2,11 +2,11 @@
 This script rotates all images passing through the proxy by 180 degrees.
 """
 import io
-
 from PIL import Image
+from mitmproxy import http
 
 
-def response(flow):
+def response(flow: http.HTTPFlow) -> None:
     if flow.response.headers.get("content-type", "").startswith("image"):
         s = io.BytesIO(flow.response.content)
         img = Image.open(s).rotate(180)

examples/simple/wsgi_flask_app.py

@@ -10,7 +10,7 @@ app = Flask("proxapp")
 
 
 @app.route('/')
-def hello_world():
+def hello_world() -> str:
     return 'Hello World!'