Merge pull request #1906 from totvs/main

Update documentation on develop branch

Author: HelenaAdrignoli

docs/base.html

@@ -64,6 +64,7 @@
 <li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.collect_zindex"><code class="docutils literal notranslate"><span class="pre">Base.collect_zindex()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.compare_field_values"><code class="docutils literal notranslate"><span class="pre">Base.compare_field_values()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.double_click"><code class="docutils literal notranslate"><span class="pre">Base.double_click()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.driver"><code class="docutils literal notranslate"><span class="pre">Base.driver</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.element_exists"><code class="docutils literal notranslate"><span class="pre">Base.element_exists()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.element_name"><code class="docutils literal notranslate"><span class="pre">Base.element_name()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.execution_flow"><code class="docutils literal notranslate"><span class="pre">Base.execution_flow()</span></code></a></li>
@@ -76,6 +77,7 @@
 <li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.get_current_DOM"><code class="docutils literal notranslate"><span class="pre">Base.get_current_DOM()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.get_element_text"><code class="docutils literal notranslate"><span class="pre">Base.get_element_text()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.get_element_value"><code class="docutils literal notranslate"><span class="pre">Base.get_element_value()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.get_soup_select"><code class="docutils literal notranslate"><span class="pre">Base.get_soup_select()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.get_url"><code class="docutils literal notranslate"><span class="pre">Base.get_url()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.log_error"><code class="docutils literal notranslate"><span class="pre">Base.log_error()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.move_to_element"><code class="docutils literal notranslate"><span class="pre">Base.move_to_element()</span></code></a></li>
@@ -97,6 +99,7 @@
 <li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.start_testcase"><code class="docutils literal notranslate"><span class="pre">Base.start_testcase()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.switch_to_iframe"><code class="docutils literal notranslate"><span class="pre">Base.switch_to_iframe()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.take_screenshot"><code class="docutils literal notranslate"><span class="pre">Base.take_screenshot()</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.wait"><code class="docutils literal notranslate"><span class="pre">Base.wait</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.web_scrap"><code class="docutils literal notranslate"><span class="pre">Base.web_scrap()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.webapp_shadowroot"><code class="docutils literal notranslate"><span class="pre">Base.webapp_shadowroot()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#tir.technologies.core.base.Base.zindex_sort"><code class="docutils literal notranslate"><span class="pre">Base.zindex_sort()</span></code></a></li>
@@ -329,6 +332,12 @@
 </div>
 </dd></dl>
 
+<dl class="py property">
+<dt class="sig sig-object py" id="tir.technologies.core.base.Base.driver">
+<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">driver</span></span><a class="headerlink" href="#tir.technologies.core.base.Base.driver" title="Link to this definition"></a></dt>
+<dd><p>Property to always get the current shared driver instance</p>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="tir.technologies.core.base.Base.element_exists">
 <span class="sig-name descname"><span class="pre">element_exists</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">term</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scrap_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">ScrapType.TEXT</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">position</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional_term</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">main_container</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'.tmodaldialog,.ui-dialog'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tir.technologies.core.base.Base.element_exists" title="Link to this definition"></a></dt>
@@ -568,6 +577,24 @@
 </div>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="tir.technologies.core.base.Base.get_soup_select">
+<span class="sig-name descname"><span class="pre">get_soup_select</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">selector</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">twebview</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">select_one</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tir.technologies.core.base.Base.get_soup_select" title="Link to this definition"></a></dt>
+<dd><p>Get a soup select object.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>selector</strong> – Css selector</p></li>
+<li><p><strong>twebview</strong> – Force twebview mode. If None, keeps legacy behavior.</p></li>
+<li><p><strong>select_one</strong> – When True, returns only the first match.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>Return a soup select object</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="tir.technologies.core.base.Base.get_url">
 <span class="sig-name descname"><span class="pre">get_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tir.technologies.core.base.Base.get_url" title="Link to this definition"></a></dt>
@@ -915,6 +942,12 @@
 </div>
 </dd></dl>
 
+<dl class="py property">
+<dt class="sig sig-object py" id="tir.technologies.core.base.Base.wait">
+<span class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></span><span class="sig-name descname"><span class="pre">wait</span></span><a class="headerlink" href="#tir.technologies.core.base.Base.wait" title="Link to this definition"></a></dt>
+<dd><p>Property to always get the current shared wait instance</p>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="tir.technologies.core.base.Base.web_scrap">
 <span class="sig-name descname"><span class="pre">web_scrap</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">term</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">scrap_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">ScrapType.TEXT</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">optional_term</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">main_container</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#tir.technologies.core.base.Base.web_scrap" title="Link to this definition"></a></dt>