Skip to main content

A webdriver / selenium wrapper focusing on code completion, good page class design, and logging.

Project description

Website at: http://www.slickqa.com/webdriver/python Extensive documentation at: http://www.slickqa.com/webdriver/python/docs

Webdriver wrapper for SlickQA Project

Don’t let the name fool you, this wrapper can be used by any project. It was written by the people who brought you the slick project, hence the name. This wrapper has the purpose of making the selenium interface more reliable for tests with less, more readable code by:

  • Wrapping all actions with log statements (using python’s builtin logging framework) that detail everything it’s doing

  • Providing a nice readable api, making your tests readable

  • Waiting for elements to exist (with customizable timeout) so that you don’t have to

  • Providing a Page api that allows for easy organization of locators

  • Page api allows for flat (Page -> locator) and nested (FrameworkElement -> Page -> Container -> Locator) api

  • No need to instantiate every page class individually (avoiding boilerplate code)

  • Event based api where you can add your own pre and post actions as part of standard calls (like taking a screenshot on click)

  • more good tidbits

Example Usage

What does a test using this fabulous framework look like? Let me show you:

from slickwd import BrowserType, Browser, Container, WebElementLocator, Find
from nose import with_setup
from nose.tools import assert_regexp_matches

# Page Classes --------------------------------------------------
class GoogleSearchPage(Container):
    Search_Query_Text_Field = WebElementLocator("Search Box", Find.by_name("q"))
    Search_Button = WebElementLocator("Search Button", Find.by_name("btnG"))

    def is_current_page(self, browser):
        return browser.exists(GoogleSearchPage.Search_Query_Text_Field, timeout=0, log=False)

class SearchResultsPage(Container):
    Results_Div = WebElementLocator("Results Div", Find.by_id("ires"))

    def is_current_page(self, browser):
        return browser.exists(SearchResultsPage.Results_Div, timeout=0, log=False)

# Tests ---------------------------------------------------------
browser = None


def s():
    global browser
    if browser is not None:
        browser.quit()
    browser = Browser(BrowserType.FIREFOX)

def cleanup():
    global browser
    if browser is not None:
        browser.quit()

@with_setup(s, cleanup)
def test_google_search():
    global browser
    browser.go_to('http://www.google.com')
    browser.wait_for_page(GoogleSearchPage)
    browser.click_and_type(GoogleSearchPage.Search_Query_Text_Field, "Slick Test Manager")
    browser.click(GoogleSearchPage.Search_Button)
    browser.wait_for_page(SearchResultsPage)
    assert_regexp_matches(browser.get_page_text(), '.*SlickQA:.*')

The test is written so the code can be read, easily modified if something in the page is changed, and allow for code reuse (page classes). Normally page classes would be held in a different module for better organization. This is what is referred to in the documentation as the “static page class model”. There is also a different way to structure page classes that allows for nesting of containers (page classes) to make a hierarchy and enable code completion in IDEs.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

slick_webdriver-1.0.18-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

slick_webdriver-1.0.18-py2-none-any.whl (13.2 kB view details)

Uploaded Python 2

File details

Details for the file slick_webdriver-1.0.18-py3-none-any.whl.

File metadata

File hashes

Hashes for slick_webdriver-1.0.18-py3-none-any.whl
Algorithm Hash digest
SHA256 98639714732b6d099b630a6b252e60da4a3e826ceea6a6da8c7b75ade7057712
MD5 2c74e449250021892d23774b07afe13c
BLAKE2b-256 3ab1818078af15daf7611702b4f006a5cb0b3f883cfc60f1af8e57032a4d913d

See more details on using hashes here.

File details

Details for the file slick_webdriver-1.0.18-py2-none-any.whl.

File metadata

File hashes

Hashes for slick_webdriver-1.0.18-py2-none-any.whl
Algorithm Hash digest
SHA256 40a78c49e1416d44adee38899df818be3b1344cd6fba0891d63a4a82db42f4e8
MD5 a872bcfc41bf053f326b1adff12ddd3f
BLAKE2b-256 f8f2ee25f4a835eb7b2f40a43ae8e468a410d246c5af1ab2160e4e9407fc14b6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page