selenium BasePage (snippet)

Python web automation, selenium example 'BasePage'

BasePage

Python selenium example: BasePage

from selenium                                 import webdriver
from selenium.webdriver.support.ui            import WebDriverWait
from selenium.webdriver.support.select        import Select
from selenium.webdriver.support               import expected_conditions as EC
from selenium.webdriver.common.by             import By
from abc                                      import abstractmethod
from TravelingTony.Constants                  import LocatorMode

class BasePage(object):

 def __init__(self, driver):
     self.driver = driver
     self._verify_page()

  @abstractmethod
  def _verify_page(self):
      """
      This method verifies that we are on the correct page
      """

 def wait_for_element_visibility(self, waitTime, locatorMode, Locator):
   element = None
   if   locatorMode == LocatorMode.ID:
      element = WebDriverWait(self.driver, waitTime).\
              until(EC.visibility_of_element_located((By.ID, Locator)))
   elif locatorMode == LocatorMode.NAME:
      element = WebDriverWait(self.driver, waitTime).\
              until(EC.visibility_of_element_located((By.NAME, Locator)))
   elif locatorMode == LocatorMode.XPATH:
      element = WebDriverWait(self.driver, waitTime).\
              until(EC.visibility_of_element_located((By.XPATH, Locator)))
   elif locatorMode == LocatorMode.CSS_SELECTOR:
      element = WebDriverWait(self.driver, waitTime).\
              until(EC.visibility_of_element_located((By.CSS_SELECTOR, Locator)))
   else:
     raise Exception("Unsupported locator strategy.")
   return element


 def wait_until_element_clickable(self, waitTime, locatorMode, Locator):
   element = None
   if   locatorMode == LocatorMode.ID:
      element = WebDriverWait(self.driver, waitTime).\
              until(EC.element_to_be_clickable((By.ID, Locator)))
   elif locatorMode == LocatorMode.NAME:
      element = WebDriverWait(self.driver, waitTime).\
              until(EC.element_to_be_clickable((By.NAME, Locator)))
   elif locatorMode == LocatorMode.XPATH:
      element = WebDriverWait(self.driver, waitTime).\
              until(EC.element_to_be_clickable((By.XPATH, Locator)))
   elif locatorMode == LocatorMode.CSS_SELECTOR:
      element = WebDriverWait(self.driver, waitTime).\
              until(EC.element_to_be_clickable((By.CSS_SELECTOR, Locator)))
   else:
     raise Exception("Unsupported locator strategy.")
   return element


 def switch_to_window(self, wHandle):
     self.driver.switch_to.window(wHandle)

 def find_element(self, locatorMode, Locator):
     element = None
     if locatorMode == LocatorMode.ID:
        element = self.driver.find_element_by_id(Locator)
     elif locatorMode == LocatorMode.NAME:
      element = self.driver.find_element_by_name(Locator)
     elif locatorMode == LocatorMode.XPATH:
      element = self.driver.find_element_by_xpath(Locator)
     elif locatorMode == LocatorMode.CSS_SELECTOR: 
      element = self.driver.find_element_by_css_selector(Locator)
     else:
      raise Exception("Unsupported locator strategy.")
     return element

 def fill_out_field(self, locatorMode, Locator, text):
     self.find_element(locatorMode, Locator).clear()
     self.find_element(locatorMode, Locator).send_keys(text)

 def click(self, waitTime, locatorMode, Locator):
     self.wait_until_element_clickable(waitTime, locatorMode, Locator).click()

class IncorrectPageException(Exception):
    """
    This exception should be thrown when you try to instantiate an incrrect page
    """

Useful links

• Learn Python: https://pythonbasics.org/
• More Python: https://pythonprogramminglanguage.com