mitmproxy/docs/scripting/api.rst

.. _api:


API
===

- Errors
    - `mitmproxy.flow.Error <#mitmproxy.flow.Error>`_
- HTTP
    - `mitmproxy.http.HTTPRequest <#mitmproxy.http.HTTPRequest>`_
    - `mitmproxy.http.HTTPResponse <#mitmproxy.http.HTTPResponse>`_
    - `mitmproxy.http.HTTPFlow <#mitmproxy.http.HTTPFlow>`_
- Logging
    - `mitmproxy.log.Log <#mitmproxy.controller.Log>`_
    - `mitmproxy.log.LogEntry <#mitmproxy.controller.LogEntry>`_


Errors
------

.. autoclass:: mitmproxy.flow.Error
    :inherited-members:

HTTP
----

.. autoclass:: mitmproxy.http.HTTPRequest
    :inherited-members:

.. autoclass:: mitmproxy.http.HTTPResponse
    :inherited-members:

.. autoclass:: mitmproxy.http.HTTPFlow
    :inherited-members:

Logging
--------

.. autoclass:: mitmproxy.log.Log
    :inherited-members:
.. autoclass:: mitmproxy.log.LogEntry
    :inherited-members:
docs: cleanups improvements and fighting sphinx - Hide links to internal code listings, and link to github instead - Improve formatting of code/example captions - Fix outdated documentation of command-line options - Complete documentation of all events + improved formatting - tcp_open -> tcp_start, tcp_close -> tcp_end to reduce confusion 2016-10-11 21:57:05 +00:00			`.. _api:`

docs: improve external source links, tweak code docs 2016-10-13 23:18:56 +00:00
docs: cleanups improvements and fighting sphinx - Hide links to internal code listings, and link to github instead - Improve formatting of code/example captions - Fix outdated documentation of command-line options - Complete documentation of all events + improved formatting - tcp_open -> tcp_start, tcp_close -> tcp_end to reduce confusion 2016-10-11 21:57:05 +00:00			`API`
docs: improve external source links, tweak code docs 2016-10-13 23:18:56 +00:00			`===`

docs: logging and the context 2016-10-15 23:03:57 +00:00			`- Errors`
Move all tools into mitmproxy.tools, move models/* to top level The primary motivation here (and for all the other moving around) is to present a clean "front of house" to library users, and to migrate primary objects to the top of the module hierarchy. 2016-10-19 02:25:39 +00:00			- `mitmproxy.flow.Error <#mitmproxy.flow.Error>`_
docs: improve external source links, tweak code docs 2016-10-13 23:18:56 +00:00			`- HTTP`
Move all tools into mitmproxy.tools, move models/* to top level The primary motivation here (and for all the other moving around) is to present a clean "front of house" to library users, and to migrate primary objects to the top of the module hierarchy. 2016-10-19 02:25:39 +00:00			- `mitmproxy.http.HTTPRequest <#mitmproxy.http.HTTPRequest>`_
			- `mitmproxy.http.HTTPResponse <#mitmproxy.http.HTTPResponse>`_
			- `mitmproxy.http.HTTPFlow <#mitmproxy.http.HTTPFlow>`_
docs: logging and the context 2016-10-15 23:03:57 +00:00			`- Logging`
addons.Addons -> addonmanager, builtins -> addons 2016-10-19 01:25:11 +00:00			- `mitmproxy.log.Log <#mitmproxy.controller.Log>`_
			- `mitmproxy.log.LogEntry <#mitmproxy.controller.LogEntry>`_
docs: logging and the context 2016-10-15 23:03:57 +00:00

			`Errors`
			`------`

Move all tools into mitmproxy.tools, move models/* to top level The primary motivation here (and for all the other moving around) is to present a clean "front of house" to library users, and to migrate primary objects to the top of the module hierarchy. 2016-10-19 02:25:39 +00:00			`.. autoclass:: mitmproxy.flow.Error`
docs: logging and the context 2016-10-15 23:03:57 +00:00			`:inherited-members:`
docs: improve external source links, tweak code docs 2016-10-13 23:18:56 +00:00
			`HTTP`
			`----`

Move all tools into mitmproxy.tools, move models/* to top level The primary motivation here (and for all the other moving around) is to present a clean "front of house" to library users, and to migrate primary objects to the top of the module hierarchy. 2016-10-19 02:25:39 +00:00			`.. autoclass:: mitmproxy.http.HTTPRequest`
docs: improve external source links, tweak code docs 2016-10-13 23:18:56 +00:00			`:inherited-members:`

Move all tools into mitmproxy.tools, move models/* to top level The primary motivation here (and for all the other moving around) is to present a clean "front of house" to library users, and to migrate primary objects to the top of the module hierarchy. 2016-10-19 02:25:39 +00:00			`.. autoclass:: mitmproxy.http.HTTPResponse`
docs: improve external source links, tweak code docs 2016-10-13 23:18:56 +00:00			`:inherited-members:`
docs: cleanups improvements and fighting sphinx - Hide links to internal code listings, and link to github instead - Improve formatting of code/example captions - Fix outdated documentation of command-line options - Complete documentation of all events + improved formatting - tcp_open -> tcp_start, tcp_close -> tcp_end to reduce confusion 2016-10-11 21:57:05 +00:00
Move all tools into mitmproxy.tools, move models/* to top level The primary motivation here (and for all the other moving around) is to present a clean "front of house" to library users, and to migrate primary objects to the top of the module hierarchy. 2016-10-19 02:25:39 +00:00			`.. autoclass:: mitmproxy.http.HTTPFlow`
docs: cleanups improvements and fighting sphinx - Hide links to internal code listings, and link to github instead - Improve formatting of code/example captions - Fix outdated documentation of command-line options - Complete documentation of all events + improved formatting - tcp_open -> tcp_start, tcp_close -> tcp_end to reduce confusion 2016-10-11 21:57:05 +00:00			`:inherited-members:`
docs: overview, classes, arguments 2016-10-15 22:12:58 +00:00
docs: logging and the context 2016-10-15 23:03:57 +00:00			`Logging`
			`--------`
docs: overview, classes, arguments 2016-10-15 22:12:58 +00:00
addons.Addons -> addonmanager, builtins -> addons 2016-10-19 01:25:11 +00:00			`.. autoclass:: mitmproxy.log.Log`
			`:inherited-members:`
			`.. autoclass:: mitmproxy.log.LogEntry`
docs: overview, classes, arguments 2016-10-15 22:12:58 +00:00			`:inherited-members:`