Adding docstring and comments

Author: digitaldreams

Download.py

@@ -13,23 +13,23 @@ def __init__(self, file_name, path=''):
         self.file_to_set()
         self.path = path
 
-    """
-    Load links from file and set to Set()
-    """
-
-    def file_to_set(self):
+    def file_to_set(self) -> object:
+        """
+        Load links from file and set to Set()
+        :return: object
+        """
         if not os.path.exists(self.file_name):
             raise FileNotFoundError(errno.ENOENT, os.strerror(errno.ENOENT), self.file_name)
         with open(self.file_name, 'rt') as f:
             for line in f:
                 self.links.add(line.replace('\n', ''))
         return sorted(self.links)
 
-    """
-    Start of the downloading
-    """
-
-    def start(self):
+    def start(self) -> object:
+        """
+        Start Downloading file
+        :rtype: object
+        """
         for file in self.links:
             try:
                 img = SaveFile.SaveFile(file, self.path)
@@ -39,11 +39,11 @@ def start(self):
             self.completed.add(file)
         self.set_to_file()
 
-    """
-    Update links txt file
-    """
-
-    def set_to_file(self):
+    def set_to_file(self) -> object:
+        """
+        Update links txt file
+        :return : None
+        """
         remaining = self.links.difference(self.completed)
         with open(self.file_name, 'w') as f:
             if len(remaining) > 0:

ImgFinder.py

@@ -12,10 +12,13 @@ def __init__(self, page_url):
         self.path = urlres.path
         self.src = set()
         HTMLParser.__init__(self)
-    """
-    This function called by HTMLParser internally. We modify it to make our work
-    """
+
     def handle_starttag(self, tag, attrs):
+        """
+        This function called by HTMLParser internally. We modify it to make our work
+
+        :rtype: object
+        """
         if tag == 'img':
             for (attr, value) in attrs:
                 if attr == 'src':
@@ -24,19 +27,35 @@ def handle_starttag(self, tag, attrs):
                 else:
                     continue
 
-    def getSrc(self):
+    def getSrc(self) -> object:
+        """
+        List of image link as set
+        :return: object
+        """
         return self.src
 
-    def get_base_url(self):
+    def get_base_url(self) -> object:
+        """
+        Return Base url of the page. Like www.example.com/home.php will be www.example.com
+        :rtype: object
+        """
         return self.base_url
 
-    def save_to_file(self):
-        file_name = self.folder_path()+ self.path + '.txt'
+    def save_to_file(self) -> object:
+        """
+        Save waiting downloadable image to queue. So next time when program run
+        :rtype: object
+        """
+        file_name = self.folder_path() + self.path + '.txt'
         with open(file_name, 'w') as f:
             for line in sorted(self.src):
                 f.write(line + '\n')
 
         return file_name
 
-    def folder_path(self):
+    def folder_path(self) -> object:
+        """
+         Path to folder resource where images and others file will be saved for current domain relative to current folder
+        :return: object
+        """
         return "storage/" + self.folder

SaveFile.py

@@ -4,12 +4,22 @@
 
 class SaveFile:
     def __init__(self, file_name, path=''):
+        """
+        SaveFile Constructor
+        :param file_name:
+        :param path
+        :rtype: object
+        """
         self.file_name = file_name
 
         self.base_name = os.path.basename(urllib.request.urlparse(file_name).path)
         self.path = path
 
-    def save(self):
+    def save(self) -> object:
+        """
+        Download from web and save it to local folder
+        :rtype: object
+        """
         try:
             if len(self.path) > 0:
                 full_file_path = self.path + '/' + self.base_name

__pycache__/Download.cpython-36.pyc

@@ -4,7 +4,12 @@
 import os.path
 
 
-def gather_img_src(page_url):
+def gather_img_src(page_url) -> object:
+    """
+    Parse Html and find img source and return as set
+    :param page_url:
+    :return: object
+    """
     try:
         html = html_string(page_url)
         finder = ImgFinder.ImgFinder(page_url)
@@ -16,13 +21,23 @@ def gather_img_src(page_url):
     return finder.getSrc()
 
 
-def create_project_folder(page_url):
+def create_project_folder(page_url: object) -> object:
+    """
+    Create a project folder
+    :param page_url:
+    :rtype: object
+    """
     base_url = get_folder_name(urllib.parse.urlparse(page_url).netloc)
     if not os.path.exists("storage/" + base_url):
         os.makedirs("storage/" + base_url)
 
 
-def html_string(page_url):
+def html_string(page_url: object) -> object:
+    """
+    Fetch html from url and return as Html String
+    :param page_url:
+    :rtype: object
+    """
     html_string = ''
     try:
         response = urllib.request.urlopen(page_url)
@@ -35,7 +50,12 @@ def html_string(page_url):
     return html_string
 
 
-def get_folder_name(base_url):
+def get_folder_name(base_url) -> object:
+    """
+    Get hostname from a base url like www.example.com will return example
+    :param base_url:
+    :rtype: object
+    """
     parts = base_url.split(".")
     if len(parts) == 3:
         return parts[1]

__pycache__/ImgFinder.cpython-36.pyc

@@ -6,7 +6,9 @@
 
 if __name__ == '__main__':
     PAGE_URL = 'http://www.fdfashionbd.com/gallarey'
+    # Create the project folder into storage folder
     create_project_folder(PAGE_URL)
+    # Find images source and save it to project folder
     finder = ImgFinder.ImgFinder(PAGE_URL)
     finder.feed(html_string(PAGE_URL))
     file_name = finder.save_to_file()