Adding docstrings

Author: AutomatedTester

browsermobproxy/client.py

@@ -5,6 +5,11 @@
 class Client(object):
 
     def __init__(self, url):
+        """
+        Initialises a new Client object
+        :Args:
+         - url: This is where the BrowserMob Proxy lives
+        """
         self.host = url 
         h = Http()
         resp, content = h.request('%s/proxy' % self.host, 'POST', urlencode(''))
@@ -14,11 +19,21 @@ def __init__(self, url):
         self.proxy = url_parts[0] + ":" + url_parts[1] + ":" +  str(self.port)
 
     def new_har(self, ref=None):
+        """
+        This sets a new HAR to be recorded
+        :Args:
+         - ref: A reference for the HAR. Defaults to None
+        """
         h = Http()
         resp, content = h.request('%s/proxy/%s/har' % (self.host, self.port), 
                                     'PUT', ref or '')
 
     def new_page(self, ref):
+        """
+        This sets a new page to be recorded
+        :Args:
+         - ref: A reference for the new page. Defaults to None
+        """
         h = Http()
         resp, content = h.request('%s/proxy/%s/har/pageRef' % (self.host, self.port), 
                                     'PUT', ref or '')
@@ -27,23 +42,44 @@ def new_page(self, ref):
 
     @property
     def har(self):
+        """
+        Gets the HAR that has been recorded
+        """
         h = Http()
         resp, content = h.request('%s/proxy/%s/har' % (self.host, self.port), 
                                     'GET')
         return json.loads(content)
 
     def selenium_proxy(self):
+        """
+        Returns a Selenium WebDriver Proxy class with details of the HTTP Proxy
+        """
         from selenium import webdriver
         return webdriver.Proxy({"httpProxy":self.proxy})
 
     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 
+
+        """
         h = Http()
         resp, content = h.request('%s/proxy/%s/whitelist' % (self.host, self.port), 
                                     'PUT', urlencode({ 'regex': regexp, 'status': status_code
                                     }))
 
 
     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 
+
+        """
+
         h = Http()
         resp, content = h.request('%s/proxy/%s/blacklist' % (self.host, self.port), 
                                     'PUT', urlencode({ 'regex': regexp, 'status': status_code
@@ -57,6 +93,14 @@ def blacklist(self, regexp, status_code):
 
 
     def limits(self, options):
+        """
+        Limit the bandwidth through the proxy.
+        :Args:
+         - options: 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
+        """
         params = {}
 
         for (k, v) in options.items():
@@ -73,6 +117,9 @@ def limits(self, options):
                                     'PUT', urlencode(params))
 
     def close(self):
+        """
+        shuts down the proxy and closes the port
+        """
         h = Http()
         resp, content = h.request('%s/proxy/%s' % (self.host, self.port), 
                                     'DELETE' )

browsermobproxy/server.py

@@ -8,11 +8,22 @@
 class Server(object):
 
     def __init__(self, path, options={}):
+        """
+        Initialises a Server object
+
+        :Args:
+         - path : Path to the browsermob proxy batch file
+         - options : Dictionary that can hold the port. More items will be added in the future.
+                     This defaults to an empty dictionary
+        """
         self.path = path
         self.port = options['port'] if options.has_key('port') else 8080
         self.command = ['sh', path, '--port=%s' % self.port]
 
     def start(self):
+        """
+        This will start the browsermob proxy and then wait until it can interact with it 
+        """
         self.process = Popen(self.command, stdout=PIPE, stderr=STDOUT)
         count = 0
         while not self._is_listening():
@@ -21,9 +32,10 @@ def start(self):
             if count == 30:
                 raise Exception("Can't connect to Browsermob-Proxy")
 
-        
-
     def stop(self):
+        """
+        This will stop the process running the proxy
+        """
         try:
             if self.process:
                 self.process.kill()
@@ -34,10 +46,16 @@ def stop(self):
 
     @property
     def url(self):
+        """
+        Gets the url that the proxy is running on. This is not the URL clients should connect to.
+        """
         return "http://localhost:%d" % self.port
 
     @property
     def create_proxy(self):
+        """
+        Gets a client class that allow to set all the proxy details that you may need to.
+        """
         client = Client(self.url)
         return client