diff options
Diffstat (limited to 'docs/dev/addingviews.html')
| -rw-r--r-- | docs/dev/addingviews.html | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/dev/addingviews.html b/docs/dev/addingviews.html index 12623a31..f6ba645c 100644 --- a/docs/dev/addingviews.html +++ b/docs/dev/addingviews.html @@ -18,22 +18,22 @@ __prompt__, and __content\_types__ and a function named __\_\_call\_\___. Adding a new content viewer to parse a data type is as simple as writing a new View class. Your new content viewer View class should have the same properties as the other View classes: __name__, __prompt__, and __content\_types__ and a -__\_\_call\_\___ function to parse the content of the request/response. +__\_\_call\_\___ function to parse the content of the request/response. -* The __name__ property should be a string describing the contents and new content viewer; +* The __name__ property should be a string describing the contents and new content viewer; * The __prompt__ property should be a two item tuple: - __1__: A string that will be used to display the new content viewer's type; and - - __2__: A one character string that will be the hotkey used to select the new content viewer from the Flow View screen; + - __2__: A one character string that will be the hotkey used to select the new content viewer from the Flow View screen; -* The __content\_types__ property should be a list of strings of HTTP Content\-Types that the new content viewer can parse. +* The __content\_types__ property should be a list of strings of HTTP Content\-Types that the new content viewer can parse. * Note that mitmproxy will use the content\_types to try and heuristically show a friendly view of content and that you can override the built-in views by populating content\_types with values for content\_types that are already parsed -- e.g. "image/png". After defining the __name__, __prompt__, and __content\_types__ properties of the class, you should write the __\_\_call\_\___ function, which will parse the request/response data and provide a friendly view of the data. The __\_\_call\_\___ function should take the following arguments: __self__, -__hdrs__, __content__, __limit__; __hdrs__ is a ODictCaseless object containing +__hdrs__, __content__, __limit__; __hdrs__ is a MultiDict object containing the headers of the request/response; __content__ is the content of the request/response, and __limit__ is an integer representing the amount of data to display in the view window. @@ -46,7 +46,7 @@ Alternatively, you can display content as a series of key-value pairs; to do so, prepare a list of lists, where each list item is a two item list -- a key that describes the data, and then the data itself; after preparing the list of lists, use the __common.format\_keyvals__ function on it to prepare it as text -for display. +for display. If the new content viewer fails or throws an exception, mitmproxy will default to a __raw__ view. |