airgun.entities.bookmark

Module Contents

Classes

BookmarkEntity

ShowAllBookmarks

Navigate to All Bookmarks screen.

EditBookmark

Navigate to Edit Bookmark screen.

Functions

_gen_queries(entity_name[, controller])

Generate search query and row filtering query from bookmark name and

airgun.entities.bookmark._gen_queries(entity_name, controller=None)

Generate search query and row filtering query from bookmark name and controller if passed.

class airgun.entities.bookmark.BookmarkEntity(browser)
endpoint_path = /bookmarks
delete(entity_name, controller=None)

Delete existing bookmark

search(query)

Search for bookmark

read(entity_name, controller=None, widget_names=None)

Read bookmark values

update(entity_name, values, controller=None)

Update existing bookmark

class airgun.entities.bookmark.ShowAllBookmarks(obj, navigate_obj, logger=None)

Navigate to All Bookmarks screen.

VIEW
step(*args, **kwargs)

Describes the work to be done to get to the destination after the prequisite is met.

This is a default and is generally overridden.

class airgun.entities.bookmark.EditBookmark(obj, navigate_obj, logger=None)

Navigate to Edit Bookmark screen.

VIEW
prerequisite(*args, **kwargs)

Describes a step that must be carried our prior to this one.

This often calls a previous navigate_to, often using one of the helpers, NavigateToSibling which will navigate to a given destination using the same object, or NavigateToAttribute which will navigate to a destination against an object describe by the attribute of the parent object.

This is a default and is generally overridden.

step(*args, **kwargs)

Using a given entity_name, navigate to edit page from prerequisite

Parameters
  • entity_name – name of bookmark

  • controller – (optional) name of controller for bookmark