updated docstrings for easier formatting on things like RTDs

Author: AutomatedTester

browsermobproxy/client.py

@@ -6,8 +6,9 @@ class Client(object):
     def __init__(self, url):
         """
         Initialises a new Client object
-        :Args:
-        - url: This is where the BrowserMob Proxy lives
+
+        url: str
+             This is where the BrowserMob Proxy lives
         """
         self.host = "http://" + url
         resp = requests.post('%s/proxy' % self.host, urlencode(''))
@@ -66,13 +67,15 @@ def har(self):
     def new_har(self, ref=None, options={}):
         """
         This sets a new HAR to be recorded
-        :Args:
-        - ref: A reference for the HAR. Defaults to None
-        - options: A dictionary that will be passed to BrowserMob Proxy \
+
+        - ref: unicode
+               A reference for the HAR. Defaults to None
+        - options: dict
+                   A dictionary that will be passed to BrowserMob Proxy \
                    with specific keywords. Keywords are: \
-                    captureHeaders - Boolean, capture headers \
-                    captureContent - Boolean, capture content bodies \
-                    captureBinaryContent - Boolean, capture binary content
+                   captureHeaders - Boolean, capture headers \
+                   captureContent - Boolean, capture content bodies \
+                   captureBinaryContent - Boolean, capture binary content
         """
         if ref:
             payload = {"initialPageRef": ref}
@@ -90,8 +93,9 @@ def new_har(self, ref=None, options={}):
     def new_page(self, ref=None):
         """
         This sets a new page to be recorded
-        :Args:
-        - ref: A reference for the new page. Defaults to None
+
+        - ref: unicode
+               A reference for the new page. Defaults to None
         """
         if ref:
             payload = {"pageRef": ref}
@@ -104,10 +108,12 @@ def new_page(self, ref=None):
     def blacklist(self, regexp, status_code):
         """
         Sets a list of URL patterns to blacklist
-        :Args:
-        - regex: a comma separated list of regular expressions
-        - status_code: the HTTP status code to return for URLs that do not \
-            match the blacklist
+
+        - regex: unicode
+                 a comma separated list of regular expressions
+        - status_code: unicode
+                       the HTTP status code to return for URLs that do not \
+                       match the blacklist
 
         """
         r = requests.put('%s/proxy/%s/blacklist' % (self.host, self.port),
@@ -117,10 +123,12 @@ def blacklist(self, regexp, status_code):
     def whitelist(self, regexp, status_code):
         """
         Sets a list of URL patterns to whitelist
-        :Args:
-        - regex: a comma separated list of regular expressions
-        - status_code: the HTTP status code to return for URLs that do not \
-           match the whitelist
+
+        - regex: unicode
+                 a comma separated list of regular expressions
+        - status_code: unicode
+                       the HTTP status code to return for URLs that do not \
+                       match the whitelist
         """
         r = requests.put('%s/proxy/%s/whitelist' % (self.host, self.port),
                          {'regex': regexp, 'status': status_code})
@@ -129,10 +137,13 @@ def whitelist(self, regexp, status_code):
     def basic_authentication(self, domain, username, password):
         """
         This add automatic basic authentication
-        :Args:
-        - domain: domain to set authentication credentials for
-        - username: valid username to use when authenticating
-        - password: valid password to use when authenticating
+
+        - domain: unicode
+                  domain to set authentication credentials for
+        - username: unicode
+                    valid username to use when authenticating
+        - password: unicode
+                    valid password to use when authenticating
         """
         r = requests.post(url='%s/proxy/%s/auth/basic/%s' % (self.host, self.port, domain),
                           data=json.dumps({'username': username, 'password': password}),
@@ -142,8 +153,9 @@ def basic_authentication(self, domain, username, password):
     def headers(self, headers):
         """
         This sets the headers that will set by the proxy on all requests
-        :Args:
-        - headers: this is a dictionary of the headers to be set
+
+        - headers: dict
+                   this is a dictionary of the headers to be set
         """
         if not isinstance(headers, dict):
             raise TypeError("headers needs to be dictionary")
@@ -156,8 +168,9 @@ def headers(self, headers):
     def response_interceptor(self, js):
         """
         Executes the javascript against each response
-        :Args:
-        - js: the javascript to execute
+
+        - js: unicode
+              the javascript to execute
         """
         r = requests.post(url='%s/proxy/%s/interceptor/response' % (self.host, self.port),
                   data=js,
@@ -167,8 +180,9 @@ def response_interceptor(self, js):
     def request_interceptor(self, js):
         """
         Executes the javascript against each request
-        :Args:
-        - js: the javascript to execute
+
+        - js: unicode
+              the javascript to execute
         """
         r = requests.post(url='%s/proxy/%s/interceptor/request' % (self.host, self.port),
                   data=js,
@@ -184,8 +198,9 @@ def request_interceptor(self, js):
     def limits(self, options):
         """
         Limit the bandwidth through the proxy.
-        :Args:
-        - options: A dictionary with all the details you want to set. \
+
+        - options: dict
+                   A dictionary with all the details you want to set. \
                         downstreamKbps - Sets the downstream kbps \
                         upstreamKbps - Sets the upstream kbps \
                         latency - Add the given latency to each HTTP request
@@ -215,8 +230,9 @@ def limits(self, options):
     def timeouts(self, options):
         """
         Configure various timeouts in the proxy
-        :Args:
-        - options: A dictionary with all the details you want to set. \
+
+        - options: dict
+                   A dictionary with all the details you want to set. \
                         request - request timeout (in seconds) \
                         read - read timeout (in seconds) \
                         connection - connection timeout (in seconds) \
@@ -240,9 +256,11 @@ def timeouts(self, options):
     def remap_hosts(self, address, ip_address):
         """
         Remap the hosts for a specific URL
-        :Args:
-        - address - url that you wish to remap
-        - ip_address - IP Address that will handle all traffic for the address passed in
+
+        - address: unicode
+                   url that you wish to remap
+        - ip_address: unicode
+                      IP Address that will handle all traffic for the address passed in
         """
         assert address is not None and ip_address is not None
         r = requests.post('%s/proxy/%s/hosts' % (self.host, self.port),
@@ -253,9 +271,11 @@ def remap_hosts(self, address, ip_address):
     def wait_for_traffic_to_stop(self, quiet_period, timeout):
         """
         Waits for the network to be quiet
-        :Args:
-        - quiet_period - number of seconds the network needs to be quiet for
-        - timeout - max number of seconds to wait
+        
+        - quiet_period: int
+                        number of seconds the network needs to be quiet for
+        - timeout: int
+                   max number of seconds to wait
         """
         r = requests.put('%s/proxy/%s/wait' % (self.host, self.port),
                  {'quietPeriodInMs': quiet_period, 'timeoutInMs': timeout})
@@ -271,9 +291,11 @@ def clear_dns_cache(self):
     def rewrite_url(self, match, replace):
         """
         Rewrites the requested url.
-        :Args:
-        - match - a regex to match requests with
-        - replace - a string to replace the matches with
+
+        - match: unicode
+                 a regex to match requests with
+        - replace: unicode
+                   a string to replace the matches with
         """
         params = {
             "matchRegex": match,
@@ -286,8 +308,9 @@ def rewrite_url(self, match, replace):
     def retry(self, retry_count):
         """
         Retries. No idea what its used for, but its in the API...
-        :Args:
-        - retry_count - the number of retries
+
+        - retry_count: int
+                       the number of retries
         """
         r = requests.put('%s/proxy/%s/retry' % (self.host, self.port),
                  {'retrycount': retry_count})