diff --git a/docs/.buildinfo b/docs/.buildinfo
index 47147e5f8..01eab9d11 100644
--- a/docs/.buildinfo
+++ b/docs/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 3cf9e7e206365867c20458c8e1fc19f4
+config: e0d4238eb243be77f28fa5402bd1f588
tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_static/_sphinx_javascript_frameworks_compat.js b/docs/_static/_sphinx_javascript_frameworks_compat.js
index 81415803e..8549469dc 100644
--- a/docs/_static/_sphinx_javascript_frameworks_compat.js
+++ b/docs/_static/_sphinx_javascript_frameworks_compat.js
@@ -1,9 +1,20 @@
-/* Compatability shim for jQuery and underscores.js.
+/*
+ * _sphinx_javascript_frameworks_compat.js
+ * ~~~~~~~~~~
+ *
+ * Compatability shim for jQuery and underscores.js.
+ *
+ * WILL BE REMOVED IN Sphinx 6.0
+ * xref RemovedInSphinx60Warning
*
- * Copyright Sphinx contributors
- * Released under the two clause BSD licence
*/
+/**
+ * select a different prefix for underscore
+ */
+$u = _.noConflict();
+
+
/**
* small helper function to urldecode strings
*
diff --git a/docs/_static/basic.css b/docs/_static/basic.css
index f316efcb4..4e9a9f1fa 100644
--- a/docs/_static/basic.css
+++ b/docs/_static/basic.css
@@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -237,10 +237,6 @@ a.headerlink {
visibility: hidden;
}
-a:visited {
- color: #551A8B;
-}
-
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
@@ -328,7 +324,6 @@ aside.sidebar {
p.sidebar-title {
font-weight: bold;
}
-
nav.contents,
aside.topic,
div.admonition, div.topic, blockquote {
@@ -336,7 +331,6 @@ div.admonition, div.topic, blockquote {
}
/* -- topics ---------------------------------------------------------------- */
-
nav.contents,
aside.topic,
div.topic {
@@ -612,7 +606,6 @@ ol.simple p,
ul.simple p {
margin-bottom: 0;
}
-
aside.footnote > span,
div.citation > span {
float: left;
@@ -674,16 +667,6 @@ dd {
margin-left: 30px;
}
-.sig dd {
- margin-top: 0px;
- margin-bottom: 0px;
-}
-
-.sig dl {
- margin-top: 0px;
- margin-bottom: 0px;
-}
-
dl > dd:last-child,
dl > dd:last-child > :last-child {
margin-bottom: 0;
@@ -752,14 +735,6 @@ abbr, acronym {
cursor: help;
}
-.translated {
- background-color: rgba(207, 255, 207, 0.2)
-}
-
-.untranslated {
- background-color: rgba(255, 207, 207, 0.2)
-}
-
/* -- code displays --------------------------------------------------------- */
pre {
diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js
index 4d67807d1..527b876ca 100644
--- a/docs/_static/doctools.js
+++ b/docs/_static/doctools.js
@@ -4,7 +4,7 @@
*
* Base JavaScript utilities for all Sphinx HTML documentation.
*
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
index 89435bb41..995f333f6 100644
--- a/docs/_static/documentation_options.js
+++ b/docs/_static/documentation_options.js
@@ -1,4 +1,5 @@
-const DOCUMENTATION_OPTIONS = {
+var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '1.0.0',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
diff --git a/docs/_static/language_data.js b/docs/_static/language_data.js
index 367b8ed81..2e22b06ab 100644
--- a/docs/_static/language_data.js
+++ b/docs/_static/language_data.js
@@ -5,7 +5,7 @@
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -13,7 +13,7 @@
var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
-/* Non-minified version is copied as a separate JS file, if available */
+/* Non-minified version is copied as a separate JS file, is available */
/**
* Porter Stemmer
diff --git a/docs/_static/searchtools.js b/docs/_static/searchtools.js
index 92da3f8b2..e89e34d4e 100644
--- a/docs/_static/searchtools.js
+++ b/docs/_static/searchtools.js
@@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for the full-text search.
*
- * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -57,12 +57,12 @@ const _removeChildren = (element) => {
const _escapeRegExp = (string) =>
string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
-const _displayItem = (item, searchTerms, highlightTerms) => {
+const _displayItem = (item, searchTerms) => {
const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
+ const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT;
const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
- const contentRoot = document.documentElement.dataset.content_root;
const [docName, title, anchor, descr, score, _filename] = item;
@@ -75,35 +75,28 @@ const _displayItem = (item, searchTerms, highlightTerms) => {
if (dirname.match(/\/index\/$/))
dirname = dirname.substring(0, dirname.length - 6);
else if (dirname === "index/") dirname = "";
- requestUrl = contentRoot + dirname;
+ requestUrl = docUrlRoot + dirname;
linkUrl = requestUrl;
} else {
// normal html builders
- requestUrl = contentRoot + docName + docFileSuffix;
+ requestUrl = docUrlRoot + docName + docFileSuffix;
linkUrl = docName + docLinkSuffix;
}
let linkEl = listItem.appendChild(document.createElement("a"));
linkEl.href = linkUrl + anchor;
linkEl.dataset.score = score;
linkEl.innerHTML = title;
- if (descr) {
+ if (descr)
listItem.appendChild(document.createElement("span")).innerHTML =
" (" + descr + ")";
- // highlight search terms in the description
- if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
- highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
- }
else if (showSearchSummary)
fetch(requestUrl)
.then((responseData) => responseData.text())
.then((data) => {
if (data)
listItem.appendChild(
- Search.makeSearchSummary(data, searchTerms, anchor)
+ Search.makeSearchSummary(data, searchTerms)
);
- // highlight search terms in the summary
- if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
- highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
});
Search.output.appendChild(listItem);
};
@@ -116,43 +109,26 @@ const _finishSearch = (resultCount) => {
);
else
Search.status.innerText = _(
- "Search finished, found ${resultCount} page(s) matching the search query."
- ).replace('${resultCount}', resultCount);
+ `Search finished, found ${resultCount} page(s) matching the search query.`
+ );
};
const _displayNextItem = (
results,
resultCount,
- searchTerms,
- highlightTerms,
+ searchTerms
) => {
// results left, load the summary and display it
// this is intended to be dynamic (don't sub resultsCount)
if (results.length) {
- _displayItem(results.pop(), searchTerms, highlightTerms);
+ _displayItem(results.pop(), searchTerms);
setTimeout(
- () => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
+ () => _displayNextItem(results, resultCount, searchTerms),
5
);
}
// search finished, update title and status message
else _finishSearch(resultCount);
};
-// Helper function used by query() to order search results.
-// Each input is an array of [docname, title, anchor, descr, score, filename].
-// Order the results by score (in opposite order of appearance, since the
-// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically.
-const _orderResultsByScoreThenName = (a, b) => {
- const leftScore = a[4];
- const rightScore = b[4];
- if (leftScore === rightScore) {
- // same score: sort alphabetically
- const leftTitle = a[1].toLowerCase();
- const rightTitle = b[1].toLowerCase();
- if (leftTitle === rightTitle) return 0;
- return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
- }
- return leftScore > rightScore ? 1 : -1;
-};
/**
* Default splitQuery function. Can be overridden in ``sphinx.search`` with a
@@ -176,26 +152,13 @@ const Search = {
_queued_query: null,
_pulse_status: -1,
- htmlToText: (htmlString, anchor) => {
+ htmlToText: (htmlString) => {
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
- for (const removalQuery of [".headerlinks", "script", "style"]) {
- htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
- }
- if (anchor) {
- const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`);
- if (anchorContent) return anchorContent.textContent;
-
- console.warn(
- `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`
- );
- }
-
- // if anchor not specified or not found, fall back to main content
+ htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() });
const docContent = htmlElement.querySelector('[role="main"]');
- if (docContent) return docContent.textContent;
-
+ if (docContent !== undefined) return docContent.textContent;
console.warn(
- "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template."
+ "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template."
);
return "";
},
@@ -268,7 +231,16 @@ const Search = {
else Search.deferQuery(query);
},
- _parseQuery: (query) => {
+ /**
+ * execute search (requires search index to be loaded)
+ */
+ query: (query) => {
+ const filenames = Search._index.filenames;
+ const docNames = Search._index.docnames;
+ const titles = Search._index.titles;
+ const allTitles = Search._index.alltitles;
+ const indexEntries = Search._index.indexentries;
+
// stem the search terms and add them to the correct list
const stemmer = new Stemmer();
const searchTerms = new Set();
@@ -304,32 +276,16 @@ const Search = {
// console.info("required: ", [...searchTerms]);
// console.info("excluded: ", [...excludedTerms]);
- return [query, searchTerms, excludedTerms, highlightTerms, objectTerms];
- },
-
- /**
- * execute search (requires search index to be loaded)
- */
- _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => {
- const filenames = Search._index.filenames;
- const docNames = Search._index.docnames;
- const titles = Search._index.titles;
- const allTitles = Search._index.alltitles;
- const indexEntries = Search._index.indexentries;
-
- // Collect multiple result groups to be sorted separately and then ordered.
- // Each is an array of [docname, title, anchor, descr, score, filename].
- const normalResults = [];
- const nonMainIndexResults = [];
-
+ // array of [docname, title, anchor, descr, score, filename]
+ let results = [];
_removeChildren(document.getElementById("search-progress"));
- const queryLower = query.toLowerCase().trim();
+ const queryLower = query.toLowerCase();
for (const [title, foundTitles] of Object.entries(allTitles)) {
- if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
+ if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) {
for (const [file, id] of foundTitles) {
let score = Math.round(100 * queryLower.length / title.length)
- normalResults.push([
+ results.push([
docNames[file],
titles[file] !== title ? `${titles[file]} > ${title}` : title,
id !== null ? "#" + id : "",
@@ -344,47 +300,46 @@ const Search = {
// search for explicit entries in index directives
for (const [entry, foundEntries] of Object.entries(indexEntries)) {
if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
- for (const [file, id, isMain] of foundEntries) {
- const score = Math.round(100 * queryLower.length / entry.length);
- const result = [
+ for (const [file, id] of foundEntries) {
+ let score = Math.round(100 * queryLower.length / entry.length)
+ results.push([
docNames[file],
titles[file],
id ? "#" + id : "",
null,
score,
filenames[file],
- ];
- if (isMain) {
- normalResults.push(result);
- } else {
- nonMainIndexResults.push(result);
- }
+ ]);
}
}
}
// lookup as object
objectTerms.forEach((term) =>
- normalResults.push(...Search.performObjectSearch(term, objectTerms))
+ results.push(...Search.performObjectSearch(term, objectTerms))
);
// lookup as search terms in fulltext
- normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms));
+ results.push(...Search.performTermsSearch(searchTerms, excludedTerms));
// let the scorer override scores with a custom scoring function
- if (Scorer.score) {
- normalResults.forEach((item) => (item[4] = Scorer.score(item)));
- nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item)));
- }
-
- // Sort each group of results by score and then alphabetically by name.
- normalResults.sort(_orderResultsByScoreThenName);
- nonMainIndexResults.sort(_orderResultsByScoreThenName);
-
- // Combine the result groups in (reverse) order.
- // Non-main index entries are typically arbitrary cross-references,
- // so display them after other results.
- let results = [...nonMainIndexResults, ...normalResults];
+ if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item)));
+
+ // now sort the results by score (in opposite order of appearance, since the
+ // display function below uses pop() to retrieve items) and then
+ // alphabetically
+ results.sort((a, b) => {
+ const leftScore = a[4];
+ const rightScore = b[4];
+ if (leftScore === rightScore) {
+ // same score: sort alphabetically
+ const leftTitle = a[1].toLowerCase();
+ const rightTitle = b[1].toLowerCase();
+ if (leftTitle === rightTitle) return 0;
+ return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
+ }
+ return leftScore > rightScore ? 1 : -1;
+ });
// remove duplicate search results
// note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
@@ -398,19 +353,14 @@ const Search = {
return acc;
}, []);
- return results.reverse();
- },
-
- query: (query) => {
- const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query);
- const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms);
+ results = results.reverse();
// for debugging
//Search.lastresults = results.slice(); // a copy
// console.info("search results:", Search.lastresults);
// print the results
- _displayNextItem(results, results.length, searchTerms, highlightTerms);
+ _displayNextItem(results, results.length, searchTerms);
},
/**
@@ -508,18 +458,14 @@ const Search = {
// add support for partial matches
if (word.length > 2) {
const escapedWord = _escapeRegExp(word);
- if (!terms.hasOwnProperty(word)) {
- Object.keys(terms).forEach((term) => {
- if (term.match(escapedWord))
- arr.push({ files: terms[term], score: Scorer.partialTerm });
- });
- }
- if (!titleTerms.hasOwnProperty(word)) {
- Object.keys(titleTerms).forEach((term) => {
- if (term.match(escapedWord))
- arr.push({ files: titleTerms[term], score: Scorer.partialTitle });
- });
- }
+ Object.keys(terms).forEach((term) => {
+ if (term.match(escapedWord) && !terms[word])
+ arr.push({ files: terms[term], score: Scorer.partialTerm });
+ });
+ Object.keys(titleTerms).forEach((term) => {
+ if (term.match(escapedWord) && !titleTerms[word])
+ arr.push({ files: titleTerms[word], score: Scorer.partialTitle });
+ });
}
// no match but word was a required one
@@ -542,8 +488,9 @@ const Search = {
// create the mapping
files.forEach((file) => {
- if (!fileMap.has(file)) fileMap.set(file, [word]);
- else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word);
+ if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1)
+ fileMap.get(file).push(word);
+ else fileMap.set(file, [word]);
});
});
@@ -594,8 +541,8 @@ const Search = {
* search summary for a given text. keywords is a list
* of stemmed words.
*/
- makeSearchSummary: (htmlText, keywords, anchor) => {
- const text = Search.htmlToText(htmlText, anchor);
+ makeSearchSummary: (htmlText, keywords) => {
+ const text = Search.htmlToText(htmlText);
if (text === "") return null;
const textLower = text.toLowerCase();
diff --git a/docs/_static/sphinx_highlight.js b/docs/_static/sphinx_highlight.js
index 8a96c69a1..aae669d7e 100644
--- a/docs/_static/sphinx_highlight.js
+++ b/docs/_static/sphinx_highlight.js
@@ -29,19 +29,14 @@ const _highlight = (node, addItems, text, className) => {
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
- const rest = document.createTextNode(val.substr(pos + text.length));
parent.insertBefore(
span,
parent.insertBefore(
- rest,
+ document.createTextNode(val.substr(pos + text.length)),
node.nextSibling
)
);
node.nodeValue = val.substr(0, pos);
- /* There may be more occurrences of search term in this node. So call this
- * function recursively on the remaining fragment.
- */
- _highlight(rest, addItems, text, className);
if (isInSVG) {
const rect = document.createElementNS(
@@ -145,10 +140,5 @@ const SphinxHighlight = {
},
};
-_ready(() => {
- /* Do not call highlightSearchWords() when we are on the search page.
- * It will highlight words from the *previous* search query.
- */
- if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
- SphinxHighlight.initEscapeListener();
-});
+_ready(SphinxHighlight.highlightSearchWords);
+_ready(SphinxHighlight.initEscapeListener);
diff --git a/docs/base.html b/docs/base.html
index 27ccbd70b..62add7c58 100644
--- a/docs/base.html
+++ b/docs/base.html
@@ -1,23 +1,24 @@
-
+
-
+
Base — TIR 1.0.0 documentation
-
-
+
+
-
-
-
-
-
+
+
+
+
+
+
@@ -129,10 +130,10 @@
-Base
+Base
-class tir.technologies.core.base. Base ( config_path = '' , autostart = True )
+class tir.technologies.core.base. Base ( config_path = '' , autostart = True )
Base class for any technology to implement Selenium Interface Tests.
This class instantiates the browser, reads the config file and prepares the log.
If no config_path is passed, it will read the config.json file that exists in the same
@@ -157,7 +158,7 @@
-AssertFalse ( expected , message )
+AssertFalse ( expected , message )
Defines that the test case expects a False response to pass
Usage:
>>> #Calling the method
@@ -168,7 +169,7 @@
-AssertTrue ( expected , message )
+AssertTrue ( expected , message )
Defines that the test case expects a True response to pass
Usage:
>>> #Calling the method
@@ -179,7 +180,7 @@
-SetTIRConfig ( config_name , value )
+SetTIRConfig ( config_name , value )
Changes a value of a TIR internal config during runtime.
This could be useful for TestCases that must use a different set of configs
than the ones defined at config.json
@@ -216,7 +217,7 @@
-Start ( )
+Start ( )
Opens the browser maximized and goes to defined URL.
Usage:
>>> # Calling the method:
@@ -227,7 +228,7 @@
-TearDown ( )
+TearDown ( )
Closes the webdriver and ends the test case.
Usage:
>>> #Calling the method
@@ -238,7 +239,7 @@
-assert_result ( expected , script_message = '' )
+assert_result ( expected , script_message = '' )
[Internal]
Asserts the result based on the expected value.
@@ -255,7 +256,7 @@
-click ( element , click_type = ClickType.JS , right_click = False )
+click ( element , click_type = ClickType.JS , right_click = False )
[Internal]
Clicks on the Selenium element.
Supports three types of clicking: JavaScript, pure Selenium and Selenium’s ActionChains.
@@ -271,7 +272,7 @@
Usage:
>>> #Defining the element:
->>> element = lambda : self . driver . find_element ( By . ID , "example_id" )
+>>> element = lambda : self . driver . find_element_by_id ( "example_id" )
>>> #Calling the method
>>> self . click ( element (), click_type = enum . ClickType . JS )
@@ -280,7 +281,7 @@
-compare_field_values ( field , user_value , captured_value , message )
+compare_field_values ( field , user_value , captured_value , message )
[Internal]
Validates and stores field in the self.errors array if the values are different.
@@ -302,7 +303,7 @@
-double_click ( element , click_type = ClickType.SELENIUM )
+double_click ( element , click_type = ClickType.SELENIUM )
[Internal]
Clicks two times on the Selenium element.
@@ -312,7 +313,7 @@
Usage:
>>> #Defining the element:
->>> element = lambda : self . driver . find_element ( By . ID , "example_id" )
+>>> element = lambda : self . driver . find_element_by_id ( "example_id" )
>>> #Calling the method
>>> self . double_click ( element ())
@@ -321,7 +322,7 @@
-element_exists ( term , scrap_type = ScrapType.TEXT , position = 0 , optional_term = '' , main_container = '.tmodaldialog,.ui-dialog' )
+element_exists ( term , scrap_type = ScrapType.TEXT , position = 0 , optional_term = '' , main_container = '.tmodaldialog,.ui-dialog' )
[Internal]
Returns a boolean if element exists on the screen.
@@ -350,13 +351,13 @@
-element_name ( element_soup )
+element_name ( element_soup )
[internal]
-execution_flow ( )
+execution_flow ( )
Method that is responsible to control log flow in an execution
Returns:
@@ -367,7 +368,7 @@
-filter_displayed_elements ( elements , reverse = False , twebview = False )
+filter_displayed_elements ( elements , reverse = False , twebview = False )
[Internal]
Receives a BeautifulSoup element list and filters only the displayed elements.
@@ -396,7 +397,7 @@
-find_first_div_parent ( element )
+find_first_div_parent ( element )
[Internal]
Finds first div parent element of another BeautifulSoup element.
If element is already a div, it will return the element.
@@ -419,7 +420,7 @@
-find_first_wa_panel_parent ( element )
+find_first_wa_panel_parent ( element )
[Internal]
Finds first div parent element of another BeautifulSoup element.
If element is already a div, it will return the element.
@@ -442,7 +443,7 @@
-find_label_element ( label_text , container )
+find_label_element ( label_text , container )
[Internal]
Find input element next to label containing the label_text parameter.
@@ -467,7 +468,7 @@
-finish_testcase ( )
+finish_testcase ( )
Method that is responsable to finish testcase and send the log and execution time of testcase.
Returns:
@@ -478,7 +479,7 @@
-get_current_DOM ( twebview = False )
+get_current_DOM ( twebview = False )
[Internal]
Returns current HTML DOM parsed as a BeautifulSoup object
@@ -498,7 +499,7 @@
-get_element_text ( element )
+get_element_text ( element )
[Internal]
Gets element text.
@@ -514,7 +515,7 @@
Usage:
>>> #Defining the element:
->>> element = lambda : self . driver . find_element ( By . ID , "example_id" )
+>>> element = lambda : self . driver . find_element_by_id ( "example_id" )
>>> #Calling the method
>>> text = self . get_element_text ( element ())
@@ -523,7 +524,7 @@
-get_element_value ( element )
+get_element_value ( element )
[Internal]
Gets element value.
@@ -539,7 +540,7 @@
Usage:
>>> #Defining the element:
->>> element = lambda : self . driver . find_element ( By . ID , "example_id" )
+>>> element = lambda : self . driver . find_element_by_id ( "example_id" )
>>> #Calling the method
>>> text = self . get_element_value ( element ())
@@ -548,7 +549,7 @@
-log_error ( message , new_log_line = True )
+log_error ( message , new_log_line = True )
[Internal]
Finishes execution of test case with an error and creates the log information for that test.
@@ -568,7 +569,7 @@
-move_to_element ( element )
+move_to_element ( element )
[Internal]
Move focus to element on the screen.
@@ -578,7 +579,7 @@
Usage:
>>> #Defining an element:
->>> element = lambda : self . driver . find_element ( By . ID , "example_id" )
+>>> element = lambda : self . driver . find_element_by_id ( "example_id" )
>>> #Calling the method
>>> self . scroll_to_element ( element ())
@@ -587,7 +588,7 @@
-normalize_config_name ( config_name )
+normalize_config_name ( config_name )
[Internal]
Normalizes the config name string to respect the config object
naming convention.
@@ -611,12 +612,12 @@
-return_combo_index ( combo , option )
+return_combo_index ( combo , option )
Parameters:
-combo
-option
+combo –
+option –
Returns:
@@ -627,25 +628,25 @@
-return_combo_object ( element , shadow_root = True , locator = False )
+return_combo_object ( element , shadow_root = True , locator = False )
[Internal]
-return_iframe ( selector )
+return_iframe ( selector )
-return_selected_combo_value ( element )
+return_selected_combo_value ( element )
”
[Internal]
-scroll_to_element ( element )
+scroll_to_element ( element )
[Internal]
Scroll to element on the screen.
@@ -655,7 +656,7 @@
Usage:
>>> #Defining an element:
->>> element = lambda : self . driver . find_element ( By . ID , "example_id" )
+>>> element = lambda : self . driver . find_element_by_id ( "example_id" )
>>> #Calling the method
>>> self . scroll_to_element ( element ())
@@ -664,7 +665,7 @@
-search_stack ( function )
+search_stack ( function )
Returns True if passed function is present in the call stack.
Parameters:
@@ -686,7 +687,7 @@
-search_zindex ( element )
+search_zindex ( element )
[Internal]
Returns zindex value of Beautifulget_so object.
Internal function created to be used inside lambda of zindex_sort method.
@@ -711,7 +712,7 @@
-select_combo ( element , option , index = False , shadow_root = True , locator = False )
+select_combo ( element , option , index = False , shadow_root = True , locator = False )
Selects the option on the combobox.
Parameters:
@@ -733,7 +734,7 @@
-send_keys ( element , arg )
+send_keys ( element , arg )
[Internal]
Clicks two times on the Selenium element.
@@ -746,7 +747,7 @@
Usage:
>>> #Defining the element:
->>> element = lambda : self . driver . find_element ( By . ID , "example_id" )
+>>> element = lambda : self . driver . find_element_by_id ( "example_id" )
>>> #Calling the method with a string
>>> self . send_keys ( element (), "Text" )
>>> #Calling the method with a Key
@@ -757,7 +758,7 @@
-set_element_focus ( element )
+set_element_focus ( element )
[Internal]
Sets focus on element.
@@ -767,7 +768,7 @@
Usage:
>>> #Defining the element:
->>> element = lambda : self . driver . find_element ( By . ID , "example_id" )
+>>> element = lambda : self . driver . find_element_by_id ( "example_id" )
>>> #Calling the method
>>> text = self . set_element_focus ( element ())
@@ -776,7 +777,7 @@
-soup_to_selenium ( soup_object = None , twebview = False )
+soup_to_selenium ( soup_object = None , twebview = False )
[Internal]
An abstraction of the Selenium call to simplify the conversion of elements.
@@ -799,7 +800,7 @@
-start_testcase ( )
+start_testcase ( )
Method that starts testcase time and testcase info.
Returns:
@@ -810,14 +811,14 @@
-switch_to_iframe ( )
+switch_to_iframe ( )
[Internal]
:return:
-take_screenshot ( filename )
+take_screenshot ( filename )
[Internal]
Takes a screenshot and saves on the screenshot folder defined in config.
@@ -837,7 +838,7 @@
-web_scrap ( term , scrap_type = ScrapType.TEXT , optional_term = None , label = False , main_container = None )
+web_scrap ( term , scrap_type = ScrapType.TEXT , optional_term = None , label = False , main_container = None )
[Internal]
Returns a BeautifulSoup object list based on the search parameters.
Does not support ScrapType.XPATH as scrap_type parameter value.
@@ -873,13 +874,13 @@
-webapp_shadowroot ( shadow_root = True )
+webapp_shadowroot ( shadow_root = True )
[Internal]
-zindex_sort ( elements , reverse = False , active_tab = True )
+zindex_sort ( elements , reverse = False , active_tab = True )
[Internal]
Sorts list of BeautifulSoup elements based on z-index style attribute.
Only works if elements have Style attribute.
diff --git a/docs/configjson.html b/docs/configjson.html
index 1f21be6b9..6cd724738 100644
--- a/docs/configjson.html
+++ b/docs/configjson.html
@@ -1,23 +1,24 @@
-
+
-
+
Config.json — TIR 1.0.0 documentation
-
-
+
+
-
-
-
-
-
+
+
+
+
+
+
@@ -84,7 +85,7 @@
-Config.json
+Config.json
The config.json file is where the configs of the tests are defined.
These are the accepted config keys, and whether they are required or not:
diff --git a/docs/enumerations.html b/docs/enumerations.html
index 9fafb3ab2..4f05ebce5 100644
--- a/docs/enumerations.html
+++ b/docs/enumerations.html
@@ -1,23 +1,24 @@
-
+
-
+
Enumerations — TIR 1.0.0 documentation
-
-
+
+
-
-
-
-
-
+
+
+
+
+
+
@@ -89,10 +90,10 @@
-Enumerations
+Enumerations
-class tir.technologies.core.enumerations. MessageType ( value , names = None , * values , module = None , qualname = None , type = None , start = 1 , boundary = None )
+class tir.technologies.core.enumerations. MessageType ( value )
Enumeration that represents the standard messages that are emitted inside log file.
CORRECT = 1
INCORRECT = 2
@@ -102,7 +103,7 @@
-class tir.technologies.core.enumerations. ScrapType ( value , names = None , * values , module = None , qualname = None , type = None , start = 1 , boundary = None )
+class tir.technologies.core.enumerations. ScrapType ( value )
Enumeration that represents the WebScraping type to be used.
TEXT = 1
CSS_SELECTOR = 2
@@ -113,7 +114,7 @@
-class tir.technologies.core.enumerations. ClickType ( value , names = None , * values , module = None , qualname = None , type = None , start = 1 , boundary = None )
+class tir.technologies.core.enumerations. ClickType ( value )
Enumeration that represents the different types of Click logic.
JS = 1
SELENIUM = 2
diff --git a/docs/genindex.html b/docs/genindex.html
index 797b18c4c..50082e7bf 100644
--- a/docs/genindex.html
+++ b/docs/genindex.html
@@ -1,22 +1,23 @@
-
+
Index — TIR 1.0.0 documentation
-
-
+
+
-
-
-
-
-
+
+
+
+
+
+
@@ -1462,17 +1463,21 @@ W
(tir.technologies.webapp_internal.WebappInternal method)
- WaitProcessing() (tir.main.Webapp method)
+ WaitProcessing() (tir.main.Poui method)
- WaitShow() (tir.main.Webapp method)
+ WaitShow() (tir.main.Poui method)