Module pom_elements.html

The Python package pom-elements.html module is for interacting with html Elements.

pom-elements.html extends the XPathElement class to improve the pom-elements experience writing tests for DOM elements. Refer to the Mozilla HTML Elements reference documentation. https://developer.mozilla.org/en-US/docs/Web/HTML/Element

Expand source code
"""The Python package `pom-elements.html` module is for interacting with html Elements.

`pom-elements.html` extends the XPathElement class to improve the `pom-elements`
experience writing tests for DOM elements. Refer to the Mozilla HTML Elements reference
documentation. https://developer.mozilla.org/en-US/docs/Web/HTML/Element
"""
from .content import H1, H2, H3, H4, H5, H6
from .forms import (
    Button,
    DataList,
    Fieldset,
    Form,
    Input,
    Label,
    Legend,
    Meter,
    OptGroup,
    Option,
    Select,
    TextArea,
)
from .inline_text import (
    Cite,
    Code,
    Highlight,
    InlineQuote,
    Link,
    Span,
    Subscript,
    Superscript,
)
from .media_and_embedded import Area, Iframe, Img, Picture, Source, Video
from .table_content import (
    Caption,
    Col,
    ColGroup,
    Table,
    TableData,
    TableFooter,
    TableHead,
    TableHeader,
    TableRow,
)
from .text import DD, DT, OL, UL, Div, P, Quote

__all__ = [
    "H1",
    "H2",
    "H3",
    "H4",
    "H5",
    "H6",
    "Link",
    "P",
    "Div",
    "Quote",
    "DT",
    "DD",
    "OL",
    "UL",
    "Link",
    "Cite",
    "Code",
    "Highlight",
    "InlineQuote",
    "Span",
    "Subscript",
    "Superscript",
    "Area",
    "Img",
    "Video",
    "Iframe",
    "Picture",
    "Source",
    "Caption",
    "Col",
    "ColGroup",
    "Table",
    "TableData",
    "TableFooter",
    "TableHead",
    "TableHeader",
    "TableRow",
    "Button",
    "DataList",
    "Fieldset",
    "Form",
    "Input",
    "Label",
    "Legend",
    "Meter",
    "OptGroup",
    "Option",
    "Select",
    "TextArea",
]

Sub-modules

pom_elements.html.content
pom_elements.html.forms
pom_elements.html.inline_text
pom_elements.html.media_and_embedded
pom_elements.html.table_content
pom_elements.html.text

Classes

class Area (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with html tags.

Expand source code
class Area(XPathElement):
    """Interact with <area> html tags."""

    tag = "area"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class Button (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with

Expand source code
class Button(XPathElement):
    """Interact with <button> html dom elements."""

    tag = "button"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class Caption (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with the html elment.

Expand source code
class Caption(XPathElement):
    """Interact with the <caption> html elment."""

    tag = "caption"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class Cite (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with tags.

Expand source code
class Cite(XPathElement):
    """Interact with <cite> tags."""

    tag = "cite"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class Code (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with tags.

Expand source code
class Code(XPathElement):
    """Interact with <code> tags."""

    tag = "code"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class Col (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with the html elment.

Expand source code
class Col(XPathElement):
    """Interact with the <col> html elment."""

    tag = "col"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class ColGroup (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with the html elment.

Expand source code
class ColGroup(XPathElement):
    """Interact with the <colgroup> html elment."""

    tag = "colgroup"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class DD (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with

tags.

Expand source code
class DD(XPathElement):
    """Interact with <dd> tags."""

    tag = "dd"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class DT (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with

tags.

Expand source code
class DT(XPathElement):
    """Interact with <dt> tags."""

    tag = "dt"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class DataList (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with html dom elements.

Expand source code
class DataList(XPathElement):
    """Interact with <datalist> html dom elements."""

    tag = "datalist"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class Div (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with

tags.

Expand source code
class Div(XPathElement):
    """Interact with <div> tags."""

    tag = "div"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class Fieldset (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with

html dom elements.

Expand source code
class Fieldset(XPathElement):
    """Interact with <fieldset> html dom elements."""

    tag = "fieldset"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class Form (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with

html dom elements.

Expand source code
class Form(XPathElement):
    """Interact with <form> html dom elements."""

    tag = "form"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class H1 (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with

tags.

Expand source code
class H1(XPathElement):
    """Interact with <h1> tags."""

    tag = "h1"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class H2 (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with

tags.

Expand source code
class H2(XPathElement):
    """Interact with <h2> tags."""

    tag = "h2"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class H3 (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with

tags.

Expand source code
class H3(XPathElement):
    """Interact with <h3> tags."""

    tag = "h3"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class H4 (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with

tags.

Expand source code
class H4(XPathElement):
    """Interact with <h4> tags."""

    tag = "h4"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class H5 (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with

tags.

Expand source code
class H5(XPathElement):
    """Interact with <h5> tags."""

    tag = "h5"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class H6 (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with

tags.

Expand source code
class H6(XPathElement):
    """Interact with <h6> tags."""

    tag = "h6"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class Highlight (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with tags.

Expand source code
class Highlight(XPathElement):
    """Interact with <mark> tags."""

    tag = "mark"

Ancestors

Class variables

var tag

Inherited from: XPathElement.tag

tag class attribute is the xpath html tag (i.e. div, span, ul).

Instance variables

var default_timeout

Inherited from: XPathElement.default_timeout

Get the default timeout.

var locator : Tuple[selenium.webdriver.common.by.By, str]

Inherited from: XPathElement.locator

Return the Xpath Locator element.

var webdriver

Inherited from: XPathElement.webdriver

Get the Element's Selenium webdriver instance …

var xpath : str

Inherited from: XPathElement.xpath

Get the xpath value as a string.

Methods

def can_be_clicked(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.can_be_clicked

Return true if the webelement can be clicked in the time (seconds) provided …

def click(self, timeout: Union[float, NoneType] = None)

Inherited from: XPathElement.click

Click the web element if it is available to be clicked.

def find(self, timeout: Union[float, NoneType] = None) -> selenium.webdriver.remote.webelement.WebElement

Inherited from: XPathElement.find

Return the Selenium WebElement in the provided timeout or raise an error …

def get_all_attributes(self) -> dict

Inherited from: XPathElement.get_all_attributes

Return a dictionary containing all of the attributes of an element.

def get_attribute(self, name)

Inherited from: XPathElement.get_attribute

Returns the attribute of the name provided.

def get_property(self, value: str) -> Any

Inherited from: XPathElement.get_property

Get the property of the element …

def is_displayed(self)

Inherited from: XPathElement.is_displayed

Returns true if the Element is displayed else false.

def is_invisible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_invisible

Return true if the webelement is invisible on the page within the time (seconds) provided …

def is_visible(self, timeout: Union[int, NoneType] = None) -> bool

Inherited from: XPathElement.is_visible

Return true if the webelement is visible on the page in the time (seconds) provided …

class Iframe (webdriver:  = None, timeout: int = 5, xpath: str = '', **kwargs)

Interact with