🥙 donerkebab 🥙

Beginner friendly wrapper functions for selenium

$ pip install donerkebab

Usage

Download the driver for your browser (Chrome, Edge, Firefox or Safari)

Place in the same directory as the script or in your PATH

Example

The following script opens a new browser, opens duckduckgo, fills search bar and gets the search results

# Also available for Firefox, Edge, Safari and Opera
from donerkebab import ChromeDriver

# Get an instance of the browser window
# You can easily start it in headless mode too
driver = ChromeDriver(headless=False)

driver.open('https://duckduckgo.com/')

# Browser will wait at max 10 seconds until element is found
driver.set_timeout(10)

# You can find elements by their CSS selectors
input_box = driver.get_element('input#search_form_input_homepage')

# Uses classic selenium element functions
input_box.send_keys('Do pigs fly?')

driver.sleep(2)

submit_button = driver.get_element('input#search_button_homepage')

# Perform the search
submit_button.click()

# Get the container of all the result links
results_container = driver.get_element('div.results--main')

# Get all the links inside the container with a class of 'results__a'
results = driver.get_elements_in_parent(results_container, 'a.result__a')

# Print all the links
print("🔎 Results for 'Do pigs fly?' 🔎")
for result in results:
    # get title and href attribute (the link adress) for every result
    print(result.text + ' -> ' + result.get_attribute('href'))

driver.quit()

API

Driver init options

driver = FirefoxDriver(log=True, executable_path=None,headless=False, page_load_strategy='normal'):

headless -> Hides the window and runs the browser in the background. Really usefull
log -> Enable or disable logging
executable_path -> The full path to executable driver. If left null the it will look at the PATH variable to find the driver.
page_load_strategy -> Take a look at the [official docs](https://www.selenium.dev/documentation/webdriver/capabilities/shared/#pageloadstrategy)

Locating elements

Css selectors

donerkebab always uses css selectors for locating elements. Some examples:

• input element with type input
• div > input element that is the direct child of input
• input.search element with a class of 'search'
• input#main_button element with an id of 'main_button'
• a[href='https://google.com'] link element with a href attribute

Definately check out more advanced css selectors. They come in really handy

Locator methods

driver.get_element(css_selector)
driver.get_elements(css_selector)
driver.get_element_in_parent(parent_element, css_selector)
driver.get_elements_in_parent(parent_element, css_selector)
driver.get_element_by_xpath(xpath)

driver.is_element_present(css_selector) # Searches for element without any timeout

# Tries the first selector, if none element is found, tries the alternate selector
# Great for having backup selectors for elements that might change
driver.get_element_multiple_attempts(selector1, selector2, selector3...)

# Returns the active element
driver.active_element

# Scrolls that element into view
driver.scroll_to_element(element)

# Waits until an alert is present, and returns that alert
driver.get_alert()

Filling forms

from donerkebab import Keys

# Get elements as usual
inp = driver.get_element('input')

inp.send_keys('President of US?' + Keys.ENTER)

# Dropdown select elements

# Select an <option> based upon the <select> element's internal index
driver.set_select(element).select_by_index(1)

# Select an <option> based upon its value attribute ex: <option value='value1'>Moderate</option>
driver.set_select(element).select_by_value('value1')

# Select an <option> based upon its text <option>Bread</option>
driver.set_select(element).select_by_visible_text('Bread')

Driver methods

driver.open(url) # Opens the url, waits for the page to load

# Browser back forward refresh buttons
driver.forward()
driver.back()
driver.refresh()

# All measures in pixels
driver.set_window_size(width, height)
driver.set_window_position(xpos, ypos)

Actions

You can use actions for hovering over buttons or sending out special keys

Look at the official documentations for more detail

# Import special keys
from donerkebab import Keys

# Perform action ctrl + A (modifier CONTROL + Alphabet A) to select the page
driver.action.key_down(Keys.CONTROL).send_keys("a").perform()

menu = driver.get_element('a[href="/downloads/"]')

driver.action.move_to_element(menu).perform()

submenu = driver.get_element('a[href="/downloads/source/"]')

driver.action.move_to_element(submenu).click().perform()

Execute javascript in browser

If you feel stuck, you can also execute javascript to click buttons, submit forms etc.

driver.execute(javascript_code, argument1, argument2, argument3...)

driver.execute("console.log('Hello World!')") # This logs Hello World! to the browser's console

# You can access the arguments with the 'argument' variable
driver.execute("console.log(argument[0] + argument[1])", "Hello ", "World")

# Or get the return value as string
print(driver.execute('2 + 3')) # 5???