Added docstring to all functions. 🎉

torrentSearch/http_utils.py

@@ -8,26 +8,41 @@ from urllib.error import URLError
 
 logger = logging.getLogger('torrentSearch')
 
-def build_url(ssl, baseUrl, path, args_dict=[]):
+def build_url(ssl, baseUrl, path, args_dict={}):
+   """
+   Given the parameters joins them together to a url to 
+   :param bool ssl: if ssl is to be used or not
+   :param str baseUrl: the start of the url (http://thepiratebay.org)
+   :param list path: the rest of the path to the url (['search', 'lucifer', '0'])
+   :param dict args_dict: a dict with the query element we want to append to the url
+   :return: complete url based on the inputs
+   :rtype: str
+   """
    url_parts = list(parse.urlparse(baseUrl))
    url_parts[0] = 'https' if ssl else 'http'
-   if type(path) is list:
-      url_parts[2] = '/'.join(path)
-   else:
-      url_parts[2] = path
+   url_parts[2] = '/'.join(path)
    url_parts[4] = parse.urlencode(args_dict)
    return parse.urlunparse(url_parts)
 
-# Converts a input string or list to percent-encoded string,
-# this is for encoding information in a Uniform Resource
-# Identifier (URI) using urllib
 def convert_query_to_percent_encoded_octets(input_query):
+   """
+   Converts a string with spaces to a string separated by '%20'
+   :param str input_query:
+   :return: string with spaces replaced with '%20' if found any
+   :rtype: str
+   """
    if type(input_query) is list:
       input_query = ' '.join(input_query)
 
    return parse.quote(input_query)
 
 def fetch_url(url):
+   """
+   Call and get output for a given url
+   :param str url: the url we want to make a request to
+   :return: a response object with contents and status code of the request
+   :rtype: http.client.HTTPResponse
+   """
    logger.debug('Fetching query: {}'.format(url))
    req = request.Request(url, headers={'User-Agent': 'Mozilla/5.0'})
    try:
@@ -40,4 +55,4 @@ def fetch_url(url):
       elif hasattr(e, 'code'):
          logger.error('The server couldn\'t fulfill the request.')
          logger.error('Error code: ', e.code)
-      sys.exit()
+      sys.exit()