added function clicks,extract page info,retrive cookies

Author: ravishankar

README.md

@@ -4,7 +4,21 @@ stool is an wrapper over selenium to perform various task.
 
 
 ## Features
-- [X] Manage multiple webdrivers
+- [X] Manage multiple webdrivers.
+- [X] Click any type of element.
+- [X] Extract Page source.
+- [X] Select different type of elements. 
+- [X] Retrive cookies.
+- [X] take fullpage and elementwise screenshots.
+- [X] display and hide elements.
+  
 
 ## TODO
-- [ ] Manage multiple webdrivers
+- [ ] Fill information(forms)
+- [ ] horizontal and vertical scrolling
+- [ ] Handeling alerts and popup
+- [ ] Switching windows,tabs,frames.
+- [ ] adding universal login functionality with forms
+- [ ] handling iframe windows.
+- [ ] Writing Parser to extract data from WebDriver.
+- [ ] Logging driver activities

stool/driver.py

@@ -5,11 +5,14 @@
 from webdriver_manager.firefox import GeckoDriverManager
 from webdriver_manager.utils import ChromeType
 
-from utils import (SToolException, current_url, get_element, get_session,
-                   page_source, visit)
+from 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
+    """
 
     def __init__(self, browser=None, headless=False):
         self.browser_list = ['chrome', 'chromium', 'firefox']
@@ -74,6 +77,10 @@ def _load_methods(self):
         self.text = partial(page_source, self.driver)
         self.url = partial(current_url, self.driver)
         self.element = partial(get_element, self.driver)
+        self.click = partial(click, self.driver)
+        self.cookies = partial(get_cookies, self.driver)
+        self.screenshot = partial(take_screenshot, self.driver)
+        self.hide = partial(hide_show_elements, self.driver)
 
 
 if __name__ == '__main__':
@@ -82,7 +89,3 @@ def _load_methods(self):
     with SeleniumDriver('firefox', headless=False) as obj:
         # visit https:example.com
         obj.visit(r'https://quotes.toscrape.com/')
-
-        # for all quotes obj.element('class_name', 'quote',1)
-        result = obj.element('class_name', 'quote')
-        print(result)

stool/utils/__init__.py

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 
 from utils.driver_exceptions import SToolException
-from utils.driver_utils import (current_url, get_element, get_session,
-                                page_source, visit)
+from utils.driver_utils import (current_url, get_element, get_session, page_source,
+                                visit, get_locator, click, get_cookies, take_screenshot, hide_show_elements)
 
-__all__ = ["SToolException", "current_url", "get_element", "get_session",
-           "page_source", "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_utils.py

@@ -1,5 +1,7 @@
-from selenium.common.exceptions import NoSuchElementException
+from selenium.common.exceptions import NoSuchElementException, TimeoutException
 from selenium.webdriver.common.by import By
+from selenium.webdriver.support import expected_conditions as EC
+from selenium.webdriver.support.ui import WebDriverWait
 
 from utils.driver_exceptions import SToolException
 
@@ -38,7 +40,8 @@ def get_locator(locator_type, locator_text):
 
         locator_text : attribute value
     """
-    return getattr(By, locator_type), locator_text
+    locator = locator_type.upper()
+    return getattr(By, locator), locator_text
 
 
 def get_element(driver, locator_type, locator_text, many=None):
@@ -67,7 +70,115 @@ def get_element(driver, locator_type, locator_text, many=None):
             is_multiple = 's' if many else ''
             func = getattr(driver, f'find_element{is_multiple}')
             return func(*locator)
-        except NoSuchElementException as _:
+        except NoSuchElementException:
             return None
     else:
         raise SToolException("INVALID_SELECTOR")
+
+
+def click(driver, locator_type, locator_text, click_time=10):
+    """Return True if element clicked otherwise return None
+
+    Args:
+        locator_type : provide any attribute type
+                    id,class_name,tag_name
+                    xpath, css_selector
+
+        locator_text : attribute value
+
+    Returns:
+        True    : If element clicked
+        None    : Not clicked or Not Found
+    """
+    try:
+        elem_locator = get_locator(locator_type, locator_text)
+        element = WebDriverWait(driver, click_time).until(
+            EC.element_to_be_clickable(elem_locator))
+        element.click()
+        return True
+    except TimeoutException:
+        return None
+    except Exception as ex:
+        raise SToolException(ex)
+
+
+def get_cookies(driver):
+    """Accept driver object and return cookies in dictionary
+
+    Args:
+        driver : A selenium WebDriver
+
+    Returns:
+        cookies_dict : return cookies in dicionary format if
+                        no cookies return an empty dictionary
+    """
+    cookies = driver.get_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
+
+        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.
+
+        full screenshot will work only in headless mode.
+    """
+    if element and isinstance(element, tuple):
+        locator_type, locator_text = element
+        ele = get_element(driver, locator_type, locator_text)
+        if ele:
+            return ele.screenshot_as_png
+        return None
+    else:
+        width = driver.execute_script("return document.body.offsetWidth")
+        height = driver.execute_script("return document.body.offsetHeight")
+        driver.set_window_size(width, height)
+        return driver.get_screenshot_as_png()
+
+
+def display_element(driver, element, hide=None):
+    """ hide or show single element
+
+    Args:
+        driver  : selenium webdriver
+        element : an selenium element
+        hide    : default value is None, to hide element
+                    hide=1 to display hidden element
+    Returns:
+        None
+    """
+
+    hide_or_show = 'block' if hide else 'None'
+    driver.execute_script(
+        f"arguments[0].style.display = '{hide_or_show}';", element)
+
+
+def hide_show_elements(driver, elements, hide=None):
+    """hide or show multiple elements
+
+    Args:
+        driver  : selenium webdriver
+        elements  : list of tuples,[('locator_type','value')]
+                example : [('id','id_value')]
+        hide    : default value is None, to hide element
+                 hide=1 to display hidden element
+
+    Returns:
+        None
+    """
+    for element_locator in elements:
+        locator_type, locator_value = element_locator
+        element_list = get_element(driver, locator_type, locator_value, 1)
+        if element_list:
+            for element in element_list:
+                display_element(driver, element, hide)