nerodia package

Subpackages

• nerodia.elements package
  • Submodules
  • nerodia.elements.area module
  • nerodia.elements.button module
  • nerodia.elements.cell module
  • nerodia.elements.check_box module
  • nerodia.elements.d_list module
  • nerodia.elements.element module
  • nerodia.elements.file_field module
  • nerodia.elements.font module
  • nerodia.elements.form module
  • nerodia.elements.hidden module
  • nerodia.elements.html_elements module
  • nerodia.elements.i_frame module
  • nerodia.elements.image module
  • nerodia.elements.input module
  • nerodia.elements.link module
  • nerodia.elements.list module
  • nerodia.elements.option module
  • nerodia.elements.radio module
  • nerodia.elements.radio_set module
  • nerodia.elements.row module
  • nerodia.elements.select module
  • nerodia.elements.svg_elements module
  • nerodia.elements.table module
  • nerodia.elements.table_cell module
  • nerodia.elements.table_data_cell module
  • nerodia.elements.table_row module
  • nerodia.elements.table_section module
  • nerodia.elements.text_area module
  • nerodia.elements.text_field module
  • Module contents
• nerodia.wait package
  • Submodules
  • nerodia.wait.timer module
  • nerodia.wait.wait module
  • Module contents

Submodules

nerodia.after_hooks module

class nerodia.after_hooks.AfterHooks(browser)

Bases: object

After hooks are blocks that run after certain browser events. They are generally used to ensure application under test does not encounter any error and are automatically executed after following events:

1. Open URL.
2. Refresh page.
3. Click, double-click or right-click on element.
4. Alert closing.

add(method=None, after_hook=None)

Adds new after hook :param method: callable method :param after_hook: callable object

Example:

from __future__ import print_function browser.after_hooks.add(method=lambda b: ‘Server Error’ in browser.text and print(‘Application exception or 500 error!’) browser.goto(‘watir.github.io/404’) #=> ‘Application exception or 500 error!’

delete(after_hook)

Deletes after hook :param after_hook: hook to delete

Example:

from __future__ import print_function browser.after_hooks.add(method=lambda b: ‘Server Error’ in browser.text and print(‘Application exception or 500 error!’) browser.goto(‘watir.github.io/404’) #=> ‘Application exception or 500 error!’ browser.after_hooks.delete(browser.after_hooks[0]) browser.refresh

run()

Runs after hooks

without(**kwds)

Executes a block without running error after hooks

Example:

with browser.after_hooks.without():

self.browser.element(name=’new_user_button’).click()

nerodia.alert module

class nerodia.alert.Alert(browser)

Bases: nerodia.wait.wait.Waitable

assert_exists()

close()

Closes alert or cancels prmopts/confirms

Example:

browser.alert.close() browser.alert.exists #=> False

exists

Returns True if alert, confirm, or prompt is present and False otherwise :rtype: bool

Example:

browser.alert.exists #=> True

ok()

Closes alert or accepts prompts/confirms

Example:

browser.alert.ok browser.alert.exists #=> False

present

Returns True if alert, confirm, or prompt is present and False otherwise :rtype: bool

Example:

browser.alert.exists #=> True

selector_string

set(value)

Enters text to prompt :param value: keys to send

Example:

browser.alert.set(‘Text for prompt’) browser.alert.ok()

text

Returns the text of the alert :rtype: str

Example:

browser.alert.text #=> ‘ok’

wait_for_exists()

nerodia.browser module

class nerodia.browser.Browser(browser='chrome', *args, **kwargs)

Bases: nerodia.container.Container, nerodia.has_window.HasWindow, nerodia.wait.wait.Waitable, nerodia.elements.scroll.Scrolling

alert

Handles Javascript alerts, confirms and prompts :rtype: nerodia.alert.Alert

back()

Navigates back in history

browser

close()

Closes the browser

cookies

Handles cookies :rtype: nerodia.cookies.Cookies

execute_script(script, *args)

Executes JavaScript snippet :param script: Javascript Snippet to execute :type script: str :param args: Arguments will be available in the given script in the ‘arguments’ pseudo-array :return: result of script

exist

True if browser is not closed and False otherwise :rtype: bool

exists

True if browser is not closed and False otherwise :rtype: bool

forward()

Navigates forward in history

goto(uri)

Goes to the given URL :param uri: the URL :type uri: str :return: the url you end up at :rtype: str

html

Returns HTML code of the current page :rtype: str

locate()

locator_namespace

Whether the locators should be used from a different namespace. Defaults to nerodia.locators :return:

name

Returns the browser name :rtype: str

quit()

Closes the browser

ready_state

Returns the readyState of the document :rtype: str

refresh()

Refreshes the current page

screenshot

Handles screenshots of current pages :rtype: nerodia.screenshot.Screenshot

selector_string()

x.__repr__() <==> repr(x)

send_keys(*args)

Sends sequence of keystrokes to currently active element :param args: keystrokes

static start(url, browser='chrome', *args, **kwargs)

Creates a Browser instance :param url: url to navigate to after starting browser :type url: str :param browser: firefox, ie, chrome, remote or Selenium WebDriver instance :type browser: selenium.webdriver.remote.webdriver.WebDriver or str :param args: args passed to the underlying driver :param kwargs: kwargs passed to the underlying driver

status

Returns the text of the status bar :return:

text

Returns the text of the page body :return:

timer

title

Returns the title of the current page :rtype: str

url

Returns the URL of the current page :rtype: str

wait(timeout=5)

Waits until the readyState of document is complete, raises a TimeoutException if timeout is exceeded :param timeout: time to wait :type timeout: int

wd

See also

See nerodia.container.Container for all possible element containers.

See also

See nerodia.has_window.HasWindow for accessing windows.

See also

See nerodia.wait.wait.Waitable for wait methods.

nerodia.container module

class nerodia.container.Container

Bases: object

abbr(*args, **kwargs)

abbrs(*args, **kwargs)

address(*args, **kwargs)

addresses(*args, **kwargs)

area(*args, **kwargs)

areas(*args, **kwargs)

article(*args, **kwargs)

articles(*args, **kwargs)

aside(*args, **kwargs)

asides(*args, **kwargs)

audio(*args, **kwargs)

audios(*args, **kwargs)

b(*args, **kwargs)

base(*args, **kwargs)

bases(*args, **kwargs)

bdi(*args, **kwargs)

bdis(*args, **kwargs)

bdo(*args, **kwargs)

bdos(*args, **kwargs)

blockquote(*args, **kwargs)

blockquotes(*args, **kwargs)

body(*args, **kwargs)

bodys(*args, **kwargs)

br(*args, **kwargs)

brs(*args, **kwargs)

bs(*args, **kwargs)

button(*args, **kwargs)

buttons(*args, **kwargs)

canvas(*args, **kwargs)

canvases(*args, **kwargs)

caption(*args, **kwargs)

captions(*args, **kwargs)

checkbox(*args, **kwargs)

checkboxes(*args, **kwargs)

circle(*args, **kwargs)

circles(*args, **kwargs)

cite(*args, **kwargs)

cites(*args, **kwargs)

code(*args, **kwargs)

codes(*args, **kwargs)

col(*args, **kwargs)

colgroup(*args, **kwargs)

colgroups(*args, **kwargs)

cols(*args, **kwargs)

data(*args, **kwargs)

datalist(*args, **kwargs)

datalists(*args, **kwargs)

datas(*args, **kwargs)

date_field(*args, **kwargs)

date_fields(*args, **kwargs)

date_time_field(*args, **kwargs)

date_time_fields(*args, **kwargs)

dd(*args, **kwargs)

dds(*args, **kwargs)

defs(*args, **kwargs)

defss(*args, **kwargs)

delete(*args, **kwargs)

deletes(*args, **kwargs)

desc(*args, **kwargs)

descs(*args, **kwargs)

details(*args, **kwargs)

detailses(*args, **kwargs)

dfn(*args, **kwargs)

dfns(*args, **kwargs)

dialog(*args, **kwargs)

dialogs(*args, **kwargs)

div(*args, **kwargs)

divs(*args, **kwargs)

dl(*args, **kwargs)

dls(*args, **kwargs)

dt(*args, **kwargs)

dts(*args, **kwargs)

element(*args, **kwargs)

elements(*args, **kwargs)

ellipse(*args, **kwargs)

ellipses(*args, **kwargs)

em(*args, **kwargs)

embed(*args, **kwargs)

embeds(*args, **kwargs)

ems(*args, **kwargs)

field_set(*args, **kwargs)

field_sets(*args, **kwargs)

fieldset(*args, **kwargs)

fieldsets(*args, **kwargs)

figcaption(*args, **kwargs)

figcaptions(*args, **kwargs)

figure(*args, **kwargs)

figures(*args, **kwargs)

file_field(*args, **kwargs)

file_fields(*args, **kwargs)

font(*args, **kwargs)

fonts(*args, **kwargs)

footer(*args, **kwargs)

footers(*args, **kwargs)

foreign_object(*args, **kwargs)

foreign_objects(*args, **kwargs)

form(*args, **kwargs)

forms(*args, **kwargs)

frame(*args, **kwargs)

frames(*args, **kwargs)

frameset(*args, **kwargs)

framesets(*args, **kwargs)

g(*args, **kwargs)

gs(*args, **kwargs)

h1(*args, **kwargs)

h1s(*args, **kwargs)

h2(*args, **kwargs)

h2s(*args, **kwargs)

h3(*args, **kwargs)

h3s(*args, **kwargs)

h4(*args, **kwargs)

h4s(*args, **kwargs)

h5(*args, **kwargs)

h5s(*args, **kwargs)

h6(*args, **kwargs)

h6s(*args, **kwargs)

head(*args, **kwargs)

header(*args, **kwargs)

headers(*args, **kwargs)

heads(*args, **kwargs)

hgroup(*args, **kwargs)

hgroups(*args, **kwargs)

hidden(*args, **kwargs)

hiddens(*args, **kwargs)

hr(*args, **kwargs)

hrs(*args, **kwargs)

html(*args, **kwargs)

htmls(*args, **kwargs)

iframe(*args, **kwargs)

iframes(*args, **kwargs)

image(*args, **kwargs)

images(*args, **kwargs)

img(*args, **kwargs)

imgs(*args, **kwargs)

input(*args, **kwargs)

inputs(*args, **kwargs)

ins(*args, **kwargs)

inses(*args, **kwargs)

ital(*args, **kwargs)

itals(*args, **kwargs)

kbd(*args, **kwargs)

kbds(*args, **kwargs)

label(*args, **kwargs)

labels(*args, **kwargs)

legend(*args, **kwargs)

legends(*args, **kwargs)

li(*args, **kwargs)

line(*args, **kwargs)

linear_gradient(*args, **kwargs)

linear_gradients(*args, **kwargs)

lines(*args, **kwargs)

link(*args, **kwargs)

links(*args, **kwargs)

lis(*args, **kwargs)

main(*args, **kwargs)

mains(*args, **kwargs)

map(*args, **kwargs)

maps(*args, **kwargs)

mark(*args, **kwargs)

marker(*args, **kwargs)

markers(*args, **kwargs)

marks(*args, **kwargs)

meta(*args, **kwargs)

metadata(*args, **kwargs)

metadatas(*args, **kwargs)

metas(*args, **kwargs)

meter(*args, **kwargs)

meters(*args, **kwargs)

nav(*args, **kwargs)

navs(*args, **kwargs)

noscript(*args, **kwargs)

noscripts(*args, **kwargs)

object(*args, **kwargs)

objects(*args, **kwargs)

ol(*args, **kwargs)

ols(*args, **kwargs)

optgroup(*args, **kwargs)

optgroups(*args, **kwargs)

option(*args, **kwargs)

options(*args, **kwargs)

output(*args, **kwargs)

outputs(*args, **kwargs)

p(*args, **kwargs)

param(*args, **kwargs)

params(*args, **kwargs)

path(*args, **kwargs)

paths(*args, **kwargs)

pattern(*args, **kwargs)

patterns(*args, **kwargs)

polygon(*args, **kwargs)

polygons(*args, **kwargs)

polyline(*args, **kwargs)

polylines(*args, **kwargs)

pre(*args, **kwargs)

pres(*args, **kwargs)

progress(*args, **kwargs)

progresses(*args, **kwargs)

ps(*args, **kwargs)

q(*args, **kwargs)

qs(*args, **kwargs)

radial_gradient(*args, **kwargs)

radial_gradients(*args, **kwargs)

radio(*args, **kwargs)

radio_set(*args, **kwargs)

radios(*args, **kwargs)

rp(*args, **kwargs)

rps(*args, **kwargs)

rt(*args, **kwargs)

rts(*args, **kwargs)

rubies(*args, **kwargs)

ruby(*args, **kwargs)

s(*args, **kwargs)

samp(*args, **kwargs)

samps(*args, **kwargs)

script(*args, **kwargs)

scripts(*args, **kwargs)

section(*args, **kwargs)

sections(*args, **kwargs)

select(*args, **kwargs)

select_list(*args, **kwargs)

select_lists(*args, **kwargs)

selects(*args, **kwargs)

small(*args, **kwargs)

smalls(*args, **kwargs)

source(*args, **kwargs)

sources(*args, **kwargs)

span(*args, **kwargs)

spans(*args, **kwargs)

ss(*args, **kwargs)

stop(*args, **kwargs)

stops(*args, **kwargs)

strong(*args, **kwargs)

strongs(*args, **kwargs)

style(*args, **kwargs)

styles(*args, **kwargs)

sub(*args, **kwargs)

subs(*args, **kwargs)

summaries(*args, **kwargs)

summary(*args, **kwargs)

sup(*args, **kwargs)

sups(*args, **kwargs)

svg(*args, **kwargs)

svgs(*args, **kwargs)

switch(*args, **kwargs)

switches(*args, **kwargs)

symbol(*args, **kwargs)

symbols(*args, **kwargs)

table(*args, **kwargs)

tables(*args, **kwargs)

tbody(*args, **kwargs)

tbodys(*args, **kwargs)

td(*args, **kwargs)

tds(*args, **kwargs)

template(*args, **kwargs)

templates(*args, **kwargs)

text_field(*args, **kwargs)

text_fields(*args, **kwargs)

text_path(*args, **kwargs)

text_paths(*args, **kwargs)

textarea(*args, **kwargs)

textareas(*args, **kwargs)

tfoot(*args, **kwargs)

tfoots(*args, **kwargs)

th(*args, **kwargs)

thead(*args, **kwargs)

theads(*args, **kwargs)

ths(*args, **kwargs)

time(*args, **kwargs)

times(*args, **kwargs)

title(*args, **kwargs)

titles(*args, **kwargs)

tr(*args, **kwargs)

track(*args, **kwargs)

tracks(*args, **kwargs)

trs(*args, **kwargs)

tspan(*args, **kwargs)

tspans(*args, **kwargs)

u(*args, **kwargs)

ul(*args, **kwargs)

uls(*args, **kwargs)

us(*args, **kwargs)

var(*args, **kwargs)

vars(*args, **kwargs)

video(*args, **kwargs)

videos(*args, **kwargs)

view(*args, **kwargs)

views(*args, **kwargs)

wbr(*args, **kwargs)

wbrs(*args, **kwargs)

nerodia.cookies module

class nerodia.cookies.Cookies(driver)

Bases: object

add(name, value, **kwargs)

Adds new cookie

Example:

browser.cookies.add(‘my_session’, ‘BAh7B0kiD3Nlc3Npb25faWQGOgZFRkk’, domain=’mysite.com’)

clear()

Deletes all cookies

delete(name)

Deletes cookie by given name

load(file='.cookies')

Loads cookies from file

Parameters:file – file path Example:

browser.cookies.load(‘.cookies’)

save(file='.cookies')

Save cookies to file

Parameters:file – file path Example:

browser.cookies.save(‘.cookies’)

to_list

nerodia.element_collection module

class nerodia.element_collection.ElementCollection(query_scope, selector)

Bases: nerodia.locators.class_helpers.ClassHelpers, nerodia.js_snippet.JSSnippet

browser

Returns the browser of the current query_scope

Return type:nerodia.browser.Browser

build()

eql(other)

Returns true if two element collections are equal.

Parameters:other – other collection Return type:bool Example:

browser.select_list(name=’new_user_languages’).options == browser.select_list(id=’new_user_languages’).options #=> True

browser.select_list(name=;new_user_role’).options == browser.select_list(id=’new_user_languages’).options #=> false

is_empty

Returns True if no elements are found

Example:

browser.select_list(name=’new_user_languages’).options(class_name=’not_here’).is_empty

Example:

browser.select_list(name=’new_user_languages’).options(id=’danish’).is_empty

Returns:True if no elements are found Return type:bool

locate()

Locate all elements and return self

Return type:ElementCollection

to_list

This collection as a list

Return type:list[nerodia.elements.element.Element]

nerodia.has_window module

class nerodia.has_window.HasWindow

Bases: object

original_window

Returns original window if defined, current window if not :rtype: Window

Example:

browser.window(title=’closeable window’).use() browser.original_window.use()

window(*args, **kwargs)

Returns browser window :rtype: Window

Example:

browser.window(title=’closeable window’)

windows(*args, **kwargs)

Returns browser windows list :rtype: list[Window]

Example:

browser.windows(title=’closeable window’)

nerodia.logger module

class nerodia.logger.Logger

Bases: object

deprecate(old, new, reference=None, ids=None)

filename

ignore(*ids)

level

warn(msg, ids=None, *args, **kwargs)

warning(msg, ids=None, *args, **kwargs)

nerodia.screenshot module

class nerodia.screenshot.Screenshot(browser)

Bases: object

base64()

Represents screenshot as Base64 encoded string :rtype: str

Example:

browser.screenshot.base64 #=> ‘7HWJ43tZDscPleeUuPW6HhN3x+z7vU/lufmH0qNTtTum94IBWMT46evImci1vnFGT’

png()

Represents screenshot as PNG image string :rtype: str

Example:

browser.screenshot.png #=> ‘•ÇŒ@1À7

(Edb² L’

save(path)

Saves screenshot to given path :param path: file path

Example:

browser.screenshot.save(‘screenshot.png’)

nerodia.window module

class nerodia.window.Dimension(width=None, height=None)

Bases: object

height

width

class nerodia.window.Point(x=None, y=None)

Bases: object

x

y

class nerodia.window.Window(browser, selector)

Bases: nerodia.wait.wait.Waitable

assert_exists()

close()

Closes the window

eql(other)

Returns True if two windows are equal :param other: the other window :rtype: bool

Example:

browser.window(index=0) == browser.window(index=1) #=> False

exist

Returns True if the window exists :rtype: bool

exists

Returns True if the window exists :rtype: bool

handle

is_current

Returns True if the window is current

Example:

browse.window.is_current

Return type:bool

locate()

maximize()

Maximizes window

Example:

browser.window().maximize()

move_to(x, y)

Moves window to given x and y coordinates :param x: horizontal position :param y: vertical position

Example:

browser.window().move_to(300, 200)

position

Returns window position :rtype: dict

Example:

browser.window().position #=> {x: 92, y: 76}

present

Returns True if the window exists :rtype: bool

resize_to(width, height)

Resizes window to given width and height :param width: width to resize to :param height: height to resize to

Example:

browser.window().resize_to(1600, 1200)

selector_string

size

Returns window size :rtype: dict

Example:

browser.window().size #=> {width: 1600, height: 1200}

title

Returns the window title :rtype: str

unuse()

Returns to the original window

Example:

window = browser.window(title=’closeable window’).use() window.unuse() :rtype: Window

url

Returns the window URL :rtype: str

use()

Switches to given window

Example:

browser.window(title=’closeable window’).use() :rtype: Window

wait_for_exists()