def get_clickable_element_by_js(locator, **kwargs):
web_elements = element.get_visible_elements_from_elements(
javascript.get_clickable(locator), **kwargs)
if web_elements:
logger.debug('Found elements by js: {}'.format(web_elements))
return web_elements
return None
def get_checkbox_by_css_selector(locator, anchor, index, **kwargs):
"""Get checkbox using css selectors."""
checkbox_elements = []
partial_matches = []
css = '[type="checkbox"], [role="checkbox"]'
if 'qweb_old' not in kwargs:
full_matches, partial_matches = element.get_elements_by_css(
locator, css, **kwargs)
if full_matches:
checkbox_elements = element.get_visible_elements_from_elements(
full_matches, **kwargs)
if checkbox_elements:
return checkbox_elements[index], None
try:
locator_element = text.get_text_using_anchor(locator, anchor)
checkbox_elements = list(
dict.fromkeys(
element.get_element_from_childnodes(locator_element, css, **
kwargs) + partial_matches))
return checkbox_elements[index], locator_element
except QWebElementNotFoundError:
logger.trace(
'Element not found by visible text. Trying with partial match')
checkbox_elements = partial_matches
if checkbox_elements:
logger.debug("Found element {}, index {}".format(
checkbox_elements, index))
return checkbox_elements[index], None
return None, None
def check_all_nodes(text, **kwargs):
try:
return element.get_visible_elements_from_elements(
javascript.find_text_from_textnodes(text, **kwargs))
except (WebDriverException, NoSuchFrameException, JavascriptException,
QWebStalingElementError) as e:
logger.info('Got {} from check all nodes'.format(e))
return None
def verify_no_element(xpath, timeout=0, **kwargs): # pylint: disable=unused-argument
r"""Wait element can not be found on the page.
Examples
--------
.. code-block:: robotframework
VerifyNoElement //*[@id\="do_not_wait_me"]
This keyword has timeout functionality. If the element is still visible after
given timeout, error is raised.
For example.
.. code-block:: robotframework
VerifyNoElement //*[@id\="wait_me"] 20 #waits 20 seconds
Parameters
----------
xpath : str
Xpath expression without xpath= prefix. The equal sign "=" must be escaped with a "\\".
timeout : str | int
Timeout for the element to disappear. If the element is visible after
given timeout, error is raised. The str is converted to integer
using robot.utils.timestr_to_secs. (default 10 seconds)
kwargs :
| Accepted kwargs:
| tag : html tag of preferred elemenr -
| If tag is used then element is found
| by some of it's attribute (xpath is not needed)
| partial_match: True. If element is found by it's attribute set partial_match
| to True to allow partial match
Raises
------
NoSuchElementException
Page did contain the element
Related keywords
----------------
\`VerifyElement\`
"""
kwargs['element_kw'] = True
if 'tag' in kwargs:
web_elements = element.get_visible_elements_from_elements(
element.get_elements_by_attributes(kwargs.get('tag'), xpath,
**kwargs))
else:
web_elements = element.get_webelements(xpath)
if not web_elements:
return
raise QWebValueError(
'Page contained element with XPath "{}" after timeout'.format(xpath))
def verify_element(xpath, timeout=0, **kwargs): # pylint: disable=unused-argument
r"""Verify that element can be found on the page and it is visible.
Examples
--------
.. code-block:: robotframework
VerifyElement //*[@id\="wait_me"]
This keyword has timeout functionality. If the element is not visible after
given timeout, error is raised.
For example.
.. code-block:: robotframework
VerifyElement //*[@id\="wait_me"] 20 #waits 20 seconds
Parameters
----------
xpath : str
Xpath expression without xpath= prefix. The equal sign "=" must be escaped with a "\\".
timeout : str | int
Timeout for finding the element. If the element is not visible after
given timeout, error is raised. The str is converted to integer
using robot.utils.timestr_to_secs. (default 10 seconds)
kwargs :
| Accepted kwargs:
| tag : html tag of preferred elemenr -
| If tag is used then element is found
| by some of it's attribute (xpath is not needed)
| partial_match: True. If element is found by it's attribute set partial_match
| to True to allow partial match
Raises
------
QWebElementNotFoundError
Page did not contain element
Related keywords
----------------
\`ClickElement\`, \`GetAttribute\`, \`GetWebElement\`, \`GetElementCount\`,
\`VerifyItem\`, \`VerifyText\`
"""
kwargs['element_kw'] = True
if 'tag' in kwargs:
web_elements = element.get_visible_elements_from_elements(
element.get_elements_by_attributes(kwargs.get('tag'), xpath,
**kwargs))
else:
web_elements = element.get_webelements(xpath, **kwargs)
if web_elements:
return
raise QWebElementNotFoundError('No matching element found')
def _get_item_by_css(text, **kwargs):
"""
Allows partial match. Anchor has to be number.
:param text: str
Attribute value of the element
:return:
webelement that containing attribute with given value
"""
if 'partial_match' not in kwargs:
kwargs['partial_match'] = True
css = 'a, span, img, li, h1, h2, h3, h4, h5, h6, div, svg, p, button, input' \
':not([type="text"]):not([type="password"]):not([type="email"])'
full, partial = element.get_elements_by_attributes(css, text, **kwargs)
web_elements = element.get_visible_elements_from_elements(full + partial, **kwargs)
if web_elements:
return web_elements
return None
def get_webelement(locator,
anchor='1',
element_type=None,
timeout=0,
**kwargs):
r"""Get Webelement using any Paceword -stylish locator.
Examples
--------
Using attributes or xpaths like with ClickElement etc. kw:s without specified
element_type. If element_type is not specified end result is a type of list:
.. code-block:: robotframework
${list of elems} GetWebelement click_me tag=button
${list of elems} GetWebelement //*[@id\="click_me"]
${list of elems} GetWebelement xpath\=//*[@id\="click_me"]
Get element using element_type attribute to locate element.
Text elements works as ClickText, VerifyText, GetText etc.:
.. code-block:: robotframework
${elem} GetWebelement Log In element_type=text
${elem} GetWebelement Contact element_type=text anchor=Qentinel
${elem} GetWebelement Contact parent=div
Item, Input, Dropdown, Checkbox elements:
.. code-block:: robotframework
${elem} GetWebelement Log In element_type=item
${elem} GetWebelement Username element_type=input
${elem} GetWebelement Country element_type=dropdown
${elem} GetWebelement Gender element_type=checkbox
All flags are available for using (timeout, anchor, index, visibility, parent, child etc.).
in same way as you are using those with Pacewords like ClickText/Item, TypeText, Dropdown etc.
Parameters
----------
locator : str
Visible text, attribute value or Xpath expression with or without xpath= prefix.
The equal sign "=" must be escaped with a "\\".
anchor : int
Used when element_type is defined. Default=1 (first match)
element_type : string
Define element type/preferred searching method
(available types: text, input, checkbox, item, dropdown).
timeout : int
How long we wait element to appear. Default=10 sec
kwargs :
| Accepted kwargs:
| Any available for picked searching method.
| See interacting with text, item, input etc. elements from
| documentation
Related keywords
----------------
\`ClickElement\`, \`HoverElement\`, \`TypeText\`
"""
kwargs['index'] = kwargs.get('index', 1)
kwargs['timeout'] = timeout
if element_type:
if element_type.lower() == 'text':
return text.get_element_by_locator_text(locator, anchor, **kwargs)
if element_type.lower() == 'item':
return text.get_item_using_anchor(locator, anchor, **kwargs)
if element_type.lower() == "dropdown":
return dropdown.get_dd_elements_from_all_documents(
locator, anchor, **kwargs)
if element_type.lower() == "input":
return input_.get_input_elements_from_all_documents(
locator, anchor, **kwargs)
if element_type.lower() == "checkbox":
return checkbox.get_checkbox_elements_from_all_documents(
locator, anchor, **kwargs)
kwargs['element_kw'] = True
if 'tag' in kwargs:
web_elements = element.get_visible_elements_from_elements(
element.get_elements_by_attributes(kwargs.get('tag'), locator,
**kwargs))
else:
web_elements = element.get_webelements(locator)
if web_elements:
return web_elements
raise QWebElementNotFoundError('No matching element found')
def get_input_element_by_css_selector(locator,
anchor,
index=0,
enable_check=False,
**kwargs):
"""Get input element using css selectors.
Parameters
----------
locator : str
Label text or attribute that points to the input.
Looking for placeholder and commonly used tooltip-attributes first.
If locator is label text, finds input element by it's for attribute.
if for attribute is not available, then finds element by doing some
DOM traversing.
anchor : str
Text near the locator element or index. If placeholder or another
direct attribute (title, tooltip, value) exists then anchor
has to be index. Text is aloud when searching by label or some other
text which is near to input element.
index: int
If multiple input elements is nested or in same table cell, index is needed.
enable_check: bool
If enable_check is set to true returns first match even if disabled one.
Returns
-------
WebElement
"""
partial_matches = []
upload = kwargs.get('upload')
if upload:
try:
index = int(locator) - 1
kwargs['any_element'] = True
input_elements = element.get_elements_by_attributes(**kwargs)
if input_elements:
return input_elements[index]
except ValueError:
logger.debug('locator was text')
if 'qweb_old' not in kwargs:
full_matches, partial_matches = element.get_elements_by_css(
locator, **kwargs)
if full_matches:
input_element = element.get_visible_elements_from_elements(
full_matches, **kwargs)
if input_element and str(anchor) == '1':
input_element = input_element[index]
return input_element
if input_element:
input_element = text.get_element_using_anchor(
input_element, anchor, **kwargs)
return input_element
try:
locator_element = text.get_text_using_anchor(locator, anchor, **kwargs)
input_elements = list(
dict.fromkeys(
element.get_element_from_childnodes(locator_element, **kwargs)
+ partial_matches))
except QWebElementNotFoundError:
logger.trace(
'Element not found by visible text. Trying with partial match')
input_elements = partial_matches
if input_elements:
visibles = element.get_visible_elements_from_elements(
input_elements, **kwargs)
if visibles:
if element.is_enabled(visibles[index]) or enable_check is True:
return visibles[index]
return None
