make package s_tool and fix code quality

Author: aahnik

s_tool/__init__.py

@@ -0,0 +1,12 @@
+"""Package s-tool.
+
+Selenium wrapper to make your life easy.
+
+MIT License
+
+Copyright (c) 2021 Python World
+"""
+
+from importlib.metadata import version
+
+__version__ = version(__package__)

stool/driver.py s_tool/driver.pystool/driver.py renamed to s_tool/driver.py

@@ -5,17 +5,25 @@
 from webdriver_manager.firefox import GeckoDriverManager
 from webdriver_manager.utils import ChromeType
 
-from utils import (SToolException, click, current_url, get_cookies,
-                   get_element, get_session, hide_show_elements, page_source,
-                   take_screenshot, visit)
+from s_tool.utils import (
+    SToolException,
+    click,
+    current_url,
+    get_cookies,
+    get_element,
+    get_session,
+    hide_show_elements,
+    page_source,
+    take_screenshot,
+    visit,
+)
 
 
 class SeleniumDriver:
-    """SeleniumDriver class to manage driver object and all utility functions at one place
-    """
+    """SeleniumDriver class to manage driver object and all utility functions at one place"""
 
     def __init__(self, browser=None, headless=False):
-        self.browser_list = ['chrome', 'chromium', 'firefox']
+        self.browser_list = ["chrome", "chromium", "firefox"]
         self.driver = None
         self.browser = browser
         self.headless = headless
@@ -24,44 +32,45 @@ def __init__(self, browser=None, headless=False):
         self._load_methods()
 
     def close(self):
-        """will stop driver after program execution
-        """
+        """will stop driver after program execution"""
         if self.driver:
             self.driver.quit()
 
     def __exit__(self, type, value, traceback):
-        """release the resources occupied with the current session
-        """
+        """release the resources occupied with the current session"""
         self.close()
 
     def __enter__(self):
         return self._load_driver()
 
     def _load_driver(self):
-        """Create Selenium webdriver object
-        """
+        """Create Selenium webdriver object"""
         self.close()
         browser = self.browser.lower()
         if browser not in self.browser_list:
             raise SToolException(
-                f"provided browser {browser} doesn't exists. available brower list:{self.browser_list}")
+                f"provided browser {browser} doesn't exists. available brower list:{self.browser_list}"
+            )
 
         # add chrome and firefox different options
-        options = getattr(webdriver, browser if browser !=
-                          'chromium' else 'chrome').options.Options()
+        options = getattr(
+            webdriver, browser if browser != "chromium" else "chrome"
+        ).options.Options()
         if self.headless:
-            options.add_argument('--headless')
+            options.add_argument("--headless")
 
-        if browser in ['chrome', 'chromium']:
-            browser_type = ChromeType.CHROMIUM if browser == 'chromium' else ChromeType.GOOGLE
-            self.driver = webdriver.Chrome(ChromeDriverManager(
-                chrome_type=browser_type).install(),
-                options=options)
+        if browser in ["chrome", "chromium"]:
+            browser_type = (
+                ChromeType.CHROMIUM if browser == "chromium" else ChromeType.GOOGLE
+            )
+            self.driver = webdriver.Chrome(
+                ChromeDriverManager(chrome_type=browser_type).install(), options=options
+            )
 
         if browser == "firefox":
             self.driver = webdriver.Firefox(
-                executable_path=GeckoDriverManager().install(),
-                options=options)
+                executable_path=GeckoDriverManager().install(), options=options
+            )
 
         # Maximize window to give normal browser feel
         self.driver.maximize_window()
@@ -83,9 +92,9 @@ def _load_methods(self):
         self.hide = partial(hide_show_elements, self.driver)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
 
     # Create A Driver Object
-    with SeleniumDriver('firefox', headless=False) as obj:
+    with SeleniumDriver("firefox", headless=False) as obj:
         # visit https:example.com
-        obj.visit(r'https://quotes.toscrape.com/')
+        obj.visit(r"https://quotes.toscrape.com/")

stool/parser.py s_tool/parser.pystool/parser.py renamed to s_tool/parser.py

@@ -1,6 +1,5 @@
 class Parser(object):
-    """Parse data from webdriver
-    """
+    """Parse data from webdriver"""
 
     def __init__(self, driver):
         self.driver = driver

s_tool/utils/__init__.py

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+
+from utils.driver_exceptions import SToolException
+from utils.driver_utils import (
+    click,
+    current_url,
+    get_cookies,
+    get_element,
+    get_locator,
+    get_session,
+    hide_show_elements,
+    page_source,
+    take_screenshot,
+    visit,
+)
+
+__all__ = [
+    "SToolException",
+    "current_url",
+    "get_element",
+    "get_session",
+    "page_source",
+    "visit",
+    "get_locator",
+    "click",
+    "get_cookies",
+    "take_screenshot",
+    "hide_show_elements",
+]

stool/utils/driver_exceptions.py s_tool/utils/driver_exceptions.pystool/utils/driver_exceptions.py renamed to s_tool/utils/driver_exceptions.py

@@ -1,5 +1,3 @@
-
-
 class SToolException(Exception):
     """
     Base Class for selenium tools Exceptions

stool/utils/driver_utils.py s_tool/utils/driver_utils.pystool/utils/driver_utils.py renamed to s_tool/utils/driver_utils.py

@@ -3,30 +3,26 @@
 from selenium.webdriver.support import expected_conditions as EC
 from selenium.webdriver.support.ui import WebDriverWait
 
-from utils.driver_exceptions import SToolException
+from s_tool.utils.driver_exceptions import SToolException
 
 
 def get_session(driver):
-    """Return Selenium Driver session id
-    """
+    """Return Selenium Driver session id"""
     return driver.session_id
 
 
 def visit(driver, url):
-    """visit given url 
-    """
+    """visit given url"""
     driver.get(url)
 
 
 def page_source(driver):
-    """Return html page source
-    """
+    """Return html page source"""
     return driver.page_source
 
 
 def current_url(driver):
-    """Return current url
-    """
+    """Return current url"""
     return driver.current_url
 
 
@@ -56,19 +52,19 @@ def get_element(driver, locator_type, locator_text, many=None):
 
         many         : optional default None,
                        1: select multiple element
-                       0: select single element 
+                       0: select single element
 
     Returns:
-        Return an element object if found otherwise 
+        Return an element object if found otherwise
         return None
     """
 
     locator_type = locator_type.upper()
     if hasattr(By, locator_type):
         try:
             locator = get_locator(locator_type, locator_text)
-            is_multiple = 's' if many else ''
-            func = getattr(driver, f'find_element{is_multiple}')
+            is_multiple = "s" if many else ""
+            func = getattr(driver, f"find_element{is_multiple}")
             return func(*locator)
         except NoSuchElementException:
             return None
@@ -93,7 +89,8 @@ def click(driver, locator_type, locator_text, click_time=10):
     try:
         elem_locator = get_locator(locator_type, locator_text)
         element = WebDriverWait(driver, click_time).until(
-            EC.element_to_be_clickable(elem_locator))
+            EC.element_to_be_clickable(elem_locator)
+        )
         element.click()
         return True
     except TimeoutException:
@@ -113,25 +110,25 @@ def get_cookies(driver):
                         no cookies return an empty dictionary
     """
     cookies = driver.get_cookies()
-    cookies_dict = {cookie['name']: cookie['value'] for cookie in cookies}
+    cookies_dict = {cookie["name"]: cookie["value"] for cookie in cookies}
     return cookies_dict or {}
 
 
 def take_screenshot(driver, element=None):
     """take screenshot of given element if element is
-        not given take a full page screeenshot and return
-        data in bytes
+    not given take a full page screeenshot and return
+    data in bytes
 
-        Args:
-            driver  : selenium Webdriver
-            element : default None, provide element locator
-                    example : element=('id','element_id')
+    Args:
+        driver  : selenium Webdriver
+        element : default None, provide element locator
+                example : element=('id','element_id')
 
-        Returns:
-            returns byte object,if element not present 
-            it will return None.
+    Returns:
+        returns byte object,if element not present
+        it will return None.
 
-        full screenshot will work only in headless mode.
+    full screenshot will work only in headless mode.
     """
     if element and isinstance(element, tuple):
         locator_type, locator_text = element
@@ -147,7 +144,7 @@ def take_screenshot(driver, element=None):
 
 
 def display_element(driver, element, hide=None):
-    """ hide or show single element
+    """hide or show single element
 
     Args:
         driver  : selenium webdriver
@@ -158,9 +155,8 @@ def display_element(driver, element, hide=None):
         None
     """
 
-    hide_or_show = 'inline' if hide else 'None'
-    driver.execute_script(
-        f"arguments[0].style.display = '{hide_or_show}';", element)
+    hide_or_show = "inline" if hide else "None"
+    driver.execute_script(f"arguments[0].style.display = '{hide_or_show}';", element)
 
 
 def hide_show_elements(driver, elements, hide=None):