Grasscutters/mitmproxy
3
0
Fork 0
mirror of https://github.com/Grasscutters/mitmproxy.git synced 2024-11-30 03:14:22 +00:00
Code Issues Projects Releases Wiki Activity

Clean pydoc profile for flow.Flow

Browse Source
This commit is contained in:
Aldo Cortesi 2011-08-04 09:56:44 +12:00
parent 8ef208a9e2
commit 1662b8505b
1 changed files with 44 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
libmproxy/flow.py
View File

@ -786,6 +786,22 @@ class StickyAuthState:
class Flow: class Flow:
"""
A Flow is a collection of objects representing a single HTTP
transaction. The main attributes are:
request: Request object
response: Response object
error: Error object
Note that it's possible for a Flow to have both a response and an error
object. This might happen, for instance, when a response was received
from the server, but there was an error sending it back to the client.
The following additional attributes are exposed:
intercepting: Is this flow currently being intercepted?
"""
def __init__(self, request): def __init__(self, request):
self.request = request self.request = request
self.response, self.error = None, None self.response, self.error = None, None
@ -798,14 +814,6 @@ class Flow:
f._load_state(state) f._load_state(state)
return f return f
@classmethod
def script_deserialize(klass, data):
try:
data = json.loads(data)
except Exception:
return None
return klass._from_state(data)
def _get_state(self, nobackup=False): def _get_state(self, nobackup=False):
d = dict( d = dict(
request = self.request._get_state() if self.request else None, request = self.request._get_state() if self.request else None,
@ -843,6 +851,9 @@ class Flow:
self.error = None self.error = None
def modified(self): def modified(self):
"""
Has this Flow been modified?
"""
# FIXME: Save a serialization in backup, compare current with # FIXME: Save a serialization in backup, compare current with
# backup to detect if flow has _really_ been modified. # backup to detect if flow has _really_ been modified.
if self._backup: if self._backup:
@ -851,23 +862,37 @@ class Flow:
return False return False
def backup(self): def backup(self):
"""
Save a backup of this Flow, which can be reverted to using a
call to .revert().
"""
self._backup = self._get_state(nobackup=True) self._backup = self._get_state(nobackup=True)
def revert(self): def revert(self):
"""
Revert to the last backed up state.
"""
if self._backup: if self._backup:
self._load_state(self._backup) self._load_state(self._backup)
self._backup = None self._backup = None
def match(self, pattern): def match(self, f):
if pattern: """
Match this flow against a compiled filter expression. Returns True
if matched, False if not.
"""
if f:
if self.response: if self.response:
return pattern(self.response) return f(self.response)
elif self.request: elif self.request:
return pattern(self.request) return f(self.request)
else: else:
return True return True
def kill(self, master): def kill(self, master):
"""
Kill this request.
"""
self.error = Error(self.request, "Connection killed") self.error = Error(self.request, "Connection killed")
if self.request and not self.request.acked: if self.request and not self.request.acked:
self.request._ack(None) self.request._ack(None)
@ -877,9 +902,16 @@ class Flow:
self.intercepting = False self.intercepting = False
def intercept(self): def intercept(self):
"""
Intercept this Flow. Processing will stop until accept_intercept is
called.
"""
self.intercepting = True self.intercepting = True
def accept_intercept(self): def accept_intercept(self):
"""
Continue with the flow - called after an intercept().
"""
if self.request: if self.request:
if not self.request.acked: if not self.request.acked:
self.request._ack() self.request._ack()