diff --git a/Readme.rst b/Readme.rst
index 5cd5ce1..42554a7 100644
--- a/Readme.rst
+++ b/Readme.rst
@@ -791,7 +791,10 @@ Example with folders:
 File Encoding and CSV Dialect
 -----------------------------
 
-While there are various specifications and implementations for the CSV format (see `RFC 4180 <https://www.rfc-editor.org/rfc/rfc4180.html>`_), there is no formal specification in existence, which allows for a wide variety of interpretations of CSV files. Therefore it is possible to define your own dialect or use
+While there are various specifications and implementations for the CSV format
+(see `RFC 4180 <https://www.rfc-editor.org/rfc/rfc4180.html>`_),
+there is no formal specification in existence, which allows for a wide variety of interpretations of CSV files.
+Therefore it is possible to define your own dialect or use
 predefined. The default is Excel-EU which is a semicolon separated
 file.
 These Settings are changeable as options of the Data Driver Library.
@@ -1271,4 +1274,4 @@ Binary creates with 40 test cases and 8 threads something like that:
     P13: 37
     P14: 38
     P15: 39
-    P16: 40
+    P16: 40
\ No newline at end of file
diff --git a/doc/DataDriver.html b/doc/DataDriver.html
index f805b3e..69bfbcb 100644
--- a/doc/DataDriver.html
+++ b/doc/DataDriver.html
@@ -6,7 +6,7 @@
 <meta http-equiv="Pragma" content="no-cache">
 <meta http-equiv="Expires" content="-1">
 <meta http-equiv="X-UA-Compatible" content="IE=edge">
-<meta content="Robot Framework 5.0 (Python 3.10.0 on darwin)" name="Generator">
+<meta content="Robot Framework 6.0.1 (Python 3.11.0 on darwin)" name="Generator">
 <link rel="icon" type="image/x-icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAKcAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAAqAAAAAAAAAAAAAAAAAAAALIAAAD/AAAA4AAAANwAAADcAAAA3AAAANwAAADcAAAA3AAAANwAAADcAAAA4AAAAP8AAACxAAAAAAAAAKYAAAD/AAAAuwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAC/AAAA/wAAAKkAAAD6AAAAzAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN8AAAD/AAAA+gAAAMMAAAAAAAAAAgAAAGsAAABrAAAAawAAAGsAAABrAAAAawAAAGsAAABrAAAADAAAAAAAAADaAAAA/wAAAPoAAADDAAAAAAAAAIsAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAANEAAAAAAAAA2gAAAP8AAAD6AAAAwwAAAAAAAAAAAAAAMgAAADIAAAAyAAAAMgAAADIAAAAyAAAAMgAAADIAAAAFAAAAAAAAANoAAAD/AAAA+gAAAMMAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAADaAAAA/wAAAPoAAADDAAAAAAAAADwAAAB8AAAAAAAAAGAAAABcAAAAAAAAAH8AAABKAAAAAAAAAAAAAAAAAAAA2gAAAP8AAAD6AAAAwwAAAAAAAADCAAAA/wAAACkAAADqAAAA4QAAAAAAAAD7AAAA/wAAALAAAAAGAAAAAAAAANoAAAD/AAAA+gAAAMMAAAAAAAAAIwAAAP4AAAD/AAAA/wAAAGAAAAAAAAAAAAAAAMkAAAD/AAAAigAAAAAAAADaAAAA/wAAAPoAAADDAAAAAAAAAAAAAAAIAAAAcAAAABkAAAAAAAAAAAAAAAAAAAAAAAAAEgAAAAAAAAAAAAAA2gAAAP8AAAD7AAAAywAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAN4AAAD/AAAAqwAAAP8AAACvAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAALIAAAD/AAAAsgAAAAAAAAC5AAAA/wAAAMoAAADAAAAAwAAAAMAAAADAAAAAwAAAAMAAAADAAAAAwAAAAMkAAAD/AAAAvAAAAAAAAAAAAAAAAAAAAKwAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAArQAAAAAAAAAAwAMAAIABAAAf+AAAP/wAAD/8AAAgBAAAP/wAAD/8AAA//AAAJIwAADHEAAA//AAAP/wAAB/4AACAAQAAwAMAAA==">
 <style media="all" type="text/css">
 :root {
@@ -20,19 +20,17 @@
     --less-important-text-color: gray;
     --link-color: #0000ee;
 }
-@media (prefers-color-scheme: dark) {
-    :root {
-        --background-color: #1c2227;
-        --text-color: #e2e1d7;
-        --border-color: #4e4e4e;
-        --light-background-color: #002b36;
-        --robot-highlight: yellow;
-        --highlighted-color: var(--background-color);
-        --highlighted-background-color: yellow;
-        --less-important-text-color: #5b6a6f;
-        --link-color: #52adff;
-        color-scheme: dark;
-    }
+[data-theme="dark"] {
+    --background-color: #1c2227;
+    --text-color: #e2e1d7;
+    --border-color: #4e4e4e;
+    --light-background-color: #002b36;
+    --robot-highlight: yellow;
+    --highlighted-color: var(--background-color);
+    --highlighted-background-color: yellow;
+    --less-important-text-color: #5b6a6f;
+    --link-color: #52adff;
+    color-scheme: dark;
 }
 body {
     background: var(--background-color);
@@ -1192,7 +1190,7 @@
 jQuery.extend({highlight:function(e,t,n,r){if(e.nodeType===3){var i=e.data.match(t);if(i){var s=document.createElement(n||"span");s.className=r||"highlight";var o=e.splitText(i.index);o.splitText(i[0].length);var u=o.cloneNode(true);s.appendChild(u);o.parentNode.replaceChild(s,o);return 1}}else if(e.nodeType===1&&e.childNodes&&!/(script|style)/i.test(e.tagName)&&!(e.tagName===n.toUpperCase()&&e.className===r)){for(var a=0;a<e.childNodes.length;a++){a+=jQuery.highlight(e.childNodes[a],t,n,r)}}return 0}});jQuery.fn.unhighlight=function(e){var t={className:"highlight",element:"span"};jQuery.extend(t,e);return this.find(t.element+"."+t.className).each(function(){var e=this.parentNode;e.replaceChild(this.firstChild,this);e.normalize()}).end()};jQuery.fn.highlight=function(e,t){var n={className:"highlight",element:"span",caseSensitive:false,wordsOnly:false};jQuery.extend(n,t);if(e.constructor===String){e=[e]}e=jQuery.grep(e,function(e,t){return e!=""});e=jQuery.map(e,function(e,t){return e.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&")});if(e.length==0){return this}var r=n.caseSensitive?"":"i";var i="("+e.join("|")+")";if(n.wordsOnly){i="\\b"+i+"\\b"}var s=new RegExp(i,r);return this.each(function(){jQuery.highlight(this,s,n.element,n.className)})}
 </script>
 <script type="text/javascript">
-libdoc = {"name": "DataDriver", "doc": "<div class=\"document\" id=\"datadriver-for-robot-framework\">\n<h1 class=\"title\">DataDriver for Robot Framework\u00ae</h1>\n<p>DataDriver is a Data-Driven extension for Robot Framework\u00ae.\nThis document explains how to use the DataDriver library listener. For\ninformation about installation, support, and more, please visit the\n<a class=\"reference external\" href=\"https://github.com/Snooz82/robotframework-datadriver\">project page</a></p>\n<p>For more information about Robot Framework\u00ae, see <a class=\"reference external\" href=\"https://robotframework.org\">https://robotframework.org</a>.</p>\n<p>DataDriver is used/imported as Library but does not provide keywords\nwhich can be used in a test. DataDriver uses the Listener Interface\nVersion 3 to manipulate the test cases and creates new test cases based\non a Data-File that contains the data for Data-Driven Testing. These\ndata file may be .csv , .xls or .xlsx files.</p>\n<p>Data Driver is also able to cooperate with Microsoft PICT. An Open\nSource Windows tool for data combination testing. Pict is able to\ngenerate data combinations based on textual model definitions.\n<a class=\"reference external\" href=\"https://github.com/Microsoft/pict\">https://github.com/Microsoft/pict</a></p>\n<p>It is also possible to implement own DataReaders in Python to read\nyour test data from some other sources, like databases or json files.</p>\n<div class=\"section\" id=\"installation\">\n<h1>Installation</h1>\n<p>If you already have Python &gt;= 3.6 with pip installed, you can simply\nrun:</p>\n<p><tt class=\"docutils literal\">pip install <span class=\"pre\">--upgrade</span> <span class=\"pre\">robotframework-datadriver</span></tt></p>\n<div class=\"section\" id=\"excel-support\">\n<h2 id=\"Excel Support\">Excel Support</h2>\n<p>For file support of <tt class=\"docutils literal\">xls</tt> or <tt class=\"docutils literal\">xlsx</tt> file you need to install the extra XLS or the dependencies.\nIt contains the dependencies of pandas, numpy and xlrd. Just add [XLS] to your installation.\nNew since version 3.6.</p>\n<p><tt class=\"docutils literal\">pip install <span class=\"pre\">--upgrade</span> <span class=\"pre\">robotframework-datadriver[XLS]</span></tt></p>\n</div>\n<div class=\"section\" id=\"python-2\">\n<h2 id=\"Python 2\">Python 2</h2>\n<p>or if you have Python 2 and 3 installed in parallel you may use</p>\n<p><tt class=\"docutils literal\">pip3 install <span class=\"pre\">--upgrade</span> <span class=\"pre\">robotframework-datadriver</span></tt></p>\n<p>DataDriver is compatible with Python 2.7 only in Version 0.2.7.</p>\n<p><tt class=\"docutils literal\">pip install <span class=\"pre\">--upgrade</span> <span class=\"pre\">robotframework-datadriver==0.2.7</span></tt></p>\n<p>Because Python 2.7 is deprecated, there are no new feature to python 2.7 compatible version.</p>\n</div>\n</div>\n<div class=\"section\" id=\"table-of-contents\">\n<h1>Table of contents</h1>\n<ul class=\"simple\">\n<li><a class=\"reference internal\" href=\"#what-datadriver-does\">What DataDriver Does</a></li>\n<li><a class=\"reference internal\" href=\"#how-datadriver-works\">How DataDriver Works</a></li>\n<li><a class=\"reference internal\" href=\"#usage\">Usage</a></li>\n<li><a class=\"reference internal\" href=\"#structure-of-test-suite\">Structure of Test Suite</a></li>\n<li><a class=\"reference internal\" href=\"#structure-of-data-file\">Structure of data file</a></li>\n<li><a class=\"reference internal\" href=\"#accessing-test-data-from-robot-variables\">Accessing Test Data From Robot Variables</a></li>\n<li><a class=\"reference internal\" href=\"#data-sources\">Data Sources</a></li>\n<li><a class=\"reference internal\" href=\"#file-encoding-and-csv-dialect\">File Encoding and CSV Dialect</a></li>\n<li><a class=\"reference internal\" href=\"#custom-datareader-classes\">Custom DataReader Classes</a></li>\n<li><a class=\"reference internal\" href=\"#selection-of-test-cases-to-execute\">Selection of Test Cases to Execute</a></li>\n<li><a class=\"reference internal\" href=\"#configure-datadriver-by-pre-run-keyword\">Configure DataDriver by Pre-Run Keyword</a></li>\n<li><a class=\"reference internal\" href=\"#pabot-and-datadriver\">Pabot and DataDriver</a></li>\n</ul>\n</div>\n<div class=\"section\" id=\"what-datadriver-does\">\n<h1>What DataDriver Does</h1>\n<p>DataDriver is an alternative approach to create Data-Driven Tests with\nRobot Framework\u00ae. DataDriver creates multiple test cases based on a test\ntemplate and data content of a csv or Excel file. All created tests\nshare the same test sequence (keywords) and differ in the test data.\nBecause these tests are created on runtime only the template has to be\nspecified within the robot test specification and the used data are\nspecified in an external data file.</p>\n<div class=\"section\" id=\"robocon-2020-talk\">\n<h2 id=\"RoboCon 2020 Talk\">RoboCon 2020 Talk</h2>\n<a class=\"reference external image-reference\" href=\"https://www.youtube.com/watch?v=RtEUr1i4x3s\"><img alt=\"https://img.youtube.com/vi/RtEUr1i4x3s/0.jpg\" src=\"https://img.youtube.com/vi/RtEUr1i4x3s/0.jpg\" /></a>\n<p>Brief overview what DataDriver is and how it works at the RoboCon 2020 in Helsiki.</p>\n</div>\n<div class=\"section\" id=\"alternative-approach\">\n<h2 id=\"Alternative approach\">Alternative approach</h2>\n<p>DataDriver gives an alternative to the build in data driven approach\nlike:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Resource</span><span class=\"p\">    </span><span class=\"nn\">login_resources.robot</span><span class=\"p\">\n\n</span><span class=\"kn\">Suite Setup</span><span class=\"p\">    </span><span class=\"nf\">Open my Browser</span><span class=\"p\">\n</span><span class=\"kn\">Suite Teardown</span><span class=\"p\">    </span><span class=\"nf\">Close Browsers</span><span class=\"p\">\n</span><span class=\"kn\">Test Setup</span><span class=\"p\">      </span><span class=\"nf\">Open Login Page</span><span class=\"p\">\n</span><span class=\"kn\">Test Template</span><span class=\"p\">    </span><span class=\"nf\">Invalid login</span><span class=\"p\">\n\n\n</span><span class=\"gh\">*** Test Cases ***</span><span class=\"p\">       </span><span class=\"gh\">User</span><span class=\"p\">        </span><span class=\"gh\">Passwort</span><span class=\"p\">\n</span><span class=\"gu\">Right user empty pass</span><span class=\"p\">    </span><span class=\"s\">demo</span><span class=\"p\">        ${</span><span class=\"nv\">EMPTY</span><span class=\"p\">}\n</span><span class=\"gu\">Right user wrong pass</span><span class=\"p\">    </span><span class=\"s\">demo</span><span class=\"p\">        </span><span class=\"s\">FooBar</span><span class=\"p\">\n\n</span><span class=\"gu\">Empty user right pass</span><span class=\"p\">    ${</span><span class=\"nv\">EMPTY</span><span class=\"p\">}    </span><span class=\"s\">mode</span><span class=\"p\">\n</span><span class=\"gu\">Empty user empty pass</span><span class=\"p\">    ${</span><span class=\"nv\">EMPTY</span><span class=\"p\">}    ${</span><span class=\"nv\">EMPTY</span><span class=\"p\">}\n</span><span class=\"gu\">Empty user wrong pass</span><span class=\"p\">    ${</span><span class=\"nv\">EMPTY</span><span class=\"p\">}    </span><span class=\"s\">FooBar</span><span class=\"p\">\n\n</span><span class=\"gu\">Wrong user right pass</span><span class=\"p\">    </span><span class=\"s\">FooBar</span><span class=\"p\">      </span><span class=\"s\">mode</span><span class=\"p\">\n</span><span class=\"gu\">Wrong user empty pass</span><span class=\"p\">    </span><span class=\"s\">FooBar</span><span class=\"p\">      ${</span><span class=\"nv\">EMPTY</span><span class=\"p\">}\n</span><span class=\"gu\">Wrong user wrong pass</span><span class=\"p\">    </span><span class=\"s\">FooBar</span><span class=\"p\">      </span><span class=\"s\">FooBar</span><span class=\"p\">\n\n</span><span class=\"gh\">*** Keywords ***</span><span class=\"p\">\n</span><span class=\"gu\">Invalid login</span><span class=\"p\">\n    [</span><span class=\"kn\">Arguments</span><span class=\"p\">]    ${</span><span class=\"nv\">username</span><span class=\"p\">}    ${</span><span class=\"nv\">password</span><span class=\"p\">}\n    </span><span class=\"nf\">Input username</span><span class=\"p\">    ${</span><span class=\"nv\">username</span><span class=\"p\">}\n    </span><span class=\"nf\">Input pwd</span><span class=\"p\">    ${</span><span class=\"nv\">password</span><span class=\"p\">}\n    </span><span class=\"nf\">click login button</span><span class=\"p\">\n    </span><span class=\"nf\">Error page should be visible</span>\n</pre>\n<p>This inbuilt approach is fine for a hand full of data and a hand full of\ntest cases. If you have generated or calculated data and specially if\nyou have a variable amount of test case / combinations these robot files\nbecome quite a pain. With DataDriver you may write the same test case\nsyntax but only once and deliver the data from en external data file.</p>\n<p>One of the rare reasons when Microsoft\u00ae Excel or LibreOffice Calc may be\nused in testing\u2026 ;-)</p>\n<p><a class=\"reference external\" href=\"#example-suite\">See example test suite</a></p>\n<p><a class=\"reference external\" href=\"#example-csv\">See example csv table</a></p>\n</div>\n</div>\n<div class=\"section\" id=\"how-datadriver-works\">\n<h1>How DataDriver Works</h1>\n<p>When the DataDriver is used in a test suite it will be activated before\nthe test suite starts. It uses the Listener Interface Version 3 of Robot\nFramework\u00ae to read and modify the test specification objects. After\nactivation it searches for the <tt class=\"docutils literal\">Test Template</tt> -Keyword to analyze the\n<tt class=\"docutils literal\">[Arguments]</tt> it has. As a second step, it loads the data from the\nspecified data source. Based on the <tt class=\"docutils literal\">Test Template</tt> -Keyword, DataDriver\ncreates as much test cases as data sets are in the data source.</p>\n<p>In the case that data source is csv (Default)\nAs values for the arguments of the <tt class=\"docutils literal\">Test Template</tt> -Keyword, DataDriver\nreads values from the column of the CSV file with the matching name of the\n<tt class=\"docutils literal\">[Arguments]</tt>.\nFor each line of the CSV data table, one test case will be created. It\nis also possible to specify test case names, tags and documentation for\neach test case in the specific test suite related CSV file.</p>\n</div>\n<div class=\"section\" id=\"usage\">\n<h1>Usage</h1>\n<p>Data Driver is a &quot;Library Listener&quot; but does not provide keywords.\nBecause Data Driver is a listener and a library at the same time it\nsets itself as a listener when this library is imported into a test suite.</p>\n<p>To use it, just use it as Library in your suite. You may use the first\nargument (option) which may set the file name or path to the data file.</p>\n<p>Without any options set, it loads a .csv file which has the same name\nand path like the test suite .robot .</p>\n<p><strong>Example:</strong></p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">\n</span><span class=\"kn\">Test Template</span><span class=\"p\">    </span><span class=\"nf\">Invalid Logins</span><span class=\"p\">\n\n</span><span class=\"gh\">*** Keywords ***</span><span class=\"p\">\n</span><span class=\"gu\">Invalid Logins</span><span class=\"p\">\n    ...</span>\n</pre>\n</div>\n<div class=\"section\" id=\"structure-of-test-suite\">\n<h1>Structure of Test Suite</h1>\n<div class=\"section\" id=\"requirements\">\n<h2 id=\"Requirements\">Requirements</h2>\n<p>In the Moment there are some requirements how a test\nsuite must be structured so that the DataDriver can get all the\ninformation it needs.</p>\n<blockquote>\n<ul class=\"simple\">\n<li>only the first test case will be used as a template. All other test\ncases will be deleted.</li>\n<li>Test cases have to be defined with a\n<tt class=\"docutils literal\">Test Template</tt> in Settings secion. Reason for this is,\nthat the DataDriver needs to know the names of the test case arguments.\nTest cases do not have named arguments. Keywords do.</li>\n<li>The keyword which is used as\n<tt class=\"docutils literal\">Test Template</tt> must be defined within the test suite (in the same\n*.robot file). If the keyword which is used as <tt class=\"docutils literal\">Test Template</tt> is\ndefined in a <tt class=\"docutils literal\">Resource</tt> the DataDriver has no access to its\narguments names.</li>\n</ul>\n</blockquote>\n</div>\n<div class=\"section\" id=\"example-test-suite\">\n<h2 id=\"Example Test Suite\">Example Test Suite</h2>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">***Settings***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">           </span><span class=\"nn\">DataDriver</span><span class=\"p\">\n</span><span class=\"kn\">Resource</span><span class=\"p\">          </span><span class=\"nn\">login_resources.robot</span><span class=\"p\">\n</span><span class=\"kn\">Suite Setup</span><span class=\"p\">       </span><span class=\"nf\">Open my Browser</span><span class=\"p\">\n</span><span class=\"kn\">Suite Teardown</span><span class=\"p\">    </span><span class=\"nf\">Close Browsers</span><span class=\"p\">\n</span><span class=\"kn\">Test Setup</span><span class=\"p\">        </span><span class=\"nf\">Open Login Page</span><span class=\"p\">\n</span><span class=\"kn\">Test Template</span><span class=\"p\">     </span><span class=\"nf\">Invalid Login</span><span class=\"p\">\n\n</span><span class=\"gh\">*** Test Case ***</span><span class=\"p\">\n</span><span class=\"gu\">Login with user </span><span class=\"p\">${</span><span class=\"nv\">username</span><span class=\"p\">}</span><span class=\"gu\"> and password </span><span class=\"p\">${</span><span class=\"nv\">password</span><span class=\"p\">}    </span><span class=\"s\">Default</span><span class=\"p\">    </span><span class=\"s\">UserData</span><span class=\"p\">\n\n</span><span class=\"gh\">***** *Keywords* *****</span><span class=\"p\">\n</span><span class=\"gu\">Invalid login</span><span class=\"p\">\n    [</span><span class=\"kn\">Arguments</span><span class=\"p\">]    ${</span><span class=\"nv\">username</span><span class=\"p\">}    ${</span><span class=\"nv\">password</span><span class=\"p\">}\n    </span><span class=\"nf\">Input username</span><span class=\"p\">    ${</span><span class=\"nv\">username</span><span class=\"p\">}\n    </span><span class=\"nf\">Input pwd</span><span class=\"p\">    ${</span><span class=\"nv\">password</span><span class=\"p\">}\n    </span><span class=\"nf\">click login button</span><span class=\"p\">\n    </span><span class=\"nf\">Error page should be visible</span>\n</pre>\n<p>In this example, the DataDriver is activated by using it as a Library.\nIt is used with default settings.\nAs <tt class=\"docutils literal\">Test Template</tt> the keyword <tt class=\"docutils literal\">Invalid Login</tt> is used. This\nkeyword has two arguments. Argument names are <tt class=\"docutils literal\">${username}</tt> and\n<tt class=\"docutils literal\">${password}</tt>. These names have to be in the CSV file as column\nheader. The test case has two variable names included in its name,\nwhich does not have any functionality in Robot Framework\u00ae. However, the\nData Driver will use the test case name as a template name and\nreplaces the variables with the specific value of the single generated\ntest case.\nThis template test will only be used as a template. The specified data\n<tt class=\"docutils literal\">Default</tt> and <tt class=\"docutils literal\">UserData</tt> would only be used if no CSV file has\nbeen found.</p>\n</div>\n</div>\n<div class=\"section\" id=\"structure-of-data-file\">\n<h1>Structure of data file</h1>\n<div class=\"section\" id=\"min-required-columns\">\n<h2 id=\"min. required columns\">min. required columns</h2>\n<ul class=\"simple\">\n<li><tt class=\"docutils literal\">*** Test Cases ***</tt> column has to be the first one.</li>\n<li><em>Argument columns:</em> For each argument of the <tt class=\"docutils literal\">Test Template</tt>\nkeyword one column must be existing in the data file as data source.\nThe name of this column must match the variable name and syntax.</li>\n</ul>\n</div>\n<div class=\"section\" id=\"optional-columns\">\n<h2 id=\"optional columns\">optional columns</h2>\n<ul class=\"simple\">\n<li><em>[Tags]</em> column may be used to add specific tags to a test case. Tags\nmay be comma separated.</li>\n<li><em>[Documentation]</em> column may be used to add specific test case\ndocumentation.</li>\n</ul>\n</div>\n<div class=\"section\" id=\"example-data-file\">\n<h2 id=\"Example Data file\">Example Data file</h2>\n<table border=\"1\" class=\"docutils\">\n<colgroup>\n<col width=\"19%\" />\n<col width=\"19%\" />\n<col width=\"19%\" />\n<col width=\"19%\" />\n<col width=\"26%\" />\n</colgroup>\n<thead valign=\"bottom\">\n<tr><th class=\"head\">*** Test\nCases ***</th>\n<th class=\"head\">${username}</th>\n<th class=\"head\">${password}</th>\n<th class=\"head\">[Tags]</th>\n<th class=\"head\">[Documentation]</th>\n</tr>\n</thead>\n<tbody valign=\"top\">\n<tr><td>Right user\nempty pass</td>\n<td>demo</td>\n<td>${EMPTY}</td>\n<td>1</td>\n<td>This is a test\ncase\ndocumentation of\nthe first one.</td>\n</tr>\n<tr><td>Right user\nwrong pass</td>\n<td>demo</td>\n<td>FooBar</td>\n<td>2,3,foo</td>\n<td>This test\ncase has\nthe Tags\n2,3 and foo\nassigned.</td>\n</tr>\n<tr><td>&nbsp;</td>\n<td>${EMPTY}</td>\n<td>mode</td>\n<td>1,2,3,4</td>\n<td>This test\ncase has a\ngenerated\nname based\non template\nname.</td>\n</tr>\n<tr><td>&nbsp;</td>\n<td>${EMPTY}</td>\n<td>${EMPTY}</td>\n<td>&nbsp;</td>\n<td>&nbsp;</td>\n</tr>\n<tr><td>&nbsp;</td>\n<td>${EMPTY}</td>\n<td>FooBar</td>\n<td>&nbsp;</td>\n<td>&nbsp;</td>\n</tr>\n<tr><td>&nbsp;</td>\n<td>FooBar</td>\n<td>mode</td>\n<td>&nbsp;</td>\n<td>&nbsp;</td>\n</tr>\n<tr><td>&nbsp;</td>\n<td>FooBar</td>\n<td>${EMPTY}</td>\n<td>&nbsp;</td>\n<td>&nbsp;</td>\n</tr>\n<tr><td>&nbsp;</td>\n<td>FooBar</td>\n<td>FooBar</td>\n<td>&nbsp;</td>\n<td>&nbsp;</td>\n</tr>\n</tbody>\n</table>\n<p>In this data file, eight test cases are defined. Each line specifies one\ntest case. The first two test cases have specific names. The other six\ntest cases will generate names based on template test cases name with\nthe replacement of variables in this name. The order of columns is\nirrelevant except the first column, <tt class=\"docutils literal\">*** Test Cases ***</tt></p>\n</div>\n<div class=\"section\" id=\"supported-data-types\">\n<h2 id=\"Supported Data Types\">Supported Data Types</h2>\n<p>In general DataDriver supports any Object that is handed over from the DataReader.\nHowever the text based readers for csv, excel and so do support different types as well.\nDataDriver supports Robot Framework\u00ae Scalar variables as well as Dictionaries and Lists.\nIt also support python literal evaluations.</p>\n<div class=\"section\" id=\"scalar-variables\">\n<h3 id=\"Scalar Variables\">Scalar Variables</h3>\n<p>The Prefix <tt class=\"docutils literal\">$</tt> defines that the value in the cell is taken as in Robot Framework\u00ae Syntax.\n<tt class=\"docutils literal\">String</tt> is <tt class=\"docutils literal\">str</tt>, <tt class=\"docutils literal\">${1}</tt> is <tt class=\"docutils literal\">int</tt> and <tt class=\"docutils literal\">${None}</tt> is NoneType.\nThe Prefix only defines the value typ. It can also be used to assign a scalar to a dictionary key.\nSee example table: <tt class=\"docutils literal\"><span class=\"pre\">${user}[id]</span></tt></p>\n</div>\n<div class=\"section\" id=\"dictionary-variables\">\n<h3 id=\"Dictionary Variables\">Dictionary Variables</h3>\n<p>Dictionaries can be created in different ways.</p>\n<p>One option is, to use the prefix <tt class=\"docutils literal\">&amp;</tt>.\nIf a variable is defined that was (i.e. <tt class=\"docutils literal\">&amp;{dict}</tt>) the cell value is interpreted the same way,\nthe BuiltIn keyword <a class=\"reference external\" href=\"https://robotframework.org/robotframework/latest/libraries/BuiltIn.html#Create%20Dictionary\">Create Dictionary</a> would do.\nThe arguments here are comma (<tt class=\"docutils literal\">,</tt>) separated.\nSee example table: <tt class=\"docutils literal\">&amp;{dict}</tt></p>\n<p>The other option is to define scalar variables in dictionary syntax like <tt class=\"docutils literal\"><span class=\"pre\">${user}[name]</span></tt> or <tt class=\"docutils literal\">${user.name}</tt>\nThat can be also nested dictionaries. DataDriver will create Robot Framework\u00ae (DotDict) Dictionaries, that can be accessed with <tt class=\"docutils literal\">${user.name.first}</tt>\nSee example table: <tt class=\"docutils literal\"><span class=\"pre\">${user}[name][first]</span></tt></p>\n</div>\n<div class=\"section\" id=\"list-variables\">\n<h3 id=\"List Variables\">List Variables</h3>\n<p>Lists can be created with the prefix <tt class=\"docutils literal\">&#64;</tt> as comma (<tt class=\"docutils literal\">,</tt>) separated list.\nSee example table: <tt class=\"docutils literal\">&#64;{list}</tt></p>\n<p>Be aware that a list with an empty string has to be the cell content <cite>${Empty}</cite>.</p>\n</div>\n<div class=\"section\" id=\"python-literals\">\n<h3 id=\"Python Literals\">Python Literals</h3>\n<p>DataDriver can evaluate Literals.\nIt uses the prefix <tt class=\"docutils literal\">e</tt> for that. (i.e. <tt class=\"docutils literal\">e{list_eval}</tt>)\nFor that it uses <a class=\"reference external\" href=\"https://robotframework.org/robotframework/latest/libraries/BuiltIn.html#Evaluate\">BuiltIn Evaluate</a></p>\n<p>See example table: <tt class=\"docutils literal\">e{user.chk}</tt></p>\n<table border=\"1\" class=\"docutils\">\n<colgroup>\n<col width=\"8%\" />\n<col width=\"7%\" />\n<col width=\"4%\" />\n<col width=\"7%\" />\n<col width=\"8%\" />\n<col width=\"12%\" />\n<col width=\"8%\" />\n<col width=\"6%\" />\n<col width=\"6%\" />\n<col width=\"8%\" />\n<col width=\"7%\" />\n<col width=\"19%\" />\n</colgroup>\n<tbody valign=\"top\">\n<tr><td><tt class=\"docutils literal\">*** Test Cases ***</tt></td>\n<td><tt class=\"docutils literal\">${scalar}</tt></td>\n<td><tt class=\"docutils literal\">&#64;{list}</tt></td>\n<td><tt class=\"docutils literal\">e{list_eval}</tt></td>\n<td><tt class=\"docutils literal\">&amp;{dict}</tt></td>\n<td><tt class=\"docutils literal\">e{dict_eval}</tt></td>\n<td><tt class=\"docutils literal\">e{eval}</tt></td>\n<td><tt class=\"docutils literal\">${exp_eval}</tt></td>\n<td><tt class=\"docutils literal\"><span class=\"pre\">${user}[id]</span></tt></td>\n<td><tt class=\"docutils literal\"><span class=\"pre\">${user}[name][first]</span></tt></td>\n<td><tt class=\"docutils literal\">${user.name.last}</tt></td>\n<td><tt class=\"docutils literal\">e{user.chk}</tt></td>\n</tr>\n<tr><td><tt class=\"docutils literal\">One</tt></td>\n<td><tt class=\"docutils literal\">Sum List</tt></td>\n<td><tt class=\"docutils literal\">1,2,3,4</tt></td>\n<td><tt class=\"docutils literal\"><span class=\"pre\">[&quot;1&quot;,&quot;2&quot;,&quot;3&quot;,&quot;4&quot;]</span></tt></td>\n<td><tt class=\"docutils literal\">key=value</tt></td>\n<td><tt class=\"docutils literal\">{'key': 'value'}</tt></td>\n<td><tt class=\"docutils literal\">[1,2,3,4]</tt></td>\n<td><tt class=\"docutils literal\">10</tt></td>\n<td><tt class=\"docutils literal\">1</tt></td>\n<td><tt class=\"docutils literal\">Pekka</tt></td>\n<td><tt class=\"docutils literal\">Kl\u00e4rck</tt></td>\n<td><tt class=\"docutils literal\">{'id': '1', 'name': {'first': 'Pekka', 'last': <span class=\"pre\">'Kl\u00e4rck'}}</span></tt></td>\n</tr>\n<tr><td><tt class=\"docutils literal\">Two</tt></td>\n<td><tt class=\"docutils literal\">Should be Equal</tt></td>\n<td><tt class=\"docutils literal\">a,b,c,d</tt></td>\n<td><tt class=\"docutils literal\"><span class=\"pre\">[&quot;a&quot;,&quot;b&quot;,&quot;c&quot;,&quot;d&quot;]</span></tt></td>\n<td><tt class=\"docutils literal\">key,value</tt></td>\n<td><tt class=\"docutils literal\">{'key': 'value'}</tt></td>\n<td><tt class=\"docutils literal\">True</tt></td>\n<td><tt class=\"docutils literal\">${true}</tt></td>\n<td><tt class=\"docutils literal\">2</tt></td>\n<td><tt class=\"docutils literal\">Ed</tt></td>\n<td><tt class=\"docutils literal\">Manlove</tt></td>\n<td><tt class=\"docutils literal\">{'id': '2', 'name': {'first': 'Ed', 'last': <span class=\"pre\">'Manlove'}}</span></tt></td>\n</tr>\n<tr><td><tt class=\"docutils literal\">Three</tt></td>\n<td><tt class=\"docutils literal\">Whos your Daddy</tt></td>\n<td><tt class=\"docutils literal\"><span class=\"pre\">!,&quot;,',$</span></tt></td>\n<td><tt class=\"docutils literal\"><span class=\"pre\">[&quot;!&quot;,'&quot;',&quot;'&quot;,&quot;$&quot;]</span></tt></td>\n<td><tt class=\"docutils literal\">z,value,a,value2</tt></td>\n<td><tt class=\"docutils literal\">{'a': 'value2', 'z': 'value'}</tt></td>\n<td><tt class=\"docutils literal\">{'Daddy' : 'Ren\u00e9'}</tt></td>\n<td><tt class=\"docutils literal\">Ren\u00e9</tt></td>\n<td><tt class=\"docutils literal\">3</tt></td>\n<td><tt class=\"docutils literal\">Tatu</tt></td>\n<td><tt class=\"docutils literal\">Aalto</tt></td>\n<td><tt class=\"docutils literal\">{'id': '3', 'name': {'first': 'Tatu', 'last': <span class=\"pre\">'Aalto'}}</span></tt></td>\n</tr>\n<tr><td><tt class=\"docutils literal\">4</tt></td>\n<td><tt class=\"docutils literal\">Should be Equal</tt></td>\n<td><tt class=\"docutils literal\">1</tt></td>\n<td><tt class=\"docutils literal\">[&quot;1&quot;]</tt></td>\n<td><tt class=\"docutils literal\">key=value</tt></td>\n<td><tt class=\"docutils literal\">{'key': 'value'}</tt></td>\n<td><tt class=\"docutils literal\">1</tt></td>\n<td><tt class=\"docutils literal\">${1}</tt></td>\n<td><tt class=\"docutils literal\">4</tt></td>\n<td><tt class=\"docutils literal\">Jani</tt></td>\n<td><tt class=\"docutils literal\">Mikkonen</tt></td>\n<td><tt class=\"docutils literal\">{'id': '4', 'name': {'first': 'Jani', 'last': <span class=\"pre\">'Mikkonen'}}</span></tt></td>\n</tr>\n<tr><td><tt class=\"docutils literal\">5</tt></td>\n<td><tt class=\"docutils literal\">Should be Equal</tt></td>\n<td>&nbsp;</td>\n<td><tt class=\"docutils literal\">[]</tt></td>\n<td><tt class=\"docutils literal\"><span class=\"pre\">a=${2}</span></tt></td>\n<td><tt class=\"docutils literal\"><span class=\"pre\">{'a':2}</span></tt></td>\n<td><tt class=\"docutils literal\">&quot;string&quot;</tt></td>\n<td><tt class=\"docutils literal\">string</tt></td>\n<td><tt class=\"docutils literal\">5</tt></td>\n<td><tt class=\"docutils literal\">Mikko</tt></td>\n<td><tt class=\"docutils literal\">Korpela</tt></td>\n<td><tt class=\"docutils literal\">{'id': '5', 'name': {'first': 'Mikko', 'last': <span class=\"pre\">'Korpela'}}</span></tt></td>\n</tr>\n<tr><td><tt class=\"docutils literal\">6</tt></td>\n<td><tt class=\"docutils literal\">Should be Equal</tt></td>\n<td><tt class=\"docutils literal\">[1,2]</tt></td>\n<td><tt class=\"docutils literal\"><span class=\"pre\">[&quot;[1&quot;,&quot;2]&quot;]</span></tt></td>\n<td><tt class=\"docutils literal\">key=value,key2=value2</tt></td>\n<td><tt class=\"docutils literal\">{'key': 'value', 'key2': 'value2'}</tt></td>\n<td><tt class=\"docutils literal\">None</tt></td>\n<td><tt class=\"docutils literal\">${none}</tt></td>\n<td><tt class=\"docutils literal\">6</tt></td>\n<td><tt class=\"docutils literal\">Ismo</tt></td>\n<td><tt class=\"docutils literal\">Aro</tt></td>\n<td><tt class=\"docutils literal\">{'id': '6', 'name': {'first': 'Ismo', 'last': <span class=\"pre\">'Aro'}}</span></tt></td>\n</tr>\n</tbody>\n</table>\n</div>\n</div>\n</div>\n<div class=\"section\" id=\"accessing-test-data-from-robot-variables\">\n<h1>Accessing Test Data From Robot Variables</h1>\n<p>If neccesary it is possible to access the fetched data tables directly from a Robot Framework\u00ae variable.\nThis could be helpfull in Test Setup or in Suite Setup.</p>\n<p>There are three variables available within the Data-Driven Suite:</p>\n<div class=\"section\" id=\"datadriver-data-list\">\n<h2 id=\"&#64;{DataDriver_DATA_LIST}\">&#64;{DataDriver_DATA_LIST}</h2>\n<p>A list as suite variable containing a robot dictionary for each test case that is selected for execution.</p>\n<pre class=\"code json literal-block\">\n<span class=\"p\">[</span><span class=\"w\">\n  </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Right user empty pass&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;demo&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;1&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;This is a test case documentation of the first one.&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Right user wrong pass&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;demo&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;2&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;3&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;foo&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;This test case has the Tags 2,3 and foo&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user '${EMPTY}' and password 'mode'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;mode&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;1&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;2&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;3&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;4&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;This test case has a generated name based on template name.&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user '${EMPTY}' and password '${EMPTY}'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user '${EMPTY}' and password 'FooBar'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user 'FooBar' and password 'mode'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;mode&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;foo&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;1&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user 'FooBar' and password '${EMPTY}'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;foo&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user 'FooBar' and password 'FooBar'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;foo&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;2&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">}</span><span class=\"w\">\n</span><span class=\"p\">]</span>\n</pre>\n<p>This can be accessed as usual in Robot Framework\u00ae.</p>\n<p><tt class=\"docutils literal\"><span class=\"pre\">${DataDriver_DATA_LIST}[2][arguments][\\${password}]</span></tt> would result in <tt class=\"docutils literal\">mode</tt> .</p>\n</div>\n<div class=\"section\" id=\"datadriver-data-dict\">\n<h2 id=\"&amp;{DataDriver_DATA_DICT}\">&amp;{DataDriver_DATA_DICT}</h2>\n<p>A dictionary as suite variable that contains the same data as the list, with the test names as keys.</p>\n<pre class=\"code json literal-block\">\n<span class=\"p\">{</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;Right user empty pass&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Right user empty pass&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;demo&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;1&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;This is a test case documentation of the first one.&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;Right user wrong pass&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Right user wrong pass&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;demo&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;2&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;3&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;foo&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;This test case has the Tags 2,3 and foo&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;Login with user '${EMPTY}' and password 'mode'&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user '${EMPTY}' and password 'mode'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;mode&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;1&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;2&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;3&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;4&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;This test case has a generated name based on template name.&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;Login with user '${EMPTY}' and password '${EMPTY}'&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user '${EMPTY}' and password '${EMPTY}'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;Login with user '${EMPTY}' and password 'FooBar'&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user '${EMPTY}' and password 'FooBar'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;Login with user 'FooBar' and password 'mode'&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user 'FooBar' and password 'mode'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;mode&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;foo&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;1&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;Login with user 'FooBar' and password '${EMPTY}'&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user 'FooBar' and password '${EMPTY}'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;foo&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;Login with user 'FooBar' and password 'FooBar'&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user 'FooBar' and password 'FooBar'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;foo&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;2&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">}</span><span class=\"w\">\n</span><span class=\"p\">}</span>\n</pre>\n</div>\n<div class=\"section\" id=\"datadriver-test-data\">\n<h2 id=\"&amp;{DataDriver_TEST_DATA}\">&amp;{DataDriver_TEST_DATA}</h2>\n<p>A dictionary as test variable that contains the test data of the current test case.\nThis dictionary does also contain arguments that are not used in the <tt class=\"docutils literal\">Test Template</tt> keyword.\nThis can be used in Test Setup and within a test case.</p>\n<pre class=\"code json literal-block\">\n<span class=\"p\">{</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Right user wrong pass&quot;</span><span class=\"p\">,</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;demo&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n    </span><span class=\"s2\">&quot;2&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"s2\">&quot;3&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"s2\">&quot;foo&quot;</span><span class=\"w\">\n  </span><span class=\"p\">],</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;This test case has the Tags 2,3 and foo&quot;</span><span class=\"w\">\n</span><span class=\"p\">}</span>\n</pre>\n</div>\n</div>\n<div class=\"section\" id=\"data-sources\">\n<h1>Data Sources</h1>\n<div class=\"section\" id=\"csv-tsv-character-separated-values\">\n<h2 id=\"CSV / TSV (Character-separated values)\">CSV / TSV (Character-separated values)</h2>\n<p>By default DataDriver reads csv files. With the <a class=\"reference external\" href=\"#file-encoding-and-csv-dialect\">Encoding and CSV\nDialect</a> settings you may configure which\nstructure your data source has.</p>\n</div>\n<div class=\"section\" id=\"xls-xlsx-files\">\n<h2 id=\"XLS / XLSX Files\">XLS / XLSX Files</h2>\n<p>To use Excel file types, you have to install DataDriver with the Extra XLS.</p>\n<p>If you want to use Excel based data sources, you may just set the file\nto the extention or you may point to the correct file. If the extention\nis &quot;.xls&quot; or &quot;.xlsx&quot; DataDriver will interpret it as Excel file.\nYou may select the sheet which will be read by the option <tt class=\"docutils literal\">sheet_name</tt>.\nBy default it is set to 0 which will be the first table sheet.\nYou may use sheet index (0 is first sheet) or sheet name(case sensitive).\nXLS interpreter will ignore all other options like encoding, delimiters etc.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">.xlsx</span>\n</pre>\n<p>or:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">file=my_data_source.xlsx</span><span class=\"p\">    </span><span class=\"s\">sheet_name=2nd Sheet</span>\n</pre>\n<div class=\"section\" id=\"ms-excel-and-typed-cells\">\n<h3 id=\"MS Excel and typed cells\">MS Excel and typed cells</h3>\n<p>Microsoft Excel xls or xlsx file have the possibility to type thair data\ncells. Numbers are typically of the type float. If these data are not\nexplicitly defined as text in Excel, pandas will read it as the type\nthat is has in excel. Because we have to work with strings in Robot\nFramework\u00ae these data are converted to string. This leads to the\nsituation that a European time value like &quot;04.02.2019&quot; (4th January\n2019) is handed over to Robot Framework\u00ae in Iso time &quot;2019-01-04\n00:00:00&quot;. This may cause unwanted behavior. To mitigate this risk you\nshould define Excel based files explicitly as text within Excel.</p>\n<p>Alternatively you may deactivate that string conversion.\nTo do so, you have to add the option <tt class=\"docutils literal\">preserve_xls_types</tt> to <tt class=\"docutils literal\">True</tt>.\nIn that case, you will get str, float, boolean, int, datetime.time,\ndatetime.datetime and some others.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">file=my_data_source.xlsx</span><span class=\"p\">    </span><span class=\"s\">preserve_xls_types=True</span>\n</pre>\n</div>\n</div>\n<div class=\"section\" id=\"pict-pairwise-independent-combinatorial-testing\">\n<h2 id=\"PICT (Pairwise Independent Combinatorial Testing)\">PICT (Pairwise Independent Combinatorial Testing)</h2>\n<p>Pict is able to generate data files based on a model file.\n<a class=\"reference external\" href=\"https://github.com/Microsoft/pict\">https://github.com/Microsoft/pict</a></p>\n<p>Documentation: <a class=\"reference external\" href=\"https://github.com/Microsoft/pict/blob/master/doc/pict.md\">https://github.com/Microsoft/pict/blob/master/doc/pict.md</a></p>\n<div class=\"section\" id=\"requirements-of-pict\">\n<h3 id=\"Requirements of PICT\">Requirements of PICT</h3>\n<ul class=\"simple\">\n<li>Path to pict.exe must be set in the %PATH% environment variable.</li>\n<li>Data model file has the file extention &quot;.pict&quot;</li>\n<li>Pict model file must be encoded in UTF-8</li>\n</ul>\n</div>\n<div class=\"section\" id=\"how-it-works\">\n<h3 id=\"How it works\">How it works</h3>\n<p>If the file option is set to a file with the extention pict, DataDriver\nwill hand over this file to pict.exe and let it automatically generates\na file with the extention &quot;.pictout&quot;. This file will the be used as data\nsource for the test generation. (It is tab seperated and UTF-8 encoded)\nExcept the file option all other options of the library will be ignored.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">my_model_file.pict</span>\n</pre>\n<p>It is possible to give options to pict with the import argument <cite>pict_options=</cite>.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">pict_arg.pict</span><span class=\"p\">    </span><span class=\"s\">pict_options=/o:3 /r</span>\n</pre>\n</div>\n</div>\n<div class=\"section\" id=\"glob-file-pattern\">\n<h2 id=\"Glob File Pattern\">Glob File Pattern</h2>\n<p>This module implements a reader class that creates a test case for each file or folder that matches the given glob pattern.</p>\n<p>With an optional argument &quot;arg_name&quot; you can modify the argument that will be set. See folder example.</p>\n<p>Example with json files:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">           </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">file=</span><span class=\"p\">${</span><span class=\"nv\">CURDIR</span><span class=\"p\">}</span><span class=\"s\">/DataFiles/*_File.json</span><span class=\"p\">    </span><span class=\"s\">reader_class=glob_reader</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">           </span><span class=\"nn\">OperatingSystem</span><span class=\"p\">\n</span><span class=\"kn\">Test Template</span><span class=\"p\">     </span><span class=\"nf\">Test all Files</span><span class=\"p\">\n\n\n</span><span class=\"gh\">*** Test Cases ***</span><span class=\"p\">\n</span><span class=\"gu\">Glob_Reader_Test</span><span class=\"p\">    </span><span class=\"s\">Wrong_File.NoJson</span><span class=\"p\">\n\n\n</span><span class=\"gh\">*** Keywords ***</span><span class=\"p\">\n</span><span class=\"gu\">Test all Files</span><span class=\"p\">\n    [</span><span class=\"kn\">Arguments</span><span class=\"p\">]    ${</span><span class=\"nv\">file_name</span><span class=\"p\">}\n    ${</span><span class=\"nv\">file_content</span><span class=\"p\">}=    </span><span class=\"nf\">Get File</span><span class=\"p\">    ${</span><span class=\"nv\">file_name</span><span class=\"p\">}\n    ${</span><span class=\"nv\">content</span><span class=\"p\">}=    </span><span class=\"nf\">Evaluate</span><span class=\"p\">    </span><span class=\"s\">json.loads($file_content)[&quot;test_case&quot;]</span><span class=\"p\">\n    </span><span class=\"nf\">Should Be Equal</span><span class=\"p\">    ${</span><span class=\"nv\">TEST_NAME</span><span class=\"p\">}    ${</span><span class=\"nv\">content</span><span class=\"p\">}</span>\n</pre>\n<p>Example with folders:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">           </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">file=</span><span class=\"p\">${</span><span class=\"nv\">CURDIR</span><span class=\"p\">}</span><span class=\"s\">/FoldersToFind/*/</span><span class=\"p\">    </span><span class=\"s\">reader_class=glob_reader</span><span class=\"p\">    </span><span class=\"s\">arg_name=\\${folder_name}</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">           </span><span class=\"nn\">OperatingSystem</span><span class=\"p\">\n</span><span class=\"kn\">Test Template</span><span class=\"p\">     </span><span class=\"nf\">Test all Files</span><span class=\"p\">\n\n\n</span><span class=\"gh\">*** Test Cases ***</span><span class=\"p\">\n</span><span class=\"gu\">Glob_Reader_Test</span><span class=\"p\">    </span><span class=\"s\">Wrong_File.NoJson</span><span class=\"p\">\n\n\n</span><span class=\"gh\">*** Keywords ***</span><span class=\"p\">\n</span><span class=\"gu\">Test all Files</span><span class=\"p\">\n    [</span><span class=\"kn\">Arguments</span><span class=\"p\">]    ${</span><span class=\"nv\">folder_name</span><span class=\"p\">}\n    ${</span><span class=\"nv\">content</span><span class=\"p\">}=    </span><span class=\"nf\">Get File</span><span class=\"p\">    ${</span><span class=\"nv\">folder_name</span><span class=\"p\">}</span><span class=\"s\">/verify.txt</span><span class=\"p\">\n    </span><span class=\"nf\">Should Be Equal</span><span class=\"p\">    ${</span><span class=\"nv\">TEST_NAME</span><span class=\"p\">}    ${</span><span class=\"nv\">content</span><span class=\"p\">}</span>\n</pre>\n</div>\n</div>\n<div class=\"section\" id=\"file-encoding-and-csv-dialect\">\n<h1>File Encoding and CSV Dialect</h1>\n<p>CSV is far away from well designed and has absolutely no &quot;common&quot;\nformat. Therefore it is possible to define your own dialect or use\npredefined. The default is Excel-EU which is a semicolon separated\nfile.\nThese Settings are changeable as options of the Data Driver Library.</p>\n<div class=\"section\" id=\"file\">\n<h2 id=\"file=\">file=</h2>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">         </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">file=../data/my_data_source.csv</span>\n</pre>\n<ul class=\"simple\">\n<li>None(default): Data Driver will search in the test suites folder if a\n*.csv file with the same name than the test suite *.robot file exists</li>\n<li>only file extention: if you just set a file extentions like &quot;.xls&quot; or\n&quot;.xlsx&quot; DataDriver will search</li>\n<li>absolute path: If an absolute path to a file is set, DataDriver tries\nto find and open the given data file.</li>\n<li>relative path: If the option does not point to a data file as an\nabsolute path, Data Driver tries to find a data file relative to the\nfolder where the test suite is located.</li>\n</ul>\n</div>\n<div class=\"section\" id=\"encoding\">\n<h2 id=\"encoding=\">encoding=</h2>\n<p><tt class=\"docutils literal\">encoding=</tt> must be set if it shall not be cp1252.</p>\n<p><strong>Examples</strong>:</p>\n<p><tt class=\"docutils literal\">cp1252, ascii, <span class=\"pre\">iso-8859-1,</span> <span class=\"pre\">latin-1,</span> utf_8, utf_16, utf_16_be, utf_16_le</tt></p>\n<p><strong>cp1252</strong> is:</p>\n<ul class=\"simple\">\n<li>Code Page 1252</li>\n<li>Windows-1252</li>\n<li>Windows Western European</li>\n</ul>\n<p>Most characters are same between ISO-8859-1 (Latin-1) except for the code points 128-159 (0x80-0x9F).\nThese Characters are available in cp1252 which are not present in Latin-1.</p>\n<p><tt class=\"docutils literal\">\u20ac \u201a \u0192 \u201e \u2026 \u2020 \u2021 \u02c6 \u2030 \u0160 \u2039 \u0152 \u017d \u2018 \u2019 \u201c \u201d \u2022 \u2013 \u2014 \u02dc \u2122 \u0161 \u203a \u0153 \u017e \u0178</tt></p>\n<p>See <a class=\"reference external\" href=\"https://docs.python.org/3/library/codecs.html#standard-encodings\">Python Standard Encoding</a> for more encodings</p>\n</div>\n<div class=\"section\" id=\"dialect\">\n<h2 id=\"dialect=\">dialect=</h2>\n<p>You may change the CSV Dialect here.\nThe dialect option can be one of the following:\n- Excel-EU\n- excel\n- excel-tab\n- unix\n- UserDefined</p>\n<p>supported Dialects are:</p>\n<pre class=\"code python literal-block\">\n<span class=\"s2\">&quot;Excel-EU&quot;</span>\n    <span class=\"n\">delimiter</span><span class=\"o\">=</span><span class=\"s1\">';'</span><span class=\"p\">,</span>\n    <span class=\"n\">quotechar</span><span class=\"o\">=</span><span class=\"s1\">'&quot;'</span><span class=\"p\">,</span>\n    <span class=\"n\">escapechar</span><span class=\"o\">=</span><span class=\"s1\">'</span><span class=\"se\">\\'</span><span class=\"s1\">,</span>\n    <span class=\"n\">doublequote</span><span class=\"o\">=</span><span class=\"kc\">True</span><span class=\"p\">,</span>\n    <span class=\"n\">skipinitialspace</span><span class=\"o\">=</span><span class=\"kc\">False</span><span class=\"p\">,</span>\n    <span class=\"n\">lineterminator</span><span class=\"o\">=</span><span class=\"s2\">&quot;</span><span class=\"se\">\\r\\n</span><span class=\"s2\">&quot;</span><span class=\"p\">,</span>\n    <span class=\"n\">quoting</span><span class=\"o\">=</span><span class=\"n\">csv</span><span class=\"o\">.</span><span class=\"n\">QUOTE_ALL</span>\n\n<span class=\"s2\">&quot;excel&quot;</span>\n    <span class=\"n\">delimiter</span> <span class=\"o\">=</span> <span class=\"s1\">','</span>\n    <span class=\"n\">quotechar</span> <span class=\"o\">=</span> <span class=\"s1\">'&quot;'</span>\n    <span class=\"n\">doublequote</span> <span class=\"o\">=</span> <span class=\"kc\">True</span>\n    <span class=\"n\">skipinitialspace</span> <span class=\"o\">=</span> <span class=\"kc\">False</span>\n    <span class=\"n\">lineterminator</span> <span class=\"o\">=</span> <span class=\"s1\">'</span><span class=\"se\">\\r\\n</span><span class=\"s1\">'</span>\n    <span class=\"n\">quoting</span> <span class=\"o\">=</span> <span class=\"n\">QUOTE_MINIMAL</span>\n\n<span class=\"s2\">&quot;excel-tab&quot;</span>\n    <span class=\"n\">delimiter</span> <span class=\"o\">=</span> <span class=\"s1\">'</span><span class=\"se\">\\t</span><span class=\"s1\">'</span>\n    <span class=\"n\">quotechar</span> <span class=\"o\">=</span> <span class=\"s1\">'&quot;'</span>\n    <span class=\"n\">doublequote</span> <span class=\"o\">=</span> <span class=\"kc\">True</span>\n    <span class=\"n\">skipinitialspace</span> <span class=\"o\">=</span> <span class=\"kc\">False</span>\n    <span class=\"n\">lineterminator</span> <span class=\"o\">=</span> <span class=\"s1\">'</span><span class=\"se\">\\r\\n</span><span class=\"s1\">'</span>\n    <span class=\"n\">quoting</span> <span class=\"o\">=</span> <span class=\"n\">QUOTE_MINIMAL</span>\n\n<span class=\"s2\">&quot;unix&quot;</span>\n    <span class=\"n\">delimiter</span> <span class=\"o\">=</span> <span class=\"s1\">','</span>\n    <span class=\"n\">quotechar</span> <span class=\"o\">=</span> <span class=\"s1\">'&quot;'</span>\n    <span class=\"n\">doublequote</span> <span class=\"o\">=</span> <span class=\"kc\">True</span>\n    <span class=\"n\">skipinitialspace</span> <span class=\"o\">=</span> <span class=\"kc\">False</span>\n    <span class=\"n\">lineterminator</span> <span class=\"o\">=</span> <span class=\"s1\">'</span><span class=\"se\">\\n</span><span class=\"s1\">'</span>\n    <span class=\"n\">quoting</span> <span class=\"o\">=</span> <span class=\"n\">QUOTE_ALL</span>\n</pre>\n<p>Usage in Robot Framework\u00ae</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">my_data_file.csv</span><span class=\"p\">    </span><span class=\"s\">dialect=excel</span>\n</pre>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">my_data_file.csv</span><span class=\"p\">    </span><span class=\"s\">dialect=excel_tab</span>\n</pre>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">my_data_file.csv</span><span class=\"p\">    </span><span class=\"s\">dialect=unix_dialect</span>\n</pre>\n<div class=\"section\" id=\"example-user-defined\">\n<h3 id=\"Example User Defined\">Example User Defined</h3>\n<p>User may define the format completely free.\nIf an option is not set, the default values are used.\nTo register a userdefined format user have to set the\noption <tt class=\"docutils literal\">dialect</tt> to <tt class=\"docutils literal\">UserDefined</tt></p>\n<p>Usage in Robot Framework\u00ae</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">my_data_file.csv</span><span class=\"p\">\n...    </span><span class=\"s\">dialect=UserDefined</span><span class=\"p\">\n...    </span><span class=\"s\">delimiter=.</span><span class=\"p\">\n...    </span><span class=\"s\">lineterminator=\\n</span>\n</pre>\n</div>\n</div>\n<div class=\"section\" id=\"defaults\">\n<h2 id=\"Defaults:\">Defaults:</h2>\n<pre class=\"code python literal-block\">\n<span class=\"n\">file</span><span class=\"o\">=</span><span class=\"kc\">None</span><span class=\"p\">,</span>\n<span class=\"n\">encoding</span><span class=\"o\">=</span><span class=\"s1\">'cp1252'</span><span class=\"p\">,</span>\n<span class=\"n\">dialect</span><span class=\"o\">=</span><span class=\"s1\">'Excel-EU'</span><span class=\"p\">,</span>\n<span class=\"n\">delimiter</span><span class=\"o\">=</span><span class=\"s1\">';'</span><span class=\"p\">,</span>\n<span class=\"n\">quotechar</span><span class=\"o\">=</span><span class=\"s1\">'&quot;'</span><span class=\"p\">,</span>\n<span class=\"n\">escapechar</span><span class=\"o\">=</span><span class=\"s1\">'</span><span class=\"se\">\\\\</span><span class=\"s1\">'</span><span class=\"p\">,</span>\n<span class=\"n\">doublequote</span><span class=\"o\">=</span><span class=\"kc\">True</span><span class=\"p\">,</span>\n<span class=\"n\">skipinitialspace</span><span class=\"o\">=</span><span class=\"kc\">False</span><span class=\"p\">,</span>\n<span class=\"n\">lineterminator</span><span class=\"o\">=</span><span class=\"s1\">'</span><span class=\"se\">\\r\\n</span><span class=\"s1\">'</span><span class=\"p\">,</span>\n<span class=\"n\">sheet_name</span><span class=\"o\">=</span><span class=\"mi\">0</span>\n</pre>\n</div>\n</div>\n<div class=\"section\" id=\"custom-datareader-classes\">\n<h1>Custom DataReader Classes</h1>\n<p>It is possible to write your own DataReader Class as a plugin for DataDriver.\nDataReader Classes are called from DataDriver to return a list of TestCaseData.</p>\n<div class=\"section\" id=\"using-custom-datareader\">\n<h2 id=\"Using Custom DataReader\">Using Custom DataReader</h2>\n<p>DataReader classes are loaded dynamically into DataDriver while runtime.\nDataDriver identifies the DataReader to load by the file extantion of the data file or by the option <tt class=\"docutils literal\">reader_class</tt>.</p>\n<div class=\"section\" id=\"select-reader-by-file-extension\">\n<h3 id=\"Select Reader by File Extension:\">Select Reader by File Extension:</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">file=mydata.csv</span>\n</pre>\n<p>This will load the class <tt class=\"docutils literal\">csv_reader</tt> from <tt class=\"docutils literal\">csv_reader.py</tt> from the same folder.</p>\n</div>\n<div class=\"section\" id=\"select-reader-by-option\">\n<h3 id=\"Select Reader by Option:\">Select Reader by Option:</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n    </span><span class=\"s\">Library</span><span class=\"p\">    </span><span class=\"s\">DataDriver</span><span class=\"p\">   </span><span class=\"s\">file=mydata.csv</span><span class=\"p\">    </span><span class=\"s\">reader_class=generic_csv_reader</span><span class=\"p\">    </span><span class=\"s\">dialect=userdefined</span><span class=\"p\">   </span><span class=\"s\">delimiter=\\t</span><span class=\"p\">    </span><span class=\"s\">encoding=UTF-8</span>\n</pre>\n<p>This will load the class <tt class=\"docutils literal\">generic_csv_reader</tt> from <tt class=\"docutils literal\">generic_csv_reader.py</tt> from same folder.</p>\n</div>\n</div>\n<div class=\"section\" id=\"create-custom-reader\">\n<h2 id=\"Create Custom Reader\">Create Custom Reader</h2>\n<p>Recommendation:</p>\n<p>Have a look to the Source Code of existing DataReader like <tt class=\"docutils literal\">csv_reader.py</tt> or <tt class=\"docutils literal\">generic_csv_reader.py</tt> .</p>\n<p>To write your own reader, create a class inherited from <tt class=\"docutils literal\">AbstractReaderClass</tt>.</p>\n<p>Your class will get all available configs from DataDriver as an object of <tt class=\"docutils literal\">ReaderConfig</tt> on <tt class=\"docutils literal\">__init__</tt>.</p>\n<p>DataDriver will call the method <tt class=\"docutils literal\">get_data_from_source</tt>\nThis method should then load your data from your custom source and stores them into list of object of <tt class=\"docutils literal\">TestCaseData</tt>.\nThis List of <tt class=\"docutils literal\">TestCaseData</tt> will be returned to DataDriver.</p>\n<p><tt class=\"docutils literal\">AbstractReaderClass</tt> has also some optional helper methods that may be useful.</p>\n<p>You can either place the custom reader with the others in DataDriver folder or anywhere on the disk.\nIn the first case or if your custom reader is in python path just use it like the others by name:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">          </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">reader_class=my_reader</span>\n</pre>\n<p>In case it is somewhere on the disk, it is possible to use an absolute or relative path to a custom Reader.\nImports of custom readers follow the same rules like importing Robot Framework\u00ae libraries.\nPath can be relative to ${EXECDIR} or to DataDriver/__init__.py:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">          </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">reader_class=C:/data/my_reader.py</span><span class=\"p\">    </span><span class=\"c\"># set custom reader\n</span><span class=\"p\">...                            </span><span class=\"s\">file_search_strategy=None</span><span class=\"p\">            </span><span class=\"c\"># set DataDriver to not check file\n</span><span class=\"p\">...                            </span><span class=\"s\">min=0</span><span class=\"p\">                                </span><span class=\"c\"># kwargs arguments for custom reader\n</span><span class=\"p\">...                            </span><span class=\"s\">max=62</span>\n</pre>\n<p>This <cite>my_reader.py</cite> should implement a class inherited from AbstractReaderClass that is named <cite>my_reader</cite>.</p>\n<pre class=\"code python literal-block\">\n<span class=\"kn\">from</span> <span class=\"nn\">DataDriver.AbstractReaderClass</span> <span class=\"kn\">import</span> <span class=\"n\">AbstractReaderClass</span>  <span class=\"c1\"># inherit class from AbstractReaderClass</span>\n<span class=\"kn\">from</span> <span class=\"nn\">DataDriver.ReaderConfig</span> <span class=\"kn\">import</span> <span class=\"n\">TestCaseData</span>  <span class=\"c1\"># return list of TestCaseData to DataDriver</span>\n\n\n<span class=\"k\">class</span> <span class=\"nc\">my_reader</span><span class=\"p\">(</span><span class=\"n\">AbstractReaderClass</span><span class=\"p\">):</span>\n\n    <span class=\"k\">def</span> <span class=\"nf\">get_data_from_source</span><span class=\"p\">(</span><span class=\"bp\">self</span><span class=\"p\">):</span>  <span class=\"c1\"># This method will be called from DataDriver to get the TestCaseData list.</span>\n        <span class=\"n\">test_data</span> <span class=\"o\">=</span> <span class=\"p\">[]</span>\n        <span class=\"k\">for</span> <span class=\"n\">i</span> <span class=\"ow\">in</span> <span class=\"nb\">range</span><span class=\"p\">(</span><span class=\"nb\">int</span><span class=\"p\">(</span><span class=\"bp\">self</span><span class=\"o\">.</span><span class=\"n\">kwargs</span><span class=\"p\">[</span><span class=\"s1\">'min'</span><span class=\"p\">]),</span> <span class=\"nb\">int</span><span class=\"p\">(</span><span class=\"bp\">self</span><span class=\"o\">.</span><span class=\"n\">kwargs</span><span class=\"p\">[</span><span class=\"s1\">'max'</span><span class=\"p\">])):</span>  <span class=\"c1\"># Dummy code to just generate some data</span>\n            <span class=\"n\">args</span> <span class=\"o\">=</span> <span class=\"p\">{</span><span class=\"s1\">'$</span><span class=\"si\">{var_1}</span><span class=\"s1\">'</span><span class=\"p\">:</span> <span class=\"nb\">str</span><span class=\"p\">(</span><span class=\"n\">i</span><span class=\"p\">),</span> <span class=\"s1\">'$</span><span class=\"si\">{var_2}</span><span class=\"s1\">'</span><span class=\"p\">:</span> <span class=\"nb\">str</span><span class=\"p\">(</span><span class=\"n\">i</span><span class=\"p\">)}</span>  <span class=\"c1\"># args is a dictionary. Variable name is the key, value is value.</span>\n            <span class=\"n\">test_data</span><span class=\"o\">.</span><span class=\"n\">append</span><span class=\"p\">(</span><span class=\"n\">TestCaseData</span><span class=\"p\">(</span><span class=\"sa\">f</span><span class=\"s1\">'test </span><span class=\"si\">{</span><span class=\"n\">i</span><span class=\"si\">}</span><span class=\"s1\">'</span><span class=\"p\">,</span> <span class=\"n\">args</span><span class=\"p\">,</span> <span class=\"p\">[</span><span class=\"s1\">'tag'</span><span class=\"p\">]))</span>  <span class=\"c1\"># add a TestCaseData object to the list of tests.</span>\n        <span class=\"k\">return</span> <span class=\"n\">test_data</span>  <span class=\"c1\"># return the list of TestCaseData to DataDriver</span>\n</pre>\n<p>See other readers as example.</p>\n</div>\n</div>\n<div class=\"section\" id=\"selection-of-test-cases-to-execute\">\n<h1>Selection of Test Cases to Execute</h1>\n<p>Because test cases that are created by DataDriver after parsing while execution,\nit is not possible to use some Robot Framework\u00ae methods to select test cases.</p>\n<p>Examples for options that have to be used differently:</p>\n<table border=\"1\" class=\"docutils\">\n<colgroup>\n<col width=\"21%\" />\n<col width=\"79%\" />\n</colgroup>\n<thead valign=\"bottom\">\n<tr><th class=\"head\">robot option</th>\n<th class=\"head\">Description</th>\n</tr>\n</thead>\n<tbody valign=\"top\">\n<tr><td><tt class=\"docutils literal\"><span class=\"pre\">--test</span></tt></td>\n<td>Selects the test cases by name.</td>\n</tr>\n<tr><td><tt class=\"docutils literal\"><span class=\"pre\">--task</span></tt></td>\n<td>Alias for --test that can be used when executing tasks.</td>\n</tr>\n<tr><td><tt class=\"docutils literal\"><span class=\"pre\">--rerunfailed</span></tt></td>\n<td>Selects failed tests from an earlier output file to be re-executed.</td>\n</tr>\n<tr><td><tt class=\"docutils literal\"><span class=\"pre\">--include</span></tt></td>\n<td>Selects the test cases by tag.</td>\n</tr>\n<tr><td><tt class=\"docutils literal\"><span class=\"pre\">--exclude</span></tt></td>\n<td>Selects the test cases by tag.</td>\n</tr>\n</tbody>\n</table>\n<div class=\"section\" id=\"selection-of-test-cases-by-name\">\n<h2 id=\"Selection of test cases by name\">Selection of test cases by name</h2>\n<div class=\"section\" id=\"select-a-single-test-case\">\n<h3 id=\"Select a single test case:\">Select a single test case:</h3>\n<p>To execute just a single test case by its exact name it is possible to execute the test suite\nand set the global variable ${DYNAMICTEST} with the name of the test case to execute as value.\nPattern must be <tt class=\"docutils literal\">suitename.testcasename</tt>.</p>\n<p>Example:</p>\n<pre class=\"code literal-block\">\nrobot --variable &quot;DYNAMICTEST:my suite name.test case to be executed&quot; my_suite_name.robot\n</pre>\n<p>Pabot uses this feature to execute a single test case when using <tt class=\"docutils literal\"><span class=\"pre\">--testlevelsplit</span></tt></p>\n</div>\n<div class=\"section\" id=\"select-a-list-of-test-cases\">\n<h3 id=\"Select a list of test cases:\">Select a list of test cases:</h3>\n<p>It is possible to set a list of test case names by using the variable ${DYNAMICTESTS} (plural).\nThis variable must be a string and the list of names must be pipe-seperated (<tt class=\"docutils literal\">|</tt>).</p>\n<p>Example:</p>\n<pre class=\"code literal-block\">\nrobot --variable DYNAMICTESTS:firstsuitename.testcase1|firstsuitename.testcase3|anothersuitename.othertestcase foldername\n</pre>\n<p>It is also possible to set the variable &#64;{DYNAMICTESTS} as a list variable from i.e. python code.</p>\n</div>\n</div>\n<div class=\"section\" id=\"re-run-failed-test-cases\">\n<h2 id=\"Re-run failed test cases:\">Re-run failed test cases:</h2>\n<p>Because it is not possible to use the command line argument <tt class=\"docutils literal\"><span class=\"pre\">--rerunfailed</span></tt> from robot directly,\nDataDriver brings a Pre-Run-Modifier that handles this issue.</p>\n<p>Normally reexecution of failed testcases has three steps.</p>\n<ul class=\"simple\">\n<li>original execution</li>\n<li>re-execution the failed ones based on original execution output</li>\n<li>merging original execution output with re-execution output</li>\n</ul>\n<p>The DataDriver.rerunfailed Pre-Run-Modifier removes all passed test cases based on a former output.xml.</p>\n<p>Example:</p>\n<pre class=\"code literal-block\">\nrobot --output original.xml tests                                                    # first execute all tests\nrobot --prerunmodifier DataDriver.rerunfailed:original.xml --output rerun.xml tests  # then re-execute failing\nrebot --merge original.xml rerun.xml                                                 # finally merge results\n</pre>\n<p>Be aware, that in this case it is not allowed to use &quot;<tt class=\"docutils literal\">:</tt>&quot; as character in the original output file path.\nIf you want to set a full path on windows like <tt class=\"docutils literal\"><span class=\"pre\">e:\\myrobottest\\output.xml</span></tt> you have to use &quot;<tt class=\"docutils literal\">;</tt>&quot;\nas argument seperator.</p>\n<p>Example:</p>\n<pre class=\"code literal-block\">\nrobot --prerunmodifier DataDriver.rerunfailed;e:\\myrobottest\\output.xml --output e:\\myrobottest\\rerun.xml tests\n</pre>\n</div>\n<div class=\"section\" id=\"filtering-with-tags\">\n<h2 id=\"Filtering with tags.\">Filtering with tags.</h2>\n<p>New in <tt class=\"docutils literal\">0.3.1</tt></p>\n<p>It is possible to use tags to filter the data source.\nTo use this, tags must be assigned to the test cases in data source.</p>\n<div class=\"section\" id=\"robot-framework-command-line-arguments\">\n<h3 id=\"Robot Framework\u00ae Command Line Arguments\">Robot Framework\u00ae Command Line Arguments</h3>\n<p>To filter the source, the normal command line arguments of Robot Framework\u00ae can be used.\nSee Robot Framework\u00ae <a class=\"reference external\" href=\"https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#tag-patterns\">Userguide</a> for more information\nBe aware that the filtering of Robot Framework\u00ae itself is done before DataDriver is called.\nThis means if the Template test is already filtered out by Robot Framework\u00ae, DataDriver can never be called.\nIf you want to use <tt class=\"docutils literal\"><span class=\"pre\">--include</span></tt> the DataDriver TestSuite should have a <tt class=\"docutils literal\">DefaultTag</tt> or <tt class=\"docutils literal\">ForceTag</tt> that\nfulfills these requirements.</p>\n<p>Example: <tt class=\"docutils literal\">robot <span class=\"pre\">--include</span> 1OR2 <span class=\"pre\">--exclude</span> foo DataDriven.robot</tt></p>\n</div>\n<div class=\"section\" id=\"filter-based-on-library-options\">\n<h3 id=\"Filter based on Library Options\">Filter based on Library Options</h3>\n<p>It is also possible to filter the data source by an init option of DataDriver.\nIf these Options are set, Robot Framework\u00ae Filtering will be ignored.</p>\n<p>Example:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">include=1OR2</span><span class=\"p\">    </span><span class=\"s\">exclude=foo</span>\n</pre>\n</div>\n</div>\n</div>\n<div class=\"section\" id=\"configure-datadriver-by-pre-run-keyword\">\n<h1>Configure DataDriver by Pre-Run Keyword</h1>\n<p>With <tt class=\"docutils literal\">config_keyword=</tt> it's possible to name a keyword that will be called from Data Driver before it starts the actual processing of the <tt class=\"docutils literal\">data file</tt>.\nOne possible usage is if the <tt class=\"docutils literal\">data file</tt> itself shall be created by another keyword dynamically during the execution of the Data Driver test suite.\nThe <tt class=\"docutils literal\">config_keyword=</tt> can be used to call that keyword and return the updated arguments (e.g. <tt class=\"docutils literal\">file</tt>) back to the Data Driver Library.</p>\n<p>The <tt class=\"docutils literal\">config keyword</tt></p>\n<ul class=\"simple\">\n<li>May be defined globally or inside each testsuite individually</li>\n<li>Gets all the arguments, that Data Driver gets from Library import, as a Robot Dictionary</li>\n<li>Shall return the (updated) Data Driver arguments as a Robot Dictionary</li>\n</ul>\n<p>Usage in Robot Framework\u00ae</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">           </span><span class=\"nn\">OperatingSystem</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">           </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">dialect=excel</span><span class=\"p\">    </span><span class=\"s\">encoding=utf_8</span><span class=\"p\">   </span><span class=\"s\">config_keyword=Config</span><span class=\"p\">\n</span><span class=\"kn\">Test Template</span><span class=\"p\">     </span><span class=\"nf\">The Keyword</span><span class=\"p\">\n\n</span><span class=\"gh\">*** Test Cases ***</span><span class=\"p\">\n</span><span class=\"gu\">Test</span><span class=\"p\">    </span><span class=\"s\">aaa</span><span class=\"p\">\n\n</span><span class=\"gh\">*** Keywords ***</span><span class=\"p\">\n</span><span class=\"gu\">The Keyword</span><span class=\"p\">\n    [</span><span class=\"kn\">Arguments</span><span class=\"p\">]    ${</span><span class=\"nv\">var</span><span class=\"p\">}\n    </span><span class=\"nf\">Log To Console</span><span class=\"p\">    ${</span><span class=\"nv\">var</span><span class=\"p\">}\n\n</span><span class=\"gu\">Config</span><span class=\"p\">\n    [</span><span class=\"kn\">Arguments</span><span class=\"p\">]    ${</span><span class=\"nv\">original_config</span><span class=\"p\">}\n    </span><span class=\"nf\">Log To Console</span><span class=\"p\">    ${</span><span class=\"nv\">original_config.dialect</span><span class=\"p\">}                </span><span class=\"c\"># just a log of the original\n</span><span class=\"p\">    </span><span class=\"nf\">Create File</span><span class=\"p\">    ${</span><span class=\"nv\">CURDIR</span><span class=\"p\">}</span><span class=\"s\">/test321.csv</span><span class=\"p\">\n    ...    </span><span class=\"s\">*** Test Cases ***,\\${var},\\n123,111,\\n321,222,</span><span class=\"p\">      </span><span class=\"c\"># generating file\n</span><span class=\"p\">    ${</span><span class=\"nv\">new_config</span><span class=\"p\">}=    </span><span class=\"nf\">Create Dictionary</span><span class=\"p\">    </span><span class=\"s\">file=test321.csv</span><span class=\"p\">     </span><span class=\"c\"># set file attribute in a dictionary\n</span><span class=\"p\">    [</span><span class=\"kn\">Return</span><span class=\"p\">]    ${</span><span class=\"nv\">new_config</span><span class=\"p\">}                                   </span><span class=\"c\"># returns {'file': 'test321.csv'}</span>\n</pre>\n</div>\n<div class=\"section\" id=\"pabot-and-datadriver\">\n<h1>Pabot and DataDriver</h1>\n<p>You should use Pabot version 1.10.0 or newer.</p>\n<p>DataDriver supports <tt class=\"docutils literal\"><span class=\"pre\">--testlevelsplit</span></tt> from pabot only if the PabotLib is in use.\nUse <tt class=\"docutils literal\"><span class=\"pre\">--pabotlib</span></tt> to enable that.</p>\n<p>When using pabot like this, DataDriver automatically splits the amount of test cases into nearly same sized groups.\nIs uses the processes count from pabot to calculate the groups.\nWhen using 8 processes with 100 test cases you will get 8 groups of tests with the size of 12 to 13 tests.\nThese 8 groups are then executed as one block with 8 processes.\nThis reduces a lot of overhead with Suite Setup and Teardown.</p>\n<p>You can switch between three modes:</p>\n<ul class=\"simple\">\n<li><tt class=\"docutils literal\">Equal</tt>: means it creates equal sizes groups</li>\n<li><tt class=\"docutils literal\">Binary</tt>: is more complex. it created a decreasing size of containers to support better balancing.</li>\n<li><tt class=\"docutils literal\">Atomic</tt>: it does not group tests at all and runs really each test case in a separate thread.</li>\n</ul>\n<p>This can be set by <tt class=\"docutils literal\">optimize_pabot</tt> in Library import.</p>\n<p><strong>Example</strong>:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">          </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">optimize_pabot=Binary</span>\n</pre>\n<p>Binary creates with 40 test cases and 8 threads something like that:</p>\n<pre class=\"code literal-block\">\nP01: 01,02,03,04,05\nP02: 06,07,08,09,10\nP03: 11,12,13,14,15\nP04: 16,17,18,19,20\nP05: 21,22,23\nP06: 24,25,26\nP07: 27,28,29\nP08: 30,31,32\nP09: 33\nP10: 34\nP11: 35\nP12: 36\nP13: 37\nP14: 38\nP15: 39\nP16: 40\n</pre>\n</div>\n</div>\n", "version": "1.6.1", "generated": "2022-03-23 20:23:58", "type": "LIBRARY", "scope": "SUITE", "docFormat": "HTML", "source": "/System/Volumes/Data/Source/Snooz82/robotframework-datadriver/src/DataDriver/__init__.py", "lineno": 54, "tags": [], "inits": [{"name": "__init__", "args": [{"name": "file", "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "file: str | None = None"}, {"name": "encoding", "types": ["Encodings", "Any"], "typedocs": {"Encodings": "Encodings"}, "defaultValue": "cp1252", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding: Encodings | Any = cp1252"}, {"name": "dialect", "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "Excel-EU", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dialect: str = Excel-EU"}, {"name": "delimiter", "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": ";", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delimiter: str = ;"}, {"name": "quotechar", "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "\"", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "quotechar: str = \""}, {"name": "escapechar", "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "\\\\", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "escapechar: str = \\\\"}, {"name": "doublequote", "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "doublequote: bool = True"}, {"name": "skipinitialspace", "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "skipinitialspace: bool = False"}, {"name": "lineterminator", "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "\\r\\n", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "lineterminator: str = \\r\\n"}, {"name": "", "types": [], "typedocs": {}, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "sheet_name", "types": ["str", "int"], "typedocs": {"str": "string", "int": "integer"}, "defaultValue": "0", "kind": "NAMED_ONLY", "required": false, "repr": "sheet_name: str | int = 0"}, {"name": "reader_class", "types": ["AbstractReaderClass", "str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "reader_class: AbstractReaderClass | str | None = None"}, {"name": "file_search_strategy", "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "PATH", "kind": "NAMED_ONLY", "required": false, "repr": "file_search_strategy: str = PATH"}, {"name": "file_regex", "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "(?i)(.*?)(\\\\.csv)", "kind": "NAMED_ONLY", "required": false, "repr": "file_regex: str = (?i)(.*?)(\\\\.csv)"}, {"name": "include", "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "include: str | None = None"}, {"name": "exclude", "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "exclude: str | None = None"}, {"name": "handle_template_tags", "types": ["TagHandling"], "typedocs": {"TagHandling": "TagHandling"}, "defaultValue": "UnsetTags", "kind": "NAMED_ONLY", "required": false, "repr": "handle_template_tags: TagHandling = UnsetTags"}, {"name": "listseperator", "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": ",", "kind": "NAMED_ONLY", "required": false, "repr": "listseperator: str = ,"}, {"name": "config_keyword", "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "config_keyword: str | None = None"}, {"name": "optimize_pabot", "types": ["PabotOpt"], "typedocs": {"PabotOpt": "PabotOpt"}, "defaultValue": "Equal", "kind": "NAMED_ONLY", "required": false, "repr": "optimize_pabot: PabotOpt = Equal"}, {"name": "kwargs", "types": ["Any"], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs: Any"}], "doc": "<div class=\"document\">\n<p><strong>Example:</strong></p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span>\n</pre>\n<div class=\"section\" id=\"options\">\n<h1>Options</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">\n...    </span><span class=\"s\">file=None</span><span class=\"p\">\n...    </span><span class=\"s\">encoding=cp1252</span><span class=\"p\">\n...    </span><span class=\"s\">dialect=Excel-EU</span><span class=\"p\">\n...    </span><span class=\"s\">delimiter=;</span><span class=\"p\">\n...    </span><span class=\"s\">quotechar=&quot;</span><span class=\"p\">\n...    </span><span class=\"s\">escapechar=\\\\</span><span class=\"p\">\n...    </span><span class=\"s\">doublequote=True</span><span class=\"p\">\n...    </span><span class=\"s\">skipinitialspace=False</span><span class=\"p\">\n...    </span><span class=\"s\">lineterminator=\\r\\n</span><span class=\"p\">\n...    </span><span class=\"s\">*</span><span class=\"p\">  </span><span class=\"c\"># the following are named only arguments\n</span><span class=\"p\">...    </span><span class=\"s\">sheet_name=0</span><span class=\"p\">\n...    </span><span class=\"s\">reader_class=None</span><span class=\"p\">\n...    </span><span class=\"s\">file_search_strategy=PATH</span><span class=\"p\">\n...    </span><span class=\"s\">file_regex=(?i)(.*?)(\\.csv)</span><span class=\"p\">\n...    </span><span class=\"s\">include=None</span><span class=\"p\">\n...    </span><span class=\"s\">exclude=None</span><span class=\"p\">\n...    </span><span class=\"s\">handle_template_tags=UnsetTags</span><span class=\"p\">\n...    </span><span class=\"s\">listseperator=,</span><span class=\"p\">\n...    </span><span class=\"s\">config_keyword=None</span><span class=\"p\">\n...    </span><span class=\"s\">optimize_pabot=Equal</span><span class=\"p\">\n...    &amp;{</span><span class=\"nv\">kwargs</span><span class=\"p\">}</span>\n</pre>\n<div class=\"section\" id=\"file\">\n<h2>File</h2>\n<p>Defines which data file to be read. Maybe None or an extension like <tt class=\"docutils literal\">.txt</tt> or relative or absolute path.\n<tt class=\"docutils literal\">file_search_strategy=</tt> and <tt class=\"docutils literal\">file_regex</tt> may also have influence here.</p>\n</div>\n<div class=\"section\" id=\"encoding\">\n<h2>Encoding</h2>\n<p><tt class=\"docutils literal\">encoding</tt> must be set if it shall not be cp1252.</p>\n<p><strong>Examples</strong>:</p>\n<p><tt class=\"docutils literal\">cp1252, ascii, <span class=\"pre\">iso-8859-1,</span> <span class=\"pre\">latin-1,</span> utf_8, utf_16, utf_16_be, utf_16_le</tt></p>\n<p>See <a class=\"reference external\" href=\"https://docs.python.org/3/library/codecs.html#standard-encodings\">Python Standard Encoding</a> for more encodings</p>\n</div>\n<div class=\"section\" id=\"dialect-to-lineterminator\">\n<h2>Dialect to LineTerminator</h2>\n<p>Defines how a csv file is interpreted.</p>\n</div>\n<div class=\"section\" id=\"reader-class\">\n<h2>Reader Class</h2>\n<p>Defines which custom DataReader shall be loaded and get handed over all configs to deliver the TestCaseData.</p>\n</div>\n<div class=\"section\" id=\"include-exclude\">\n<h2>Include &amp; Exclude</h2>\n<p>Alternative way to CLI Options of Robot Framework\u00ae to filter the specific TestCaseData based on given Tags.</p>\n</div>\n<div class=\"section\" id=\"handle-template-tags\">\n<h2>Handle Template Tags</h2>\n<p>It can be configured how the tags of the template test will be added to the data-driven test cases.</p>\n</div>\n<div class=\"section\" id=\"list-separator\">\n<h2>List Separator</h2>\n<p>Defines how list values or dictionary values are seperated.</p>\n</div>\n<div class=\"section\" id=\"config-keyword\">\n<h2>Config Keyword</h2>\n<p>Keyword that is executed before DataDriver starts working. Can manipulate all data.</p>\n</div>\n<div class=\"section\" id=\"optimize-pabot\">\n<h2>Optimize Pabot</h2>\n<p>When DataDriver is used together with Pabot, it optimizes the <tt class=\"docutils literal\"><span class=\"pre\">--testlevelsplit</span></tt> to be faster.</p>\n</div>\n</div>\n</div>\n", "shortdoc": "**Example:**", "tags": [], "source": "/System/Volumes/Data/Source/Snooz82/robotframework-datadriver/src/DataDriver/DataDriver.py", "lineno": 1342}], "keywords": [], "dataTypes": {"enums": [{"type": "Enum", "name": "Encodings", "doc": "<div class=\"document\">\n<p>Python comes with a number of codecs built-in,\neither implemented as C functions or with dictionaries as mapping tables.\nThe following table lists the codecs by name,\ntogether with a few common aliases, and the languages for which the encoding is likely used.\nNeither the list of aliases nor the list of languages is meant to be exhaustive.\nNotice that spelling alternatives that only differ in case or use a hyphen instead\nof an underscore are also valid aliases; therefore, e.g. <tt class=\"docutils literal\"><span class=\"pre\">utf-8<span class=\"name\"></span> is a valid alias for the </span>`utf_8</tt> codec.</p>\n<p><em>CPython implementation detail:</em> Some common encodings can bypass the codecs lookup machinery to improve performance.\nThese optimization opportunities are only recognized by CPython for a limited set of (case insensitive) aliases:\nutf-8, utf8, latin-1, latin1, iso-8859-1, iso8859-1, mbcs (Windows only),\nascii, us-ascii, utf-16, utf16, utf-32, utf32, and the same using underscores instead of dashes.\nUsing alternative aliases for these encodings may result in slower execution.</p>\n<p>Changed in version 3.6: Optimization opportunity recognized for us-ascii.</p>\n<p>Many of the character sets support the same languages. They vary in individual characters (e.g. whether the EURO SIGN is supported or not), and in the assignment of characters to code positions. For the European languages in particular, the following variants typically exist:</p>\n<ul class=\"simple\">\n<li>utf-8</li>\n<li>cp1252</li>\n<li>an ISO 8859 codeset</li>\n<li>a Microsoft Windows code page, which is typically derived from an 8859 codeset, but replaces control characters with additional graphic characters</li>\n<li>an IBM EBCDIC code page</li>\n<li>an IBM PC code page, which is ASCII compatible</li>\n</ul>\n</div>\n", "members": [{"name": "ascii", "value": "1"}, {"name": "big5", "value": "2"}, {"name": "big5hkscs", "value": "3"}, {"name": "cp037", "value": "4"}, {"name": "cp273", "value": "5"}, {"name": "cp424", "value": "6"}, {"name": "cp437", "value": "7"}, {"name": "cp500", "value": "8"}, {"name": "cp720", "value": "9"}, {"name": "cp737", "value": "10"}, {"name": "cp775", "value": "11"}, {"name": "cp850", "value": "12"}, {"name": "cp852", "value": "13"}, {"name": "cp855", "value": "14"}, {"name": "cp856", "value": "15"}, {"name": "cp857", "value": "16"}, {"name": "cp858", "value": "17"}, {"name": "cp860", "value": "18"}, {"name": "cp861", "value": "19"}, {"name": "cp862", "value": "20"}, {"name": "cp863", "value": "21"}, {"name": "cp864", "value": "22"}, {"name": "cp865", "value": "23"}, {"name": "cp866", "value": "24"}, {"name": "cp869", "value": "25"}, {"name": "cp874", "value": "26"}, {"name": "cp875", "value": "27"}, {"name": "cp932", "value": "28"}, {"name": "cp949", "value": "29"}, {"name": "cp950", "value": "30"}, {"name": "cp1006", "value": "31"}, {"name": "cp1026", "value": "32"}, {"name": "cp1125", "value": "33"}, {"name": "cp1140", "value": "34"}, {"name": "cp1250", "value": "35"}, {"name": "cp1251", "value": "36"}, {"name": "cp1252", "value": "37"}, {"name": "cp1253", "value": "38"}, {"name": "cp1254", "value": "39"}, {"name": "cp1255", "value": "40"}, {"name": "cp1256", "value": "41"}, {"name": "cp1257", "value": "42"}, {"name": "cp1258", "value": "43"}, {"name": "euc_jp", "value": "44"}, {"name": "euc_jis_2004", "value": "45"}, {"name": "euc_jisx0213", "value": "46"}, {"name": "euc_kr", "value": "47"}, {"name": "gb2312", "value": "48"}, {"name": "gbk", "value": "49"}, {"name": "gb18030", "value": "50"}, {"name": "hz", "value": "51"}, {"name": "iso2022_jp", "value": "52"}, {"name": "iso2022_jp_1", "value": "53"}, {"name": "iso2022_jp_2", "value": "54"}, {"name": "iso2022_jp_2004", "value": "55"}, {"name": "iso2022_jp_3", "value": "56"}, {"name": "iso2022_jp_ext", "value": "57"}, {"name": "iso2022_kr", "value": "58"}, {"name": "latin_1", "value": "59"}, {"name": "iso8859_2", "value": "60"}, {"name": "iso8859_3", "value": "61"}, {"name": "iso8859_4", "value": "62"}, {"name": "iso8859_5", "value": "63"}, {"name": "iso8859_6", "value": "64"}, {"name": "iso8859_7", "value": "65"}, {"name": "iso8859_8", "value": "66"}, {"name": "iso8859_9", "value": "67"}, {"name": "iso8859_10", "value": "68"}, {"name": "iso8859_11", "value": "69"}, {"name": "iso8859_13", "value": "70"}, {"name": "iso8859_14", "value": "71"}, {"name": "iso8859_15", "value": "72"}, {"name": "iso8859_16", "value": "73"}, {"name": "johab", "value": "74"}, {"name": "koi8_r", "value": "75"}, {"name": "koi8_t", "value": "76"}, {"name": "koi8_u", "value": "77"}, {"name": "kz1048", "value": "78"}, {"name": "mac_cyrillic", "value": "79"}, {"name": "mac_greek", "value": "80"}, {"name": "mac_iceland", "value": "81"}, {"name": "mac_latin2", "value": "82"}, {"name": "mac_roman", "value": "83"}, {"name": "mac_turkish", "value": "84"}, {"name": "ptcp154", "value": "85"}, {"name": "shift_jis", "value": "86"}, {"name": "shift_jis_2004", "value": "87"}, {"name": "shift_jisx0213", "value": "88"}, {"name": "utf_32", "value": "89"}, {"name": "utf_32_be", "value": "90"}, {"name": "utf_32_le", "value": "91"}, {"name": "utf_16", "value": "92"}, {"name": "utf_16_be", "value": "93"}, {"name": "utf_16_le", "value": "94"}, {"name": "utf_7", "value": "95"}, {"name": "utf_8", "value": "96"}, {"name": "utf_8_sig", "value": "97"}]}, {"type": "Enum", "name": "PabotOpt", "doc": "<div class=\"document\">\n<p>You can switch Pabot --testlevelsplit between three modes:</p>\n<ul class=\"simple\">\n<li>Equal: means it creates equal sizes groups</li>\n<li>Binary: is more complex. it created a decreasing size of containers to support better balancing.</li>\n<li>Atomic: it does not group tests at all and runs really each test case in a separate thread.</li>\n</ul>\n<p>See <a class=\"reference external\" href=\"#pabot-and-datadriver\">Pabot and DataDriver</a> for more details.</p>\n<p>This can be set by <tt class=\"docutils literal\">optimize_pabot</tt> in Library import.</p>\n</div>\n", "members": [{"name": "Equal", "value": "1"}, {"name": "Binary", "value": "2"}, {"name": "Atomic", "value": "3"}]}, {"type": "Enum", "name": "TagHandling", "doc": "<div class=\"document\">\n<p>You can configure how to handle tags from the template in generated tests:</p>\n<ul class=\"simple\">\n<li>ForceTags: Will add all tags of the template test to all data-driven test cases.</li>\n<li>UnsetTags: Will add only these tags from template test to the tests, that are not assigned to any of the test cases.</li>\n<li>DefaultTags: Will only add tags to data-driven test if no tag is set on that test.</li>\n<li>NoTags: Will not add any tags from the template to date-driven tests.</li>\n</ul>\n</div>\n", "members": [{"name": "ForceTags", "value": "1"}, {"name": "UnsetTags", "value": "2"}, {"name": "DefaultTags", "value": "3"}, {"name": "NoTags", "value": "4"}]}], "typedDicts": []}, "typedocs": [{"type": "Standard", "name": "boolean", "doc": "<p>Strings <code>TRUE</code>, <code>YES</code>, <code>ON</code> and <code>1</code> are converted to Boolean <code>True</code>, the empty string as well as strings <code>FALSE</code>, <code>NO</code>, <code>OFF</code> and <code>0</code> are converted to Boolean <code>False</code>, and the string <code>NONE</code> is converted to the Python <code>None</code> object. Other strings and other accepted values are passed as-is, allowing keywords to handle them specially if needed. All string comparisons are case-insensitive.</p>\n<p>Examples: <code>TRUE</code> (converted to <code>True</code>), <code>off</code> (converted to <code>False</code>), <code>example</code> (used as-is)</p>", "usages": ["__init__"], "accepts": ["string", "integer", "float", "None"]}, {"type": "Enum", "name": "Encodings", "doc": "<div class=\"document\">\n<p>Python comes with a number of codecs built-in,\neither implemented as C functions or with dictionaries as mapping tables.\nThe following table lists the codecs by name,\ntogether with a few common aliases, and the languages for which the encoding is likely used.\nNeither the list of aliases nor the list of languages is meant to be exhaustive.\nNotice that spelling alternatives that only differ in case or use a hyphen instead\nof an underscore are also valid aliases; therefore, e.g. <tt class=\"docutils literal\"><span class=\"pre\">utf-8<span class=\"name\"></span> is a valid alias for the </span>`utf_8</tt> codec.</p>\n<p><em>CPython implementation detail:</em> Some common encodings can bypass the codecs lookup machinery to improve performance.\nThese optimization opportunities are only recognized by CPython for a limited set of (case insensitive) aliases:\nutf-8, utf8, latin-1, latin1, iso-8859-1, iso8859-1, mbcs (Windows only),\nascii, us-ascii, utf-16, utf16, utf-32, utf32, and the same using underscores instead of dashes.\nUsing alternative aliases for these encodings may result in slower execution.</p>\n<p>Changed in version 3.6: Optimization opportunity recognized for us-ascii.</p>\n<p>Many of the character sets support the same languages. They vary in individual characters (e.g. whether the EURO SIGN is supported or not), and in the assignment of characters to code positions. For the European languages in particular, the following variants typically exist:</p>\n<ul class=\"simple\">\n<li>utf-8</li>\n<li>cp1252</li>\n<li>an ISO 8859 codeset</li>\n<li>a Microsoft Windows code page, which is typically derived from an 8859 codeset, but replaces control characters with additional graphic characters</li>\n<li>an IBM EBCDIC code page</li>\n<li>an IBM PC code page, which is ASCII compatible</li>\n</ul>\n</div>\n", "usages": ["__init__"], "accepts": ["string"], "members": [{"name": "ascii", "value": "1"}, {"name": "big5", "value": "2"}, {"name": "big5hkscs", "value": "3"}, {"name": "cp037", "value": "4"}, {"name": "cp273", "value": "5"}, {"name": "cp424", "value": "6"}, {"name": "cp437", "value": "7"}, {"name": "cp500", "value": "8"}, {"name": "cp720", "value": "9"}, {"name": "cp737", "value": "10"}, {"name": "cp775", "value": "11"}, {"name": "cp850", "value": "12"}, {"name": "cp852", "value": "13"}, {"name": "cp855", "value": "14"}, {"name": "cp856", "value": "15"}, {"name": "cp857", "value": "16"}, {"name": "cp858", "value": "17"}, {"name": "cp860", "value": "18"}, {"name": "cp861", "value": "19"}, {"name": "cp862", "value": "20"}, {"name": "cp863", "value": "21"}, {"name": "cp864", "value": "22"}, {"name": "cp865", "value": "23"}, {"name": "cp866", "value": "24"}, {"name": "cp869", "value": "25"}, {"name": "cp874", "value": "26"}, {"name": "cp875", "value": "27"}, {"name": "cp932", "value": "28"}, {"name": "cp949", "value": "29"}, {"name": "cp950", "value": "30"}, {"name": "cp1006", "value": "31"}, {"name": "cp1026", "value": "32"}, {"name": "cp1125", "value": "33"}, {"name": "cp1140", "value": "34"}, {"name": "cp1250", "value": "35"}, {"name": "cp1251", "value": "36"}, {"name": "cp1252", "value": "37"}, {"name": "cp1253", "value": "38"}, {"name": "cp1254", "value": "39"}, {"name": "cp1255", "value": "40"}, {"name": "cp1256", "value": "41"}, {"name": "cp1257", "value": "42"}, {"name": "cp1258", "value": "43"}, {"name": "euc_jp", "value": "44"}, {"name": "euc_jis_2004", "value": "45"}, {"name": "euc_jisx0213", "value": "46"}, {"name": "euc_kr", "value": "47"}, {"name": "gb2312", "value": "48"}, {"name": "gbk", "value": "49"}, {"name": "gb18030", "value": "50"}, {"name": "hz", "value": "51"}, {"name": "iso2022_jp", "value": "52"}, {"name": "iso2022_jp_1", "value": "53"}, {"name": "iso2022_jp_2", "value": "54"}, {"name": "iso2022_jp_2004", "value": "55"}, {"name": "iso2022_jp_3", "value": "56"}, {"name": "iso2022_jp_ext", "value": "57"}, {"name": "iso2022_kr", "value": "58"}, {"name": "latin_1", "value": "59"}, {"name": "iso8859_2", "value": "60"}, {"name": "iso8859_3", "value": "61"}, {"name": "iso8859_4", "value": "62"}, {"name": "iso8859_5", "value": "63"}, {"name": "iso8859_6", "value": "64"}, {"name": "iso8859_7", "value": "65"}, {"name": "iso8859_8", "value": "66"}, {"name": "iso8859_9", "value": "67"}, {"name": "iso8859_10", "value": "68"}, {"name": "iso8859_11", "value": "69"}, {"name": "iso8859_13", "value": "70"}, {"name": "iso8859_14", "value": "71"}, {"name": "iso8859_15", "value": "72"}, {"name": "iso8859_16", "value": "73"}, {"name": "johab", "value": "74"}, {"name": "koi8_r", "value": "75"}, {"name": "koi8_t", "value": "76"}, {"name": "koi8_u", "value": "77"}, {"name": "kz1048", "value": "78"}, {"name": "mac_cyrillic", "value": "79"}, {"name": "mac_greek", "value": "80"}, {"name": "mac_iceland", "value": "81"}, {"name": "mac_latin2", "value": "82"}, {"name": "mac_roman", "value": "83"}, {"name": "mac_turkish", "value": "84"}, {"name": "ptcp154", "value": "85"}, {"name": "shift_jis", "value": "86"}, {"name": "shift_jis_2004", "value": "87"}, {"name": "shift_jisx0213", "value": "88"}, {"name": "utf_32", "value": "89"}, {"name": "utf_32_be", "value": "90"}, {"name": "utf_32_le", "value": "91"}, {"name": "utf_16", "value": "92"}, {"name": "utf_16_be", "value": "93"}, {"name": "utf_16_le", "value": "94"}, {"name": "utf_7", "value": "95"}, {"name": "utf_8", "value": "96"}, {"name": "utf_8_sig", "value": "97"}]}, {"type": "Standard", "name": "integer", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#int\">int</a> built-in function. Floating point numbers are accepted only if they can be represented as integers exactly. For example, <code>1.0</code> is accepted and <code>1.1</code> is not.</p>\n<p>Starting from RF 4.1, it is possible to use hexadecimal, octal and binary numbers by prefixing values with <code>0x</code>, <code>0o</code> and <code>0b</code>, respectively.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>42</code>, <code>-1</code>, <code>0b1010</code>, <code>10 000 000</code>, <code>0xBAD_C0FFEE</code></p>", "usages": ["__init__"], "accepts": ["string", "float"]}, {"type": "Standard", "name": "None", "doc": "<p>String <code>NONE</code> (case-insensitive) is converted to Python <code>None</code> object. Other values cause an error.</p>", "usages": ["__init__"], "accepts": ["string"]}, {"type": "Enum", "name": "PabotOpt", "doc": "<div class=\"document\">\n<p>You can switch Pabot --testlevelsplit between three modes:</p>\n<ul class=\"simple\">\n<li>Equal: means it creates equal sizes groups</li>\n<li>Binary: is more complex. it created a decreasing size of containers to support better balancing.</li>\n<li>Atomic: it does not group tests at all and runs really each test case in a separate thread.</li>\n</ul>\n<p>See <a class=\"reference external\" href=\"#pabot-and-datadriver\">Pabot and DataDriver</a> for more details.</p>\n<p>This can be set by <tt class=\"docutils literal\">optimize_pabot</tt> in Library import.</p>\n</div>\n", "usages": ["__init__"], "accepts": ["string"], "members": [{"name": "Equal", "value": "1"}, {"name": "Binary", "value": "2"}, {"name": "Atomic", "value": "3"}]}, {"type": "Standard", "name": "string", "doc": "<p>All arguments are converted to Unicode strings.</p>", "usages": ["__init__"], "accepts": ["Any"]}, {"type": "Enum", "name": "TagHandling", "doc": "<div class=\"document\">\n<p>You can configure how to handle tags from the template in generated tests:</p>\n<ul class=\"simple\">\n<li>ForceTags: Will add all tags of the template test to all data-driven test cases.</li>\n<li>UnsetTags: Will add only these tags from template test to the tests, that are not assigned to any of the test cases.</li>\n<li>DefaultTags: Will only add tags to data-driven test if no tag is set on that test.</li>\n<li>NoTags: Will not add any tags from the template to date-driven tests.</li>\n</ul>\n</div>\n", "usages": ["__init__"], "accepts": ["string"], "members": [{"name": "ForceTags", "value": "1"}, {"name": "UnsetTags", "value": "2"}, {"name": "DefaultTags", "value": "3"}, {"name": "NoTags", "value": "4"}]}]}
+libdoc = {"specversion": 1, "name": "DataDriver", "doc": "<div class=\"document\" id=\"datadriver-for-robot-framework\">\n<h1 class=\"title\">DataDriver for Robot Framework\u00ae</h1>\n<p>DataDriver is a Data-Driven extension for Robot Framework\u00ae.\nThis document explains how to use the DataDriver library listener. For\ninformation about installation, support, and more, please visit the\n<a class=\"reference external\" href=\"https://github.com/Snooz82/robotframework-datadriver\">project page</a></p>\n<p>For more information about Robot Framework\u00ae, see <a class=\"reference external\" href=\"https://robotframework.org\">https://robotframework.org</a>.</p>\n<p>DataDriver is used/imported as Library but does not provide keywords\nwhich can be used in a test. DataDriver uses the Listener Interface\nVersion 3 to manipulate the test cases and creates new test cases based\non a Data-File that contains the data for Data-Driven Testing. These\ndata file may be .csv , .xls or .xlsx files.</p>\n<p>Data Driver is also able to cooperate with Microsoft PICT. An Open\nSource Windows tool for data combination testing. Pict is able to\ngenerate data combinations based on textual model definitions.\n<a class=\"reference external\" href=\"https://github.com/Microsoft/pict\">https://github.com/Microsoft/pict</a></p>\n<p>It is also possible to implement own DataReaders in Python to read\nyour test data from some other sources, like databases or json files.</p>\n<div class=\"section\" id=\"installation\">\n<h1>Installation</h1>\n<p>If you already have Python &gt;= 3.6 with pip installed, you can simply\nrun:</p>\n<p><tt class=\"docutils literal\">pip install <span class=\"pre\">--upgrade</span> <span class=\"pre\">robotframework-datadriver</span></tt></p>\n<div class=\"section\" id=\"excel-support\">\n<h2 id=\"Excel Support\">Excel Support</h2>\n<p>For file support of <tt class=\"docutils literal\">xls</tt> or <tt class=\"docutils literal\">xlsx</tt> file you need to install the extra XLS or the dependencies.\nIt contains the dependencies of pandas, numpy and xlrd. Just add [XLS] to your installation.\nNew since version 3.6.</p>\n<p><tt class=\"docutils literal\">pip install <span class=\"pre\">--upgrade</span> <span class=\"pre\">robotframework-datadriver[XLS]</span></tt></p>\n</div>\n<div class=\"section\" id=\"python-2\">\n<h2 id=\"Python 2\">Python 2</h2>\n<p>or if you have Python 2 and 3 installed in parallel you may use</p>\n<p><tt class=\"docutils literal\">pip3 install <span class=\"pre\">--upgrade</span> <span class=\"pre\">robotframework-datadriver</span></tt></p>\n<p>DataDriver is compatible with Python 2.7 only in Version 0.2.7.</p>\n<p><tt class=\"docutils literal\">pip install <span class=\"pre\">--upgrade</span> <span class=\"pre\">robotframework-datadriver==0.2.7</span></tt></p>\n<p>Because Python 2.7 is deprecated, there are no new feature to python 2.7 compatible version.</p>\n</div>\n</div>\n<div class=\"section\" id=\"table-of-contents\">\n<h1>Table of contents</h1>\n<ul class=\"simple\">\n<li><a class=\"reference internal\" href=\"#what-datadriver-does\">What DataDriver Does</a></li>\n<li><a class=\"reference internal\" href=\"#how-datadriver-works\">How DataDriver Works</a></li>\n<li><a class=\"reference internal\" href=\"#usage\">Usage</a></li>\n<li><a class=\"reference internal\" href=\"#structure-of-test-suite\">Structure of Test Suite</a></li>\n<li><a class=\"reference internal\" href=\"#structure-of-data-file\">Structure of data file</a></li>\n<li><a class=\"reference internal\" href=\"#accessing-test-data-from-robot-variables\">Accessing Test Data From Robot Variables</a></li>\n<li><a class=\"reference internal\" href=\"#data-sources\">Data Sources</a></li>\n<li><a class=\"reference internal\" href=\"#file-encoding-and-csv-dialect\">File Encoding and CSV Dialect</a></li>\n<li><a class=\"reference internal\" href=\"#custom-datareader-classes\">Custom DataReader Classes</a></li>\n<li><a class=\"reference internal\" href=\"#selection-of-test-cases-to-execute\">Selection of Test Cases to Execute</a></li>\n<li><a class=\"reference internal\" href=\"#configure-datadriver-by-pre-run-keyword\">Configure DataDriver by Pre-Run Keyword</a></li>\n<li><a class=\"reference internal\" href=\"#pabot-and-datadriver\">Pabot and DataDriver</a></li>\n</ul>\n</div>\n<div class=\"section\" id=\"what-datadriver-does\">\n<h1>What DataDriver Does</h1>\n<p>DataDriver is an alternative approach to create Data-Driven Tests with\nRobot Framework\u00ae. DataDriver creates multiple test cases based on a test\ntemplate and data content of a csv or Excel file. All created tests\nshare the same test sequence (keywords) and differ in the test data.\nBecause these tests are created on runtime only the template has to be\nspecified within the robot test specification and the used data are\nspecified in an external data file.</p>\n<div class=\"section\" id=\"robocon-2020-talk\">\n<h2 id=\"RoboCon 2020 Talk\">RoboCon 2020 Talk</h2>\n<a class=\"reference external image-reference\" href=\"https://www.youtube.com/watch?v=RtEUr1i4x3s\"><img alt=\"https://img.youtube.com/vi/RtEUr1i4x3s/0.jpg\" src=\"https://img.youtube.com/vi/RtEUr1i4x3s/0.jpg\" /></a>\n<p>Brief overview what DataDriver is and how it works at the RoboCon 2020 in Helsiki.</p>\n</div>\n<div class=\"section\" id=\"alternative-approach\">\n<h2 id=\"Alternative approach\">Alternative approach</h2>\n<p>DataDriver gives an alternative to the build in data driven approach\nlike:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Resource</span><span class=\"p\">    </span><span class=\"nn\">login_resources.robot</span><span class=\"p\">\n\n</span><span class=\"kn\">Suite Setup</span><span class=\"p\">    </span><span class=\"nf\">Open my Browser</span><span class=\"p\">\n</span><span class=\"kn\">Suite Teardown</span><span class=\"p\">    </span><span class=\"nf\">Close Browsers</span><span class=\"p\">\n</span><span class=\"kn\">Test Setup</span><span class=\"p\">      </span><span class=\"nf\">Open Login Page</span><span class=\"p\">\n</span><span class=\"kn\">Test Template</span><span class=\"p\">    </span><span class=\"nf\">Invalid login</span><span class=\"p\">\n\n\n</span><span class=\"gh\">*** Test Cases ***</span><span class=\"p\">       </span><span class=\"gh\">User</span><span class=\"p\">        </span><span class=\"gh\">Passwort</span><span class=\"p\">\n</span><span class=\"gu\">Right user empty pass</span><span class=\"p\">    </span><span class=\"s\">demo</span><span class=\"p\">        ${</span><span class=\"nv\">EMPTY</span><span class=\"p\">}\n</span><span class=\"gu\">Right user wrong pass</span><span class=\"p\">    </span><span class=\"s\">demo</span><span class=\"p\">        </span><span class=\"s\">FooBar</span><span class=\"p\">\n\n</span><span class=\"gu\">Empty user right pass</span><span class=\"p\">    ${</span><span class=\"nv\">EMPTY</span><span class=\"p\">}    </span><span class=\"s\">mode</span><span class=\"p\">\n</span><span class=\"gu\">Empty user empty pass</span><span class=\"p\">    ${</span><span class=\"nv\">EMPTY</span><span class=\"p\">}    ${</span><span class=\"nv\">EMPTY</span><span class=\"p\">}\n</span><span class=\"gu\">Empty user wrong pass</span><span class=\"p\">    ${</span><span class=\"nv\">EMPTY</span><span class=\"p\">}    </span><span class=\"s\">FooBar</span><span class=\"p\">\n\n</span><span class=\"gu\">Wrong user right pass</span><span class=\"p\">    </span><span class=\"s\">FooBar</span><span class=\"p\">      </span><span class=\"s\">mode</span><span class=\"p\">\n</span><span class=\"gu\">Wrong user empty pass</span><span class=\"p\">    </span><span class=\"s\">FooBar</span><span class=\"p\">      ${</span><span class=\"nv\">EMPTY</span><span class=\"p\">}\n</span><span class=\"gu\">Wrong user wrong pass</span><span class=\"p\">    </span><span class=\"s\">FooBar</span><span class=\"p\">      </span><span class=\"s\">FooBar</span><span class=\"p\">\n\n</span><span class=\"gh\">*** Keywords ***</span><span class=\"p\">\n</span><span class=\"gu\">Invalid login</span><span class=\"p\">\n    [</span><span class=\"kn\">Arguments</span><span class=\"p\">]    ${</span><span class=\"nv\">username</span><span class=\"p\">}    ${</span><span class=\"nv\">password</span><span class=\"p\">}\n    </span><span class=\"nf\">Input username</span><span class=\"p\">    ${</span><span class=\"nv\">username</span><span class=\"p\">}\n    </span><span class=\"nf\">Input pwd</span><span class=\"p\">    ${</span><span class=\"nv\">password</span><span class=\"p\">}\n    </span><span class=\"nf\">click login button</span><span class=\"p\">\n    </span><span class=\"nf\">Error page should be visible</span>\n</pre>\n<p>This inbuilt approach is fine for a hand full of data and a hand full of\ntest cases. If you have generated or calculated data and specially if\nyou have a variable amount of test case / combinations these robot files\nbecome quite a pain. With DataDriver you may write the same test case\nsyntax but only once and deliver the data from en external data file.</p>\n<p>One of the rare reasons when Microsoft\u00ae Excel or LibreOffice Calc may be\nused in testing\u2026 ;-)</p>\n<p><a class=\"reference external\" href=\"#example-suite\">See example test suite</a></p>\n<p><a class=\"reference external\" href=\"#example-csv\">See example csv table</a></p>\n</div>\n</div>\n<div class=\"section\" id=\"how-datadriver-works\">\n<h1>How DataDriver Works</h1>\n<p>When the DataDriver is used in a test suite it will be activated before\nthe test suite starts. It uses the Listener Interface Version 3 of Robot\nFramework\u00ae to read and modify the test specification objects. After\nactivation it searches for the <tt class=\"docutils literal\">Test Template</tt> -Keyword to analyze the\n<tt class=\"docutils literal\">[Arguments]</tt> it has. As a second step, it loads the data from the\nspecified data source. Based on the <tt class=\"docutils literal\">Test Template</tt> -Keyword, DataDriver\ncreates as much test cases as data sets are in the data source.</p>\n<p>In the case that data source is csv (Default)\nAs values for the arguments of the <tt class=\"docutils literal\">Test Template</tt> -Keyword, DataDriver\nreads values from the column of the CSV file with the matching name of the\n<tt class=\"docutils literal\">[Arguments]</tt>.\nFor each line of the CSV data table, one test case will be created. It\nis also possible to specify test case names, tags and documentation for\neach test case in the specific test suite related CSV file.</p>\n</div>\n<div class=\"section\" id=\"usage\">\n<h1>Usage</h1>\n<p>Data Driver is a &quot;Library Listener&quot; but does not provide keywords.\nBecause Data Driver is a listener and a library at the same time it\nsets itself as a listener when this library is imported into a test suite.</p>\n<p>To use it, just use it as Library in your suite. You may use the first\nargument (option) which may set the file name or path to the data file.</p>\n<p>Without any options set, it loads a .csv file which has the same name\nand path like the test suite .robot .</p>\n<p><strong>Example:</strong></p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">\n</span><span class=\"kn\">Test Template</span><span class=\"p\">    </span><span class=\"nf\">Invalid Logins</span><span class=\"p\">\n\n</span><span class=\"gh\">*** Keywords ***</span><span class=\"p\">\n</span><span class=\"gu\">Invalid Logins</span><span class=\"p\">\n    ...</span>\n</pre>\n</div>\n<div class=\"section\" id=\"structure-of-test-suite\">\n<h1>Structure of Test Suite</h1>\n<div class=\"section\" id=\"requirements\">\n<h2 id=\"Requirements\">Requirements</h2>\n<p>In the Moment there are some requirements how a test\nsuite must be structured so that the DataDriver can get all the\ninformation it needs.</p>\n<blockquote>\n<ul class=\"simple\">\n<li>only the first test case will be used as a template. All other test\ncases will be deleted.</li>\n<li>Test cases have to be defined with a\n<tt class=\"docutils literal\">Test Template</tt> in Settings secion. Reason for this is,\nthat the DataDriver needs to know the names of the test case arguments.\nTest cases do not have named arguments. Keywords do.</li>\n<li>The keyword which is used as\n<tt class=\"docutils literal\">Test Template</tt> must be defined within the test suite (in the same\n*.robot file). If the keyword which is used as <tt class=\"docutils literal\">Test Template</tt> is\ndefined in a <tt class=\"docutils literal\">Resource</tt> the DataDriver has no access to its\narguments names.</li>\n</ul>\n</blockquote>\n</div>\n<div class=\"section\" id=\"example-test-suite\">\n<h2 id=\"Example Test Suite\">Example Test Suite</h2>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">***Settings***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">           </span><span class=\"nn\">DataDriver</span><span class=\"p\">\n</span><span class=\"kn\">Resource</span><span class=\"p\">          </span><span class=\"nn\">login_resources.robot</span><span class=\"p\">\n</span><span class=\"kn\">Suite Setup</span><span class=\"p\">       </span><span class=\"nf\">Open my Browser</span><span class=\"p\">\n</span><span class=\"kn\">Suite Teardown</span><span class=\"p\">    </span><span class=\"nf\">Close Browsers</span><span class=\"p\">\n</span><span class=\"kn\">Test Setup</span><span class=\"p\">        </span><span class=\"nf\">Open Login Page</span><span class=\"p\">\n</span><span class=\"kn\">Test Template</span><span class=\"p\">     </span><span class=\"nf\">Invalid Login</span><span class=\"p\">\n\n</span><span class=\"gh\">*** Test Case ***</span><span class=\"p\">\n</span><span class=\"gu\">Login with user </span><span class=\"p\">${</span><span class=\"nv\">username</span><span class=\"p\">}</span><span class=\"gu\"> and password </span><span class=\"p\">${</span><span class=\"nv\">password</span><span class=\"p\">}    </span><span class=\"s\">Default</span><span class=\"p\">    </span><span class=\"s\">UserData</span><span class=\"p\">\n\n</span><span class=\"gh\">***** *Keywords* *****</span><span class=\"p\">\n</span><span class=\"gu\">Invalid login</span><span class=\"p\">\n    [</span><span class=\"kn\">Arguments</span><span class=\"p\">]    ${</span><span class=\"nv\">username</span><span class=\"p\">}    ${</span><span class=\"nv\">password</span><span class=\"p\">}\n    </span><span class=\"nf\">Input username</span><span class=\"p\">    ${</span><span class=\"nv\">username</span><span class=\"p\">}\n    </span><span class=\"nf\">Input pwd</span><span class=\"p\">    ${</span><span class=\"nv\">password</span><span class=\"p\">}\n    </span><span class=\"nf\">click login button</span><span class=\"p\">\n    </span><span class=\"nf\">Error page should be visible</span>\n</pre>\n<p>In this example, the DataDriver is activated by using it as a Library.\nIt is used with default settings.\nAs <tt class=\"docutils literal\">Test Template</tt> the keyword <tt class=\"docutils literal\">Invalid Login</tt> is used. This\nkeyword has two arguments. Argument names are <tt class=\"docutils literal\">${username}</tt> and\n<tt class=\"docutils literal\">${password}</tt>. These names have to be in the CSV file as column\nheader. The test case has two variable names included in its name,\nwhich does not have any functionality in Robot Framework\u00ae. However, the\nData Driver will use the test case name as a template name and\nreplaces the variables with the specific value of the single generated\ntest case.\nThis template test will only be used as a template. The specified data\n<tt class=\"docutils literal\">Default</tt> and <tt class=\"docutils literal\">UserData</tt> would only be used if no CSV file has\nbeen found.</p>\n</div>\n</div>\n<div class=\"section\" id=\"structure-of-data-file\">\n<h1>Structure of data file</h1>\n<div class=\"section\" id=\"min-required-columns\">\n<h2 id=\"min. required columns\">min. required columns</h2>\n<ul class=\"simple\">\n<li><tt class=\"docutils literal\">*** Test Cases ***</tt> column has to be the first one.</li>\n<li><em>Argument columns:</em> For each argument of the <tt class=\"docutils literal\">Test Template</tt>\nkeyword one column must be existing in the data file as data source.\nThe name of this column must match the variable name and syntax.</li>\n</ul>\n</div>\n<div class=\"section\" id=\"optional-columns\">\n<h2 id=\"optional columns\">optional columns</h2>\n<ul class=\"simple\">\n<li><em>[Tags]</em> column may be used to add specific tags to a test case. Tags\nmay be comma separated.</li>\n<li><em>[Documentation]</em> column may be used to add specific test case\ndocumentation.</li>\n</ul>\n</div>\n<div class=\"section\" id=\"example-data-file\">\n<h2 id=\"Example Data file\">Example Data file</h2>\n<table border=\"1\" class=\"docutils\">\n<colgroup>\n<col width=\"19%\" />\n<col width=\"19%\" />\n<col width=\"19%\" />\n<col width=\"19%\" />\n<col width=\"26%\" />\n</colgroup>\n<thead valign=\"bottom\">\n<tr><th class=\"head\">*** Test\nCases ***</th>\n<th class=\"head\">${username}</th>\n<th class=\"head\">${password}</th>\n<th class=\"head\">[Tags]</th>\n<th class=\"head\">[Documentation]</th>\n</tr>\n</thead>\n<tbody valign=\"top\">\n<tr><td>Right user\nempty pass</td>\n<td>demo</td>\n<td>${EMPTY}</td>\n<td>1</td>\n<td>This is a test\ncase\ndocumentation of\nthe first one.</td>\n</tr>\n<tr><td>Right user\nwrong pass</td>\n<td>demo</td>\n<td>FooBar</td>\n<td>2,3,foo</td>\n<td>This test\ncase has\nthe Tags\n2,3 and foo\nassigned.</td>\n</tr>\n<tr><td>&nbsp;</td>\n<td>${EMPTY}</td>\n<td>mode</td>\n<td>1,2,3,4</td>\n<td>This test\ncase has a\ngenerated\nname based\non template\nname.</td>\n</tr>\n<tr><td>&nbsp;</td>\n<td>${EMPTY}</td>\n<td>${EMPTY}</td>\n<td>&nbsp;</td>\n<td>&nbsp;</td>\n</tr>\n<tr><td>&nbsp;</td>\n<td>${EMPTY}</td>\n<td>FooBar</td>\n<td>&nbsp;</td>\n<td>&nbsp;</td>\n</tr>\n<tr><td>&nbsp;</td>\n<td>FooBar</td>\n<td>mode</td>\n<td>&nbsp;</td>\n<td>&nbsp;</td>\n</tr>\n<tr><td>&nbsp;</td>\n<td>FooBar</td>\n<td>${EMPTY}</td>\n<td>&nbsp;</td>\n<td>&nbsp;</td>\n</tr>\n<tr><td>&nbsp;</td>\n<td>FooBar</td>\n<td>FooBar</td>\n<td>&nbsp;</td>\n<td>&nbsp;</td>\n</tr>\n</tbody>\n</table>\n<p>In this data file, eight test cases are defined. Each line specifies one\ntest case. The first two test cases have specific names. The other six\ntest cases will generate names based on template test cases name with\nthe replacement of variables in this name. The order of columns is\nirrelevant except the first column, <tt class=\"docutils literal\">*** Test Cases ***</tt></p>\n</div>\n<div class=\"section\" id=\"supported-data-types\">\n<h2 id=\"Supported Data Types\">Supported Data Types</h2>\n<p>In general DataDriver supports any Object that is handed over from the DataReader.\nHowever the text based readers for csv, excel and so do support different types as well.\nDataDriver supports Robot Framework\u00ae Scalar variables as well as Dictionaries and Lists.\nIt also support python literal evaluations.</p>\n<div class=\"section\" id=\"scalar-variables\">\n<h3 id=\"Scalar Variables\">Scalar Variables</h3>\n<p>The Prefix <tt class=\"docutils literal\">$</tt> defines that the value in the cell is taken as in Robot Framework\u00ae Syntax.\n<tt class=\"docutils literal\">String</tt> is <tt class=\"docutils literal\">str</tt>, <tt class=\"docutils literal\">${1}</tt> is <tt class=\"docutils literal\">int</tt> and <tt class=\"docutils literal\">${None}</tt> is NoneType.\nThe Prefix only defines the value typ. It can also be used to assign a scalar to a dictionary key.\nSee example table: <tt class=\"docutils literal\"><span class=\"pre\">${user}[id]</span></tt></p>\n</div>\n<div class=\"section\" id=\"dictionary-variables\">\n<h3 id=\"Dictionary Variables\">Dictionary Variables</h3>\n<p>Dictionaries can be created in different ways.</p>\n<p>One option is, to use the prefix <tt class=\"docutils literal\">&amp;</tt>.\nIf a variable is defined that was (i.e. <tt class=\"docutils literal\">&amp;{dict}</tt>) the cell value is interpreted the same way,\nthe BuiltIn keyword <a class=\"reference external\" href=\"https://robotframework.org/robotframework/latest/libraries/BuiltIn.html#Create%20Dictionary\">Create Dictionary</a> would do.\nThe arguments here are comma (<tt class=\"docutils literal\">,</tt>) separated.\nSee example table: <tt class=\"docutils literal\">&amp;{dict}</tt></p>\n<p>The other option is to define scalar variables in dictionary syntax like <tt class=\"docutils literal\"><span class=\"pre\">${user}[name]</span></tt> or <tt class=\"docutils literal\">${user.name}</tt>\nThat can be also nested dictionaries. DataDriver will create Robot Framework\u00ae (DotDict) Dictionaries, that can be accessed with <tt class=\"docutils literal\">${user.name.first}</tt>\nSee example table: <tt class=\"docutils literal\"><span class=\"pre\">${user}[name][first]</span></tt></p>\n</div>\n<div class=\"section\" id=\"list-variables\">\n<h3 id=\"List Variables\">List Variables</h3>\n<p>Lists can be created with the prefix <tt class=\"docutils literal\">&#64;</tt> as comma (<tt class=\"docutils literal\">,</tt>) separated list.\nSee example table: <tt class=\"docutils literal\">&#64;{list}</tt></p>\n<p>Be aware that a list with an empty string has to be the cell content <cite>${Empty}</cite>.</p>\n</div>\n<div class=\"section\" id=\"python-literals\">\n<h3 id=\"Python Literals\">Python Literals</h3>\n<p>DataDriver can evaluate Literals.\nIt uses the prefix <tt class=\"docutils literal\">e</tt> for that. (i.e. <tt class=\"docutils literal\">e{list_eval}</tt>)\nFor that it uses <a class=\"reference external\" href=\"https://robotframework.org/robotframework/latest/libraries/BuiltIn.html#Evaluate\">BuiltIn Evaluate</a></p>\n<p>See example table: <tt class=\"docutils literal\">e{user.chk}</tt></p>\n<table border=\"1\" class=\"docutils\">\n<colgroup>\n<col width=\"8%\" />\n<col width=\"7%\" />\n<col width=\"4%\" />\n<col width=\"7%\" />\n<col width=\"8%\" />\n<col width=\"12%\" />\n<col width=\"8%\" />\n<col width=\"6%\" />\n<col width=\"6%\" />\n<col width=\"8%\" />\n<col width=\"7%\" />\n<col width=\"19%\" />\n</colgroup>\n<tbody valign=\"top\">\n<tr><td><tt class=\"docutils literal\">*** Test Cases ***</tt></td>\n<td><tt class=\"docutils literal\">${scalar}</tt></td>\n<td><tt class=\"docutils literal\">&#64;{list}</tt></td>\n<td><tt class=\"docutils literal\">e{list_eval}</tt></td>\n<td><tt class=\"docutils literal\">&amp;{dict}</tt></td>\n<td><tt class=\"docutils literal\">e{dict_eval}</tt></td>\n<td><tt class=\"docutils literal\">e{eval}</tt></td>\n<td><tt class=\"docutils literal\">${exp_eval}</tt></td>\n<td><tt class=\"docutils literal\"><span class=\"pre\">${user}[id]</span></tt></td>\n<td><tt class=\"docutils literal\"><span class=\"pre\">${user}[name][first]</span></tt></td>\n<td><tt class=\"docutils literal\">${user.name.last}</tt></td>\n<td><tt class=\"docutils literal\">e{user.chk}</tt></td>\n</tr>\n<tr><td><tt class=\"docutils literal\">One</tt></td>\n<td><tt class=\"docutils literal\">Sum List</tt></td>\n<td><tt class=\"docutils literal\">1,2,3,4</tt></td>\n<td><tt class=\"docutils literal\"><span class=\"pre\">[&quot;1&quot;,&quot;2&quot;,&quot;3&quot;,&quot;4&quot;]</span></tt></td>\n<td><tt class=\"docutils literal\">key=value</tt></td>\n<td><tt class=\"docutils literal\">{'key': 'value'}</tt></td>\n<td><tt class=\"docutils literal\">[1,2,3,4]</tt></td>\n<td><tt class=\"docutils literal\">10</tt></td>\n<td><tt class=\"docutils literal\">1</tt></td>\n<td><tt class=\"docutils literal\">Pekka</tt></td>\n<td><tt class=\"docutils literal\">Kl\u00e4rck</tt></td>\n<td><tt class=\"docutils literal\">{'id': '1', 'name': {'first': 'Pekka', 'last': <span class=\"pre\">'Kl\u00e4rck'}}</span></tt></td>\n</tr>\n<tr><td><tt class=\"docutils literal\">Two</tt></td>\n<td><tt class=\"docutils literal\">Should be Equal</tt></td>\n<td><tt class=\"docutils literal\">a,b,c,d</tt></td>\n<td><tt class=\"docutils literal\"><span class=\"pre\">[&quot;a&quot;,&quot;b&quot;,&quot;c&quot;,&quot;d&quot;]</span></tt></td>\n<td><tt class=\"docutils literal\">key,value</tt></td>\n<td><tt class=\"docutils literal\">{'key': 'value'}</tt></td>\n<td><tt class=\"docutils literal\">True</tt></td>\n<td><tt class=\"docutils literal\">${true}</tt></td>\n<td><tt class=\"docutils literal\">2</tt></td>\n<td><tt class=\"docutils literal\">Ed</tt></td>\n<td><tt class=\"docutils literal\">Manlove</tt></td>\n<td><tt class=\"docutils literal\">{'id': '2', 'name': {'first': 'Ed', 'last': <span class=\"pre\">'Manlove'}}</span></tt></td>\n</tr>\n<tr><td><tt class=\"docutils literal\">Three</tt></td>\n<td><tt class=\"docutils literal\">Whos your Daddy</tt></td>\n<td><tt class=\"docutils literal\"><span class=\"pre\">!,&quot;,',$</span></tt></td>\n<td><tt class=\"docutils literal\"><span class=\"pre\">[&quot;!&quot;,'&quot;',&quot;'&quot;,&quot;$&quot;]</span></tt></td>\n<td><tt class=\"docutils literal\">z,value,a,value2</tt></td>\n<td><tt class=\"docutils literal\">{'a': 'value2', 'z': 'value'}</tt></td>\n<td><tt class=\"docutils literal\">{'Daddy' : 'Ren\u00e9'}</tt></td>\n<td><tt class=\"docutils literal\">Ren\u00e9</tt></td>\n<td><tt class=\"docutils literal\">3</tt></td>\n<td><tt class=\"docutils literal\">Tatu</tt></td>\n<td><tt class=\"docutils literal\">Aalto</tt></td>\n<td><tt class=\"docutils literal\">{'id': '3', 'name': {'first': 'Tatu', 'last': <span class=\"pre\">'Aalto'}}</span></tt></td>\n</tr>\n<tr><td><tt class=\"docutils literal\">4</tt></td>\n<td><tt class=\"docutils literal\">Should be Equal</tt></td>\n<td><tt class=\"docutils literal\">1</tt></td>\n<td><tt class=\"docutils literal\">[&quot;1&quot;]</tt></td>\n<td><tt class=\"docutils literal\">key=value</tt></td>\n<td><tt class=\"docutils literal\">{'key': 'value'}</tt></td>\n<td><tt class=\"docutils literal\">1</tt></td>\n<td><tt class=\"docutils literal\">${1}</tt></td>\n<td><tt class=\"docutils literal\">4</tt></td>\n<td><tt class=\"docutils literal\">Jani</tt></td>\n<td><tt class=\"docutils literal\">Mikkonen</tt></td>\n<td><tt class=\"docutils literal\">{'id': '4', 'name': {'first': 'Jani', 'last': <span class=\"pre\">'Mikkonen'}}</span></tt></td>\n</tr>\n<tr><td><tt class=\"docutils literal\">5</tt></td>\n<td><tt class=\"docutils literal\">Should be Equal</tt></td>\n<td>&nbsp;</td>\n<td><tt class=\"docutils literal\">[]</tt></td>\n<td><tt class=\"docutils literal\"><span class=\"pre\">a=${2}</span></tt></td>\n<td><tt class=\"docutils literal\"><span class=\"pre\">{'a':2}</span></tt></td>\n<td><tt class=\"docutils literal\">&quot;string&quot;</tt></td>\n<td><tt class=\"docutils literal\">string</tt></td>\n<td><tt class=\"docutils literal\">5</tt></td>\n<td><tt class=\"docutils literal\">Mikko</tt></td>\n<td><tt class=\"docutils literal\">Korpela</tt></td>\n<td><tt class=\"docutils literal\">{'id': '5', 'name': {'first': 'Mikko', 'last': <span class=\"pre\">'Korpela'}}</span></tt></td>\n</tr>\n<tr><td><tt class=\"docutils literal\">6</tt></td>\n<td><tt class=\"docutils literal\">Should be Equal</tt></td>\n<td><tt class=\"docutils literal\">[1,2]</tt></td>\n<td><tt class=\"docutils literal\"><span class=\"pre\">[&quot;[1&quot;,&quot;2]&quot;]</span></tt></td>\n<td><tt class=\"docutils literal\">key=value,key2=value2</tt></td>\n<td><tt class=\"docutils literal\">{'key': 'value', 'key2': 'value2'}</tt></td>\n<td><tt class=\"docutils literal\">None</tt></td>\n<td><tt class=\"docutils literal\">${none}</tt></td>\n<td><tt class=\"docutils literal\">6</tt></td>\n<td><tt class=\"docutils literal\">Ismo</tt></td>\n<td><tt class=\"docutils literal\">Aro</tt></td>\n<td><tt class=\"docutils literal\">{'id': '6', 'name': {'first': 'Ismo', 'last': <span class=\"pre\">'Aro'}}</span></tt></td>\n</tr>\n</tbody>\n</table>\n</div>\n</div>\n</div>\n<div class=\"section\" id=\"accessing-test-data-from-robot-variables\">\n<h1>Accessing Test Data From Robot Variables</h1>\n<p>If neccesary it is possible to access the fetched data tables directly from a Robot Framework\u00ae variable.\nThis could be helpfull in Test Setup or in Suite Setup.</p>\n<p>There are three variables available within the Data-Driven Suite:</p>\n<div class=\"section\" id=\"datadriver-data-list\">\n<h2 id=\"&#64;{DataDriver_DATA_LIST}\">&#64;{DataDriver_DATA_LIST}</h2>\n<p>A list as suite variable containing a robot dictionary for each test case that is selected for execution.</p>\n<pre class=\"code json literal-block\">\n<span class=\"p\">[</span><span class=\"w\">\n  </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Right user empty pass&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;demo&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;1&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;This is a test case documentation of the first one.&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Right user wrong pass&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;demo&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;2&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;3&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;foo&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;This test case has the Tags 2,3 and foo&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user '${EMPTY}' and password 'mode'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;mode&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;1&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;2&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;3&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;4&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;This test case has a generated name based on template name.&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user '${EMPTY}' and password '${EMPTY}'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user '${EMPTY}' and password 'FooBar'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user 'FooBar' and password 'mode'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;mode&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;foo&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;1&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user 'FooBar' and password '${EMPTY}'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;foo&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user 'FooBar' and password 'FooBar'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;foo&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;2&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">}</span><span class=\"w\">\n</span><span class=\"p\">]</span>\n</pre>\n<p>This can be accessed as usual in Robot Framework\u00ae.</p>\n<p><tt class=\"docutils literal\"><span class=\"pre\">${DataDriver_DATA_LIST}[2][arguments][\\${password}]</span></tt> would result in <tt class=\"docutils literal\">mode</tt> .</p>\n</div>\n<div class=\"section\" id=\"datadriver-data-dict\">\n<h2 id=\"&amp;{DataDriver_DATA_DICT}\">&amp;{DataDriver_DATA_DICT}</h2>\n<p>A dictionary as suite variable that contains the same data as the list, with the test names as keys.</p>\n<pre class=\"code json literal-block\">\n<span class=\"p\">{</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;Right user empty pass&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Right user empty pass&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;demo&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;1&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;This is a test case documentation of the first one.&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;Right user wrong pass&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Right user wrong pass&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;demo&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;2&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;3&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;foo&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;This test case has the Tags 2,3 and foo&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;Login with user '${EMPTY}' and password 'mode'&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user '${EMPTY}' and password 'mode'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;mode&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;1&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;2&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;3&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;4&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;This test case has a generated name based on template name.&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;Login with user '${EMPTY}' and password '${EMPTY}'&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user '${EMPTY}' and password '${EMPTY}'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;Login with user '${EMPTY}' and password 'FooBar'&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user '${EMPTY}' and password 'FooBar'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;Login with user 'FooBar' and password 'mode'&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user 'FooBar' and password 'mode'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;mode&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;foo&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;1&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;Login with user 'FooBar' and password '${EMPTY}'&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user 'FooBar' and password '${EMPTY}'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;${EMPTY}&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;foo&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;Login with user 'FooBar' and password 'FooBar'&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Login with user 'FooBar' and password 'FooBar'&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"w\">\n    </span><span class=\"p\">},</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;foo&quot;</span><span class=\"p\">,</span><span class=\"w\">\n      </span><span class=\"s2\">&quot;2&quot;</span><span class=\"w\">\n    </span><span class=\"p\">],</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;&quot;</span><span class=\"w\">\n  </span><span class=\"p\">}</span><span class=\"w\">\n</span><span class=\"p\">}</span>\n</pre>\n</div>\n<div class=\"section\" id=\"datadriver-test-data\">\n<h2 id=\"&amp;{DataDriver_TEST_DATA}\">&amp;{DataDriver_TEST_DATA}</h2>\n<p>A dictionary as test variable that contains the test data of the current test case.\nThis dictionary does also contain arguments that are not used in the <tt class=\"docutils literal\">Test Template</tt> keyword.\nThis can be used in Test Setup and within a test case.</p>\n<pre class=\"code json literal-block\">\n<span class=\"p\">{</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;test_case_name&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;Right user wrong pass&quot;</span><span class=\"p\">,</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;arguments&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">{</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;${username}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;demo&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"nt\">&quot;${password}&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;FooBar&quot;</span><span class=\"w\">\n  </span><span class=\"p\">},</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;tags&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"p\">[</span><span class=\"w\">\n    </span><span class=\"s2\">&quot;2&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"s2\">&quot;3&quot;</span><span class=\"p\">,</span><span class=\"w\">\n    </span><span class=\"s2\">&quot;foo&quot;</span><span class=\"w\">\n  </span><span class=\"p\">],</span><span class=\"w\">\n  </span><span class=\"nt\">&quot;documentation&quot;</span><span class=\"p\">:</span><span class=\"w\"> </span><span class=\"s2\">&quot;This test case has the Tags 2,3 and foo&quot;</span><span class=\"w\">\n</span><span class=\"p\">}</span>\n</pre>\n</div>\n</div>\n<div class=\"section\" id=\"data-sources\">\n<h1>Data Sources</h1>\n<div class=\"section\" id=\"csv-tsv-character-separated-values\">\n<h2 id=\"CSV / TSV (Character-separated values)\">CSV / TSV (Character-separated values)</h2>\n<p>By default DataDriver reads csv files. With the <a class=\"reference external\" href=\"#file-encoding-and-csv-dialect\">Encoding and CSV\nDialect</a> settings you may configure which\nstructure your data source has.</p>\n</div>\n<div class=\"section\" id=\"xls-xlsx-files\">\n<h2 id=\"XLS / XLSX Files\">XLS / XLSX Files</h2>\n<p>To use Excel file types, you have to install DataDriver with the Extra XLS.</p>\n<p>If you want to use Excel based data sources, you may just set the file\nto the extention or you may point to the correct file. If the extention\nis &quot;.xls&quot; or &quot;.xlsx&quot; DataDriver will interpret it as Excel file.\nYou may select the sheet which will be read by the option <tt class=\"docutils literal\">sheet_name</tt>.\nBy default it is set to 0 which will be the first table sheet.\nYou may use sheet index (0 is first sheet) or sheet name(case sensitive).\nXLS interpreter will ignore all other options like encoding, delimiters etc.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">.xlsx</span>\n</pre>\n<p>or:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">file=my_data_source.xlsx</span><span class=\"p\">    </span><span class=\"s\">sheet_name=2nd Sheet</span>\n</pre>\n<div class=\"section\" id=\"ms-excel-and-typed-cells\">\n<h3 id=\"MS Excel and typed cells\">MS Excel and typed cells</h3>\n<p>Microsoft Excel xls or xlsx file have the possibility to type thair data\ncells. Numbers are typically of the type float. If these data are not\nexplicitly defined as text in Excel, pandas will read it as the type\nthat is has in excel. Because we have to work with strings in Robot\nFramework\u00ae these data are converted to string. This leads to the\nsituation that a European time value like &quot;04.02.2019&quot; (4th January\n2019) is handed over to Robot Framework\u00ae in Iso time &quot;2019-01-04\n00:00:00&quot;. This may cause unwanted behavior. To mitigate this risk you\nshould define Excel based files explicitly as text within Excel.</p>\n<p>Alternatively you may deactivate that string conversion.\nTo do so, you have to add the option <tt class=\"docutils literal\">preserve_xls_types</tt> to <tt class=\"docutils literal\">True</tt>.\nIn that case, you will get str, float, boolean, int, datetime.time,\ndatetime.datetime and some others.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">file=my_data_source.xlsx</span><span class=\"p\">    </span><span class=\"s\">preserve_xls_types=True</span>\n</pre>\n</div>\n</div>\n<div class=\"section\" id=\"pict-pairwise-independent-combinatorial-testing\">\n<h2 id=\"PICT (Pairwise Independent Combinatorial Testing)\">PICT (Pairwise Independent Combinatorial Testing)</h2>\n<p>Pict is able to generate data files based on a model file.\n<a class=\"reference external\" href=\"https://github.com/Microsoft/pict\">https://github.com/Microsoft/pict</a></p>\n<p>Documentation: <a class=\"reference external\" href=\"https://github.com/Microsoft/pict/blob/master/doc/pict.md\">https://github.com/Microsoft/pict/blob/master/doc/pict.md</a></p>\n<div class=\"section\" id=\"requirements-of-pict\">\n<h3 id=\"Requirements of PICT\">Requirements of PICT</h3>\n<ul class=\"simple\">\n<li>Path to pict.exe must be set in the %PATH% environment variable.</li>\n<li>Data model file has the file extention &quot;.pict&quot;</li>\n<li>Pict model file must be encoded in UTF-8</li>\n</ul>\n</div>\n<div class=\"section\" id=\"how-it-works\">\n<h3 id=\"How it works\">How it works</h3>\n<p>If the file option is set to a file with the extention pict, DataDriver\nwill hand over this file to pict.exe and let it automatically generates\na file with the extention &quot;.pictout&quot;. This file will the be used as data\nsource for the test generation. (It is tab seperated and UTF-8 encoded)\nExcept the file option all other options of the library will be ignored.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">my_model_file.pict</span>\n</pre>\n<p>It is possible to give options to pict with the import argument <cite>pict_options=</cite>.</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">pict_arg.pict</span><span class=\"p\">    </span><span class=\"s\">pict_options=/o:3 /r</span>\n</pre>\n</div>\n</div>\n<div class=\"section\" id=\"glob-file-pattern\">\n<h2 id=\"Glob File Pattern\">Glob File Pattern</h2>\n<p>This module implements a reader class that creates a test case for each file or folder that matches the given glob pattern.</p>\n<p>With an optional argument &quot;arg_name&quot; you can modify the argument that will be set. See folder example.</p>\n<p>Example with json files:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">           </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">file=</span><span class=\"p\">${</span><span class=\"nv\">CURDIR</span><span class=\"p\">}</span><span class=\"s\">/DataFiles/*_File.json</span><span class=\"p\">    </span><span class=\"s\">reader_class=glob_reader</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">           </span><span class=\"nn\">OperatingSystem</span><span class=\"p\">\n</span><span class=\"kn\">Test Template</span><span class=\"p\">     </span><span class=\"nf\">Test all Files</span><span class=\"p\">\n\n\n</span><span class=\"gh\">*** Test Cases ***</span><span class=\"p\">\n</span><span class=\"gu\">Glob_Reader_Test</span><span class=\"p\">    </span><span class=\"s\">Wrong_File.NoJson</span><span class=\"p\">\n\n\n</span><span class=\"gh\">*** Keywords ***</span><span class=\"p\">\n</span><span class=\"gu\">Test all Files</span><span class=\"p\">\n    [</span><span class=\"kn\">Arguments</span><span class=\"p\">]    ${</span><span class=\"nv\">file_name</span><span class=\"p\">}\n    ${</span><span class=\"nv\">file_content</span><span class=\"p\">}=    </span><span class=\"nf\">Get File</span><span class=\"p\">    ${</span><span class=\"nv\">file_name</span><span class=\"p\">}\n    ${</span><span class=\"nv\">content</span><span class=\"p\">}=    </span><span class=\"nf\">Evaluate</span><span class=\"p\">    </span><span class=\"s\">json.loads($file_content)[&quot;test_case&quot;]</span><span class=\"p\">\n    </span><span class=\"nf\">Should Be Equal</span><span class=\"p\">    ${</span><span class=\"nv\">TEST_NAME</span><span class=\"p\">}    ${</span><span class=\"nv\">content</span><span class=\"p\">}</span>\n</pre>\n<p>Example with folders:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">           </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">file=</span><span class=\"p\">${</span><span class=\"nv\">CURDIR</span><span class=\"p\">}</span><span class=\"s\">/FoldersToFind/*/</span><span class=\"p\">    </span><span class=\"s\">reader_class=glob_reader</span><span class=\"p\">    </span><span class=\"s\">arg_name=\\${folder_name}</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">           </span><span class=\"nn\">OperatingSystem</span><span class=\"p\">\n</span><span class=\"kn\">Test Template</span><span class=\"p\">     </span><span class=\"nf\">Test all Files</span><span class=\"p\">\n\n\n</span><span class=\"gh\">*** Test Cases ***</span><span class=\"p\">\n</span><span class=\"gu\">Glob_Reader_Test</span><span class=\"p\">    </span><span class=\"s\">Wrong_File.NoJson</span><span class=\"p\">\n\n\n</span><span class=\"gh\">*** Keywords ***</span><span class=\"p\">\n</span><span class=\"gu\">Test all Files</span><span class=\"p\">\n    [</span><span class=\"kn\">Arguments</span><span class=\"p\">]    ${</span><span class=\"nv\">folder_name</span><span class=\"p\">}\n    ${</span><span class=\"nv\">content</span><span class=\"p\">}=    </span><span class=\"nf\">Get File</span><span class=\"p\">    ${</span><span class=\"nv\">folder_name</span><span class=\"p\">}</span><span class=\"s\">/verify.txt</span><span class=\"p\">\n    </span><span class=\"nf\">Should Be Equal</span><span class=\"p\">    ${</span><span class=\"nv\">TEST_NAME</span><span class=\"p\">}    ${</span><span class=\"nv\">content</span><span class=\"p\">}</span>\n</pre>\n</div>\n</div>\n<div class=\"section\" id=\"file-encoding-and-csv-dialect\">\n<h1>File Encoding and CSV Dialect</h1>\n<p>While there are various specifications and implementations for the CSV format\n(see <a class=\"reference external\" href=\"https://www.rfc-editor.org/rfc/rfc4180.html\">RFC 4180</a>),\nthere is no formal specification in existence, which allows for a wide variety of interpretations of CSV files.\nTherefore it is possible to define your own dialect or use\npredefined. The default is Excel-EU which is a semicolon separated\nfile.\nThese Settings are changeable as options of the Data Driver Library.</p>\n<div class=\"section\" id=\"file\">\n<h2 id=\"file=\">file=</h2>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">         </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">file=../data/my_data_source.csv</span>\n</pre>\n<ul class=\"simple\">\n<li>None(default): Data Driver will search in the test suites folder if a\n*.csv file with the same name than the test suite *.robot file exists</li>\n<li>only file extention: if you just set a file extentions like &quot;.xls&quot; or\n&quot;.xlsx&quot; DataDriver will search</li>\n<li>absolute path: If an absolute path to a file is set, DataDriver tries\nto find and open the given data file.</li>\n<li>relative path: If the option does not point to a data file as an\nabsolute path, Data Driver tries to find a data file relative to the\nfolder where the test suite is located.</li>\n</ul>\n</div>\n<div class=\"section\" id=\"encoding\">\n<h2 id=\"encoding=\">encoding=</h2>\n<p><tt class=\"docutils literal\">encoding=</tt> must be set if it shall not be cp1252.</p>\n<p><strong>Examples</strong>:</p>\n<p><tt class=\"docutils literal\">cp1252, ascii, <span class=\"pre\">iso-8859-1,</span> <span class=\"pre\">latin-1,</span> utf_8, utf_16, utf_16_be, utf_16_le</tt></p>\n<p><strong>cp1252</strong> is:</p>\n<ul class=\"simple\">\n<li>Code Page 1252</li>\n<li>Windows-1252</li>\n<li>Windows Western European</li>\n</ul>\n<p>Most characters are same between ISO-8859-1 (Latin-1) except for the code points 128-159 (0x80-0x9F).\nThese Characters are available in cp1252 which are not present in Latin-1.</p>\n<p><tt class=\"docutils literal\">\u20ac \u201a \u0192 \u201e \u2026 \u2020 \u2021 \u02c6 \u2030 \u0160 \u2039 \u0152 \u017d \u2018 \u2019 \u201c \u201d \u2022 \u2013 \u2014 \u02dc \u2122 \u0161 \u203a \u0153 \u017e \u0178</tt></p>\n<p>See <a class=\"reference external\" href=\"https://docs.python.org/3/library/codecs.html#standard-encodings\">Python Standard Encoding</a> for more encodings</p>\n</div>\n<div class=\"section\" id=\"dialect\">\n<h2 id=\"dialect=\">dialect=</h2>\n<p>You may change the CSV Dialect here.\nThe dialect option can be one of the following:\n- Excel-EU\n- excel\n- excel-tab\n- unix\n- UserDefined</p>\n<p>supported Dialects are:</p>\n<pre class=\"code python literal-block\">\n<span class=\"s2\">&quot;Excel-EU&quot;</span>\n    <span class=\"n\">delimiter</span><span class=\"o\">=</span><span class=\"s1\">';'</span><span class=\"p\">,</span>\n    <span class=\"n\">quotechar</span><span class=\"o\">=</span><span class=\"s1\">'&quot;'</span><span class=\"p\">,</span>\n    <span class=\"n\">escapechar</span><span class=\"o\">=</span><span class=\"s1\">'</span><span class=\"se\">\\'</span><span class=\"s1\">,</span>\n    <span class=\"n\">doublequote</span><span class=\"o\">=</span><span class=\"kc\">True</span><span class=\"p\">,</span>\n    <span class=\"n\">skipinitialspace</span><span class=\"o\">=</span><span class=\"kc\">False</span><span class=\"p\">,</span>\n    <span class=\"n\">lineterminator</span><span class=\"o\">=</span><span class=\"s2\">&quot;</span><span class=\"se\">\\r\\n</span><span class=\"s2\">&quot;</span><span class=\"p\">,</span>\n    <span class=\"n\">quoting</span><span class=\"o\">=</span><span class=\"n\">csv</span><span class=\"o\">.</span><span class=\"n\">QUOTE_ALL</span>\n\n<span class=\"s2\">&quot;excel&quot;</span>\n    <span class=\"n\">delimiter</span> <span class=\"o\">=</span> <span class=\"s1\">','</span>\n    <span class=\"n\">quotechar</span> <span class=\"o\">=</span> <span class=\"s1\">'&quot;'</span>\n    <span class=\"n\">doublequote</span> <span class=\"o\">=</span> <span class=\"kc\">True</span>\n    <span class=\"n\">skipinitialspace</span> <span class=\"o\">=</span> <span class=\"kc\">False</span>\n    <span class=\"n\">lineterminator</span> <span class=\"o\">=</span> <span class=\"s1\">'</span><span class=\"se\">\\r\\n</span><span class=\"s1\">'</span>\n    <span class=\"n\">quoting</span> <span class=\"o\">=</span> <span class=\"n\">QUOTE_MINIMAL</span>\n\n<span class=\"s2\">&quot;excel-tab&quot;</span>\n    <span class=\"n\">delimiter</span> <span class=\"o\">=</span> <span class=\"s1\">'</span><span class=\"se\">\\t</span><span class=\"s1\">'</span>\n    <span class=\"n\">quotechar</span> <span class=\"o\">=</span> <span class=\"s1\">'&quot;'</span>\n    <span class=\"n\">doublequote</span> <span class=\"o\">=</span> <span class=\"kc\">True</span>\n    <span class=\"n\">skipinitialspace</span> <span class=\"o\">=</span> <span class=\"kc\">False</span>\n    <span class=\"n\">lineterminator</span> <span class=\"o\">=</span> <span class=\"s1\">'</span><span class=\"se\">\\r\\n</span><span class=\"s1\">'</span>\n    <span class=\"n\">quoting</span> <span class=\"o\">=</span> <span class=\"n\">QUOTE_MINIMAL</span>\n\n<span class=\"s2\">&quot;unix&quot;</span>\n    <span class=\"n\">delimiter</span> <span class=\"o\">=</span> <span class=\"s1\">','</span>\n    <span class=\"n\">quotechar</span> <span class=\"o\">=</span> <span class=\"s1\">'&quot;'</span>\n    <span class=\"n\">doublequote</span> <span class=\"o\">=</span> <span class=\"kc\">True</span>\n    <span class=\"n\">skipinitialspace</span> <span class=\"o\">=</span> <span class=\"kc\">False</span>\n    <span class=\"n\">lineterminator</span> <span class=\"o\">=</span> <span class=\"s1\">'</span><span class=\"se\">\\n</span><span class=\"s1\">'</span>\n    <span class=\"n\">quoting</span> <span class=\"o\">=</span> <span class=\"n\">QUOTE_ALL</span>\n</pre>\n<p>Usage in Robot Framework\u00ae</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">my_data_file.csv</span><span class=\"p\">    </span><span class=\"s\">dialect=excel</span>\n</pre>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">my_data_file.csv</span><span class=\"p\">    </span><span class=\"s\">dialect=excel_tab</span>\n</pre>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">my_data_file.csv</span><span class=\"p\">    </span><span class=\"s\">dialect=unix_dialect</span>\n</pre>\n<div class=\"section\" id=\"example-user-defined\">\n<h3 id=\"Example User Defined\">Example User Defined</h3>\n<p>User may define the format completely free.\nIf an option is not set, the default values are used.\nTo register a userdefined format user have to set the\noption <tt class=\"docutils literal\">dialect</tt> to <tt class=\"docutils literal\">UserDefined</tt></p>\n<p>Usage in Robot Framework\u00ae</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">my_data_file.csv</span><span class=\"p\">\n...    </span><span class=\"s\">dialect=UserDefined</span><span class=\"p\">\n...    </span><span class=\"s\">delimiter=.</span><span class=\"p\">\n...    </span><span class=\"s\">lineterminator=\\n</span>\n</pre>\n</div>\n</div>\n<div class=\"section\" id=\"defaults\">\n<h2 id=\"Defaults:\">Defaults:</h2>\n<pre class=\"code python literal-block\">\n<span class=\"n\">file</span><span class=\"o\">=</span><span class=\"kc\">None</span><span class=\"p\">,</span>\n<span class=\"n\">encoding</span><span class=\"o\">=</span><span class=\"s1\">'cp1252'</span><span class=\"p\">,</span>\n<span class=\"n\">dialect</span><span class=\"o\">=</span><span class=\"s1\">'Excel-EU'</span><span class=\"p\">,</span>\n<span class=\"n\">delimiter</span><span class=\"o\">=</span><span class=\"s1\">';'</span><span class=\"p\">,</span>\n<span class=\"n\">quotechar</span><span class=\"o\">=</span><span class=\"s1\">'&quot;'</span><span class=\"p\">,</span>\n<span class=\"n\">escapechar</span><span class=\"o\">=</span><span class=\"s1\">'</span><span class=\"se\">\\\\</span><span class=\"s1\">'</span><span class=\"p\">,</span>\n<span class=\"n\">doublequote</span><span class=\"o\">=</span><span class=\"kc\">True</span><span class=\"p\">,</span>\n<span class=\"n\">skipinitialspace</span><span class=\"o\">=</span><span class=\"kc\">False</span><span class=\"p\">,</span>\n<span class=\"n\">lineterminator</span><span class=\"o\">=</span><span class=\"s1\">'</span><span class=\"se\">\\r\\n</span><span class=\"s1\">'</span><span class=\"p\">,</span>\n<span class=\"n\">sheet_name</span><span class=\"o\">=</span><span class=\"mi\">0</span>\n</pre>\n</div>\n</div>\n<div class=\"section\" id=\"custom-datareader-classes\">\n<h1>Custom DataReader Classes</h1>\n<p>It is possible to write your own DataReader Class as a plugin for DataDriver.\nDataReader Classes are called from DataDriver to return a list of TestCaseData.</p>\n<div class=\"section\" id=\"using-custom-datareader\">\n<h2 id=\"Using Custom DataReader\">Using Custom DataReader</h2>\n<p>DataReader classes are loaded dynamically into DataDriver while runtime.\nDataDriver identifies the DataReader to load by the file extantion of the data file or by the option <tt class=\"docutils literal\">reader_class</tt>.</p>\n<div class=\"section\" id=\"select-reader-by-file-extension\">\n<h3 id=\"Select Reader by File Extension:\">Select Reader by File Extension:</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">file=mydata.csv</span>\n</pre>\n<p>This will load the class <tt class=\"docutils literal\">csv_reader</tt> from <tt class=\"docutils literal\">csv_reader.py</tt> from the same folder.</p>\n</div>\n<div class=\"section\" id=\"select-reader-by-option\">\n<h3 id=\"Select Reader by Option:\">Select Reader by Option:</h3>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n    </span><span class=\"s\">Library</span><span class=\"p\">    </span><span class=\"s\">DataDriver</span><span class=\"p\">   </span><span class=\"s\">file=mydata.csv</span><span class=\"p\">    </span><span class=\"s\">reader_class=generic_csv_reader</span><span class=\"p\">    </span><span class=\"s\">dialect=userdefined</span><span class=\"p\">   </span><span class=\"s\">delimiter=\\t</span><span class=\"p\">    </span><span class=\"s\">encoding=UTF-8</span>\n</pre>\n<p>This will load the class <tt class=\"docutils literal\">generic_csv_reader</tt> from <tt class=\"docutils literal\">generic_csv_reader.py</tt> from same folder.</p>\n</div>\n</div>\n<div class=\"section\" id=\"create-custom-reader\">\n<h2 id=\"Create Custom Reader\">Create Custom Reader</h2>\n<p>Recommendation:</p>\n<p>Have a look to the Source Code of existing DataReader like <tt class=\"docutils literal\">csv_reader.py</tt> or <tt class=\"docutils literal\">generic_csv_reader.py</tt> .</p>\n<p>To write your own reader, create a class inherited from <tt class=\"docutils literal\">AbstractReaderClass</tt>.</p>\n<p>Your class will get all available configs from DataDriver as an object of <tt class=\"docutils literal\">ReaderConfig</tt> on <tt class=\"docutils literal\">__init__</tt>.</p>\n<p>DataDriver will call the method <tt class=\"docutils literal\">get_data_from_source</tt>\nThis method should then load your data from your custom source and stores them into list of object of <tt class=\"docutils literal\">TestCaseData</tt>.\nThis List of <tt class=\"docutils literal\">TestCaseData</tt> will be returned to DataDriver.</p>\n<p><tt class=\"docutils literal\">AbstractReaderClass</tt> has also some optional helper methods that may be useful.</p>\n<p>You can either place the custom reader with the others in DataDriver folder or anywhere on the disk.\nIn the first case or if your custom reader is in python path just use it like the others by name:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">          </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">reader_class=my_reader</span>\n</pre>\n<p>In case it is somewhere on the disk, it is possible to use an absolute or relative path to a custom Reader.\nImports of custom readers follow the same rules like importing Robot Framework\u00ae libraries.\nPath can be relative to ${EXECDIR} or to DataDriver/__init__.py:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">          </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">reader_class=C:/data/my_reader.py</span><span class=\"p\">    </span><span class=\"c\"># set custom reader\n</span><span class=\"p\">...                            </span><span class=\"s\">file_search_strategy=None</span><span class=\"p\">            </span><span class=\"c\"># set DataDriver to not check file\n</span><span class=\"p\">...                            </span><span class=\"s\">min=0</span><span class=\"p\">                                </span><span class=\"c\"># kwargs arguments for custom reader\n</span><span class=\"p\">...                            </span><span class=\"s\">max=62</span>\n</pre>\n<p>This <cite>my_reader.py</cite> should implement a class inherited from AbstractReaderClass that is named <cite>my_reader</cite>.</p>\n<pre class=\"code python literal-block\">\n<span class=\"kn\">from</span> <span class=\"nn\">DataDriver.AbstractReaderClass</span> <span class=\"kn\">import</span> <span class=\"n\">AbstractReaderClass</span>  <span class=\"c1\"># inherit class from AbstractReaderClass</span>\n<span class=\"kn\">from</span> <span class=\"nn\">DataDriver.ReaderConfig</span> <span class=\"kn\">import</span> <span class=\"n\">TestCaseData</span>  <span class=\"c1\"># return list of TestCaseData to DataDriver</span>\n\n\n<span class=\"k\">class</span> <span class=\"nc\">my_reader</span><span class=\"p\">(</span><span class=\"n\">AbstractReaderClass</span><span class=\"p\">):</span>\n\n    <span class=\"k\">def</span> <span class=\"nf\">get_data_from_source</span><span class=\"p\">(</span><span class=\"bp\">self</span><span class=\"p\">):</span>  <span class=\"c1\"># This method will be called from DataDriver to get the TestCaseData list.</span>\n        <span class=\"n\">test_data</span> <span class=\"o\">=</span> <span class=\"p\">[]</span>\n        <span class=\"k\">for</span> <span class=\"n\">i</span> <span class=\"ow\">in</span> <span class=\"nb\">range</span><span class=\"p\">(</span><span class=\"nb\">int</span><span class=\"p\">(</span><span class=\"bp\">self</span><span class=\"o\">.</span><span class=\"n\">kwargs</span><span class=\"p\">[</span><span class=\"s1\">'min'</span><span class=\"p\">]),</span> <span class=\"nb\">int</span><span class=\"p\">(</span><span class=\"bp\">self</span><span class=\"o\">.</span><span class=\"n\">kwargs</span><span class=\"p\">[</span><span class=\"s1\">'max'</span><span class=\"p\">])):</span>  <span class=\"c1\"># Dummy code to just generate some data</span>\n            <span class=\"n\">args</span> <span class=\"o\">=</span> <span class=\"p\">{</span><span class=\"s1\">'$</span><span class=\"si\">{var_1}</span><span class=\"s1\">'</span><span class=\"p\">:</span> <span class=\"nb\">str</span><span class=\"p\">(</span><span class=\"n\">i</span><span class=\"p\">),</span> <span class=\"s1\">'$</span><span class=\"si\">{var_2}</span><span class=\"s1\">'</span><span class=\"p\">:</span> <span class=\"nb\">str</span><span class=\"p\">(</span><span class=\"n\">i</span><span class=\"p\">)}</span>  <span class=\"c1\"># args is a dictionary. Variable name is the key, value is value.</span>\n            <span class=\"n\">test_data</span><span class=\"o\">.</span><span class=\"n\">append</span><span class=\"p\">(</span><span class=\"n\">TestCaseData</span><span class=\"p\">(</span><span class=\"sa\">f</span><span class=\"s1\">'test </span><span class=\"si\">{</span><span class=\"n\">i</span><span class=\"si\">}</span><span class=\"s1\">'</span><span class=\"p\">,</span> <span class=\"n\">args</span><span class=\"p\">,</span> <span class=\"p\">[</span><span class=\"s1\">'tag'</span><span class=\"p\">]))</span>  <span class=\"c1\"># add a TestCaseData object to the list of tests.</span>\n        <span class=\"k\">return</span> <span class=\"n\">test_data</span>  <span class=\"c1\"># return the list of TestCaseData to DataDriver</span>\n</pre>\n<p>See other readers as example.</p>\n</div>\n</div>\n<div class=\"section\" id=\"selection-of-test-cases-to-execute\">\n<h1>Selection of Test Cases to Execute</h1>\n<p>Because test cases that are created by DataDriver after parsing while execution,\nit is not possible to use some Robot Framework\u00ae methods to select test cases.</p>\n<p>Examples for options that have to be used differently:</p>\n<table border=\"1\" class=\"docutils\">\n<colgroup>\n<col width=\"21%\" />\n<col width=\"79%\" />\n</colgroup>\n<thead valign=\"bottom\">\n<tr><th class=\"head\">robot option</th>\n<th class=\"head\">Description</th>\n</tr>\n</thead>\n<tbody valign=\"top\">\n<tr><td><tt class=\"docutils literal\"><span class=\"pre\">--test</span></tt></td>\n<td>Selects the test cases by name.</td>\n</tr>\n<tr><td><tt class=\"docutils literal\"><span class=\"pre\">--task</span></tt></td>\n<td>Alias for --test that can be used when executing tasks.</td>\n</tr>\n<tr><td><tt class=\"docutils literal\"><span class=\"pre\">--rerunfailed</span></tt></td>\n<td>Selects failed tests from an earlier output file to be re-executed.</td>\n</tr>\n<tr><td><tt class=\"docutils literal\"><span class=\"pre\">--include</span></tt></td>\n<td>Selects the test cases by tag.</td>\n</tr>\n<tr><td><tt class=\"docutils literal\"><span class=\"pre\">--exclude</span></tt></td>\n<td>Selects the test cases by tag.</td>\n</tr>\n</tbody>\n</table>\n<div class=\"section\" id=\"selection-of-test-cases-by-name\">\n<h2 id=\"Selection of test cases by name\">Selection of test cases by name</h2>\n<div class=\"section\" id=\"select-a-single-test-case\">\n<h3 id=\"Select a single test case:\">Select a single test case:</h3>\n<p>To execute just a single test case by its exact name it is possible to execute the test suite\nand set the global variable ${DYNAMICTEST} with the name of the test case to execute as value.\nPattern must be <tt class=\"docutils literal\">suitename.testcasename</tt>.</p>\n<p>Example:</p>\n<pre class=\"code literal-block\">\nrobot --variable &quot;DYNAMICTEST:my suite name.test case to be executed&quot; my_suite_name.robot\n</pre>\n<p>Pabot uses this feature to execute a single test case when using <tt class=\"docutils literal\"><span class=\"pre\">--testlevelsplit</span></tt></p>\n</div>\n<div class=\"section\" id=\"select-a-list-of-test-cases\">\n<h3 id=\"Select a list of test cases:\">Select a list of test cases:</h3>\n<p>It is possible to set a list of test case names by using the variable ${DYNAMICTESTS} (plural).\nThis variable must be a string and the list of names must be pipe-seperated (<tt class=\"docutils literal\">|</tt>).</p>\n<p>Example:</p>\n<pre class=\"code literal-block\">\nrobot --variable DYNAMICTESTS:firstsuitename.testcase1|firstsuitename.testcase3|anothersuitename.othertestcase foldername\n</pre>\n<p>It is also possible to set the variable &#64;{DYNAMICTESTS} as a list variable from i.e. python code.</p>\n</div>\n</div>\n<div class=\"section\" id=\"re-run-failed-test-cases\">\n<h2 id=\"Re-run failed test cases:\">Re-run failed test cases:</h2>\n<p>Because it is not possible to use the command line argument <tt class=\"docutils literal\"><span class=\"pre\">--rerunfailed</span></tt> from robot directly,\nDataDriver brings a Pre-Run-Modifier that handles this issue.</p>\n<p>Normally reexecution of failed testcases has three steps.</p>\n<ul class=\"simple\">\n<li>original execution</li>\n<li>re-execution the failed ones based on original execution output</li>\n<li>merging original execution output with re-execution output</li>\n</ul>\n<p>The DataDriver.rerunfailed Pre-Run-Modifier removes all passed test cases based on a former output.xml.</p>\n<p>Example:</p>\n<pre class=\"code literal-block\">\nrobot --output original.xml tests                                                    # first execute all tests\nrobot --prerunmodifier DataDriver.rerunfailed:original.xml --output rerun.xml tests  # then re-execute failing\nrebot --merge original.xml rerun.xml                                                 # finally merge results\n</pre>\n<p>Be aware, that in this case it is not allowed to use &quot;<tt class=\"docutils literal\">:</tt>&quot; as character in the original output file path.\nIf you want to set a full path on windows like <tt class=\"docutils literal\"><span class=\"pre\">e:\\myrobottest\\output.xml</span></tt> you have to use &quot;<tt class=\"docutils literal\">;</tt>&quot;\nas argument seperator.</p>\n<p>Example:</p>\n<pre class=\"code literal-block\">\nrobot --prerunmodifier DataDriver.rerunfailed;e:\\myrobottest\\output.xml --output e:\\myrobottest\\rerun.xml tests\n</pre>\n</div>\n<div class=\"section\" id=\"filtering-with-tags\">\n<h2 id=\"Filtering with tags.\">Filtering with tags.</h2>\n<p>New in <tt class=\"docutils literal\">0.3.1</tt></p>\n<p>It is possible to use tags to filter the data source.\nTo use this, tags must be assigned to the test cases in data source.</p>\n<div class=\"section\" id=\"robot-framework-command-line-arguments\">\n<h3 id=\"Robot Framework\u00ae Command Line Arguments\">Robot Framework\u00ae Command Line Arguments</h3>\n<p>To filter the source, the normal command line arguments of Robot Framework\u00ae can be used.\nSee Robot Framework\u00ae <a class=\"reference external\" href=\"https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#tag-patterns\">Userguide</a> for more information\nBe aware that the filtering of Robot Framework\u00ae itself is done before DataDriver is called.\nThis means if the Template test is already filtered out by Robot Framework\u00ae, DataDriver can never be called.\nIf you want to use <tt class=\"docutils literal\"><span class=\"pre\">--include</span></tt> the DataDriver TestSuite should have a <tt class=\"docutils literal\">DefaultTag</tt> or <tt class=\"docutils literal\">ForceTag</tt> that\nfulfills these requirements.</p>\n<p>Example: <tt class=\"docutils literal\">robot <span class=\"pre\">--include</span> 1OR2 <span class=\"pre\">--exclude</span> foo DataDriven.robot</tt></p>\n</div>\n<div class=\"section\" id=\"filter-based-on-library-options\">\n<h3 id=\"Filter based on Library Options\">Filter based on Library Options</h3>\n<p>It is also possible to filter the data source by an init option of DataDriver.\nIf these Options are set, Robot Framework\u00ae Filtering will be ignored.</p>\n<p>Example:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">include=1OR2</span><span class=\"p\">    </span><span class=\"s\">exclude=foo</span>\n</pre>\n</div>\n</div>\n</div>\n<div class=\"section\" id=\"configure-datadriver-by-pre-run-keyword\">\n<h1>Configure DataDriver by Pre-Run Keyword</h1>\n<p>With <tt class=\"docutils literal\">config_keyword=</tt> it's possible to name a keyword that will be called from Data Driver before it starts the actual processing of the <tt class=\"docutils literal\">data file</tt>.\nOne possible usage is if the <tt class=\"docutils literal\">data file</tt> itself shall be created by another keyword dynamically during the execution of the Data Driver test suite.\nThe <tt class=\"docutils literal\">config_keyword=</tt> can be used to call that keyword and return the updated arguments (e.g. <tt class=\"docutils literal\">file</tt>) back to the Data Driver Library.</p>\n<p>The <tt class=\"docutils literal\">config keyword</tt></p>\n<ul class=\"simple\">\n<li>May be defined globally or inside each testsuite individually</li>\n<li>Gets all the arguments, that Data Driver gets from Library import, as a Robot Dictionary</li>\n<li>Shall return the (updated) Data Driver arguments as a Robot Dictionary</li>\n</ul>\n<p>Usage in Robot Framework\u00ae</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">           </span><span class=\"nn\">OperatingSystem</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">           </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">dialect=excel</span><span class=\"p\">    </span><span class=\"s\">encoding=utf_8</span><span class=\"p\">   </span><span class=\"s\">config_keyword=Config</span><span class=\"p\">\n</span><span class=\"kn\">Test Template</span><span class=\"p\">     </span><span class=\"nf\">The Keyword</span><span class=\"p\">\n\n</span><span class=\"gh\">*** Test Cases ***</span><span class=\"p\">\n</span><span class=\"gu\">Test</span><span class=\"p\">    </span><span class=\"s\">aaa</span><span class=\"p\">\n\n</span><span class=\"gh\">*** Keywords ***</span><span class=\"p\">\n</span><span class=\"gu\">The Keyword</span><span class=\"p\">\n    [</span><span class=\"kn\">Arguments</span><span class=\"p\">]    ${</span><span class=\"nv\">var</span><span class=\"p\">}\n    </span><span class=\"nf\">Log To Console</span><span class=\"p\">    ${</span><span class=\"nv\">var</span><span class=\"p\">}\n\n</span><span class=\"gu\">Config</span><span class=\"p\">\n    [</span><span class=\"kn\">Arguments</span><span class=\"p\">]    ${</span><span class=\"nv\">original_config</span><span class=\"p\">}\n    </span><span class=\"nf\">Log To Console</span><span class=\"p\">    ${</span><span class=\"nv\">original_config.dialect</span><span class=\"p\">}                </span><span class=\"c\"># just a log of the original\n</span><span class=\"p\">    </span><span class=\"nf\">Create File</span><span class=\"p\">    ${</span><span class=\"nv\">CURDIR</span><span class=\"p\">}</span><span class=\"s\">/test321.csv</span><span class=\"p\">\n    ...    </span><span class=\"s\">*** Test Cases ***,\\${var},\\n123,111,\\n321,222,</span><span class=\"p\">      </span><span class=\"c\"># generating file\n</span><span class=\"p\">    ${</span><span class=\"nv\">new_config</span><span class=\"p\">}=    </span><span class=\"nf\">Create Dictionary</span><span class=\"p\">    </span><span class=\"s\">file=test321.csv</span><span class=\"p\">     </span><span class=\"c\"># set file attribute in a dictionary\n</span><span class=\"p\">    [</span><span class=\"kn\">Return</span><span class=\"p\">]    ${</span><span class=\"nv\">new_config</span><span class=\"p\">}                                   </span><span class=\"c\"># returns {'file': 'test321.csv'}</span>\n</pre>\n</div>\n<div class=\"section\" id=\"pabot-and-datadriver\">\n<h1>Pabot and DataDriver</h1>\n<p>You should use Pabot version 1.10.0 or newer.</p>\n<p>DataDriver supports <tt class=\"docutils literal\"><span class=\"pre\">--testlevelsplit</span></tt> from pabot only if the PabotLib is in use.\nUse <tt class=\"docutils literal\"><span class=\"pre\">--pabotlib</span></tt> to enable that.</p>\n<p>When using pabot like this, DataDriver automatically splits the amount of test cases into nearly same sized groups.\nIs uses the processes count from pabot to calculate the groups.\nWhen using 8 processes with 100 test cases you will get 8 groups of tests with the size of 12 to 13 tests.\nThese 8 groups are then executed as one block with 8 processes.\nThis reduces a lot of overhead with Suite Setup and Teardown.</p>\n<p>You can switch between three modes:</p>\n<ul class=\"simple\">\n<li><tt class=\"docutils literal\">Equal</tt>: means it creates equal sizes groups</li>\n<li><tt class=\"docutils literal\">Binary</tt>: is more complex. it created a decreasing size of containers to support better balancing.</li>\n<li><tt class=\"docutils literal\">Atomic</tt>: it does not group tests at all and runs really each test case in a separate thread.</li>\n</ul>\n<p>This can be set by <tt class=\"docutils literal\">optimize_pabot</tt> in Library import.</p>\n<p><strong>Example</strong>:</p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">          </span><span class=\"nn\">DataDriver</span><span class=\"p\">    </span><span class=\"s\">optimize_pabot=Binary</span>\n</pre>\n<p>Binary creates with 40 test cases and 8 threads something like that:</p>\n<pre class=\"code literal-block\">\nP01: 01,02,03,04,05\nP02: 06,07,08,09,10\nP03: 11,12,13,14,15\nP04: 16,17,18,19,20\nP05: 21,22,23\nP06: 24,25,26\nP07: 27,28,29\nP08: 30,31,32\nP09: 33\nP10: 34\nP11: 35\nP12: 36\nP13: 37\nP14: 38\nP15: 39\nP16: 40\n</pre>\n</div>\n</div>\n", "version": "1.7.0", "generated": "2022-11-30T19:50:41+00:00", "type": "LIBRARY", "scope": "SUITE", "docFormat": "HTML", "source": "/System/Volumes/Data/Source/Snooz82/robotframework-datadriver/src/DataDriver/__init__.py", "lineno": 54, "tags": [], "inits": [{"name": "__init__", "args": [{"name": "file", "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "file: str | None = None"}, {"name": "encoding", "types": ["Encodings", "Any"], "typedocs": {"Encodings": "Encodings"}, "defaultValue": "cp1252", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "encoding: Encodings | Any = cp1252"}, {"name": "dialect", "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "Excel-EU", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "dialect: str = Excel-EU"}, {"name": "delimiter", "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": ";", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "delimiter: str = ;"}, {"name": "quotechar", "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "\"", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "quotechar: str = \""}, {"name": "escapechar", "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "\\\\", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "escapechar: str = \\\\"}, {"name": "doublequote", "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "doublequote: bool = True"}, {"name": "skipinitialspace", "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "skipinitialspace: bool = False"}, {"name": "lineterminator", "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "\\r\\n", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "lineterminator: str = \\r\\n"}, {"name": "", "types": [], "typedocs": {}, "defaultValue": null, "kind": "NAMED_ONLY_MARKER", "required": false, "repr": "*"}, {"name": "sheet_name", "types": ["str", "int"], "typedocs": {"str": "string", "int": "integer"}, "defaultValue": "0", "kind": "NAMED_ONLY", "required": false, "repr": "sheet_name: str | int = 0"}, {"name": "reader_class", "types": ["AbstractReaderClass", "str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "reader_class: AbstractReaderClass | str | None = None"}, {"name": "file_search_strategy", "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "PATH", "kind": "NAMED_ONLY", "required": false, "repr": "file_search_strategy: str = PATH"}, {"name": "file_regex", "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "(?i)(.*?)(\\\\.csv)", "kind": "NAMED_ONLY", "required": false, "repr": "file_regex: str = (?i)(.*?)(\\\\.csv)"}, {"name": "include", "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "include: str | None = None"}, {"name": "exclude", "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "exclude: str | None = None"}, {"name": "handle_template_tags", "types": ["TagHandling"], "typedocs": {"TagHandling": "TagHandling"}, "defaultValue": "UnsetTags", "kind": "NAMED_ONLY", "required": false, "repr": "handle_template_tags: TagHandling = UnsetTags"}, {"name": "listseperator", "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": ",", "kind": "NAMED_ONLY", "required": false, "repr": "listseperator: str = ,"}, {"name": "config_keyword", "types": ["str", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "NAMED_ONLY", "required": false, "repr": "config_keyword: str | None = None"}, {"name": "optimize_pabot", "types": ["PabotOpt"], "typedocs": {"PabotOpt": "PabotOpt"}, "defaultValue": "Equal", "kind": "NAMED_ONLY", "required": false, "repr": "optimize_pabot: PabotOpt = Equal"}, {"name": "kwargs", "types": ["Any"], "typedocs": {}, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**kwargs: Any"}], "doc": "<div class=\"document\">\n<p><strong>Example:</strong></p>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span>\n</pre>\n<div class=\"section\" id=\"options\">\n<h1>Options</h1>\n<pre class=\"code robotframework literal-block\">\n<span class=\"gh\">*** Settings ***</span><span class=\"p\">\n</span><span class=\"kn\">Library</span><span class=\"p\">    </span><span class=\"nn\">DataDriver</span><span class=\"p\">\n...    </span><span class=\"s\">file=None</span><span class=\"p\">\n...    </span><span class=\"s\">encoding=cp1252</span><span class=\"p\">\n...    </span><span class=\"s\">dialect=Excel-EU</span><span class=\"p\">\n...    </span><span class=\"s\">delimiter=;</span><span class=\"p\">\n...    </span><span class=\"s\">quotechar=&quot;</span><span class=\"p\">\n...    </span><span class=\"s\">escapechar=\\\\</span><span class=\"p\">\n...    </span><span class=\"s\">doublequote=True</span><span class=\"p\">\n...    </span><span class=\"s\">skipinitialspace=False</span><span class=\"p\">\n...    </span><span class=\"s\">lineterminator=\\r\\n</span><span class=\"p\">\n...    </span><span class=\"s\">*</span><span class=\"p\">  </span><span class=\"c\"># the following are named only arguments\n</span><span class=\"p\">...    </span><span class=\"s\">sheet_name=0</span><span class=\"p\">\n...    </span><span class=\"s\">reader_class=None</span><span class=\"p\">\n...    </span><span class=\"s\">file_search_strategy=PATH</span><span class=\"p\">\n...    </span><span class=\"s\">file_regex=(?i)(.*?)(\\.csv)</span><span class=\"p\">\n...    </span><span class=\"s\">include=None</span><span class=\"p\">\n...    </span><span class=\"s\">exclude=None</span><span class=\"p\">\n...    </span><span class=\"s\">handle_template_tags=UnsetTags</span><span class=\"p\">\n...    </span><span class=\"s\">listseperator=,</span><span class=\"p\">\n...    </span><span class=\"s\">config_keyword=None</span><span class=\"p\">\n...    </span><span class=\"s\">optimize_pabot=Equal</span><span class=\"p\">\n...    &amp;{</span><span class=\"nv\">kwargs</span><span class=\"p\">}</span>\n</pre>\n<div class=\"section\" id=\"file\">\n<h2>File</h2>\n<p>Defines which data file to be read. Maybe None or an extension like <tt class=\"docutils literal\">.txt</tt> or relative or absolute path.\n<tt class=\"docutils literal\">file_search_strategy=</tt> and <tt class=\"docutils literal\">file_regex</tt> may also have influence here.</p>\n</div>\n<div class=\"section\" id=\"encoding\">\n<h2>Encoding</h2>\n<p><tt class=\"docutils literal\">encoding</tt> must be set if it shall not be cp1252.</p>\n<p><strong>Examples</strong>:</p>\n<p><tt class=\"docutils literal\">cp1252, ascii, <span class=\"pre\">iso-8859-1,</span> <span class=\"pre\">latin-1,</span> utf_8, utf_16, utf_16_be, utf_16_le</tt></p>\n<p>See <a class=\"reference external\" href=\"https://docs.python.org/3/library/codecs.html#standard-encodings\">Python Standard Encoding</a> for more encodings</p>\n</div>\n<div class=\"section\" id=\"dialect-to-lineterminator\">\n<h2>Dialect to LineTerminator</h2>\n<p>Defines how a csv file is interpreted.</p>\n</div>\n<div class=\"section\" id=\"reader-class\">\n<h2>Reader Class</h2>\n<p>Defines which custom DataReader shall be loaded and get handed over all configs to deliver the TestCaseData.</p>\n</div>\n<div class=\"section\" id=\"include-exclude\">\n<h2>Include &amp; Exclude</h2>\n<p>Alternative way to CLI Options of Robot Framework\u00ae to filter the specific TestCaseData based on given Tags.</p>\n</div>\n<div class=\"section\" id=\"handle-template-tags\">\n<h2>Handle Template Tags</h2>\n<p>It can be configured how the tags of the template test will be added to the data-driven test cases.</p>\n</div>\n<div class=\"section\" id=\"list-separator\">\n<h2>List Separator</h2>\n<p>Defines how list values or dictionary values are seperated.</p>\n</div>\n<div class=\"section\" id=\"config-keyword\">\n<h2>Config Keyword</h2>\n<p>Keyword that is executed before DataDriver starts working. Can manipulate all data.</p>\n</div>\n<div class=\"section\" id=\"optimize-pabot\">\n<h2>Optimize Pabot</h2>\n<p>When DataDriver is used together with Pabot, it optimizes the <tt class=\"docutils literal\"><span class=\"pre\">--testlevelsplit</span></tt> to be faster.</p>\n</div>\n</div>\n</div>\n", "shortdoc": "**Example:**", "tags": [], "source": "/System/Volumes/Data/Source/Snooz82/robotframework-datadriver/src/DataDriver/DataDriver.py", "lineno": 1344}], "keywords": [], "dataTypes": {"enums": [{"type": "Enum", "name": "Encodings", "doc": "<div class=\"document\">\n<p>Python comes with a number of codecs built-in,\neither implemented as C functions or with dictionaries as mapping tables.\nThe following table lists the codecs by name,\ntogether with a few common aliases, and the languages for which the encoding is likely used.\nNeither the list of aliases nor the list of languages is meant to be exhaustive.\nNotice that spelling alternatives that only differ in case or use a hyphen instead\nof an underscore are also valid aliases; therefore, e.g. <tt class=\"docutils literal\"><span class=\"pre\">utf-8<span class=\"name\"></span> is a valid alias for the </span>`utf_8</tt> codec.</p>\n<p><em>CPython implementation detail:</em> Some common encodings can bypass the codecs lookup machinery to improve performance.\nThese optimization opportunities are only recognized by CPython for a limited set of (case insensitive) aliases:\nutf-8, utf8, latin-1, latin1, iso-8859-1, iso8859-1, mbcs (Windows only),\nascii, us-ascii, utf-16, utf16, utf-32, utf32, and the same using underscores instead of dashes.\nUsing alternative aliases for these encodings may result in slower execution.</p>\n<p>Changed in version 3.6: Optimization opportunity recognized for us-ascii.</p>\n<p>Many of the character sets support the same languages. They vary in individual characters (e.g. whether the EURO SIGN is supported or not), and in the assignment of characters to code positions. For the European languages in particular, the following variants typically exist:</p>\n<ul class=\"simple\">\n<li>utf-8</li>\n<li>cp1252</li>\n<li>an ISO 8859 codeset</li>\n<li>a Microsoft Windows code page, which is typically derived from an 8859 codeset, but replaces control characters with additional graphic characters</li>\n<li>an IBM EBCDIC code page</li>\n<li>an IBM PC code page, which is ASCII compatible</li>\n</ul>\n</div>\n", "members": [{"name": "ascii", "value": "1"}, {"name": "big5", "value": "2"}, {"name": "big5hkscs", "value": "3"}, {"name": "cp037", "value": "4"}, {"name": "cp273", "value": "5"}, {"name": "cp424", "value": "6"}, {"name": "cp437", "value": "7"}, {"name": "cp500", "value": "8"}, {"name": "cp720", "value": "9"}, {"name": "cp737", "value": "10"}, {"name": "cp775", "value": "11"}, {"name": "cp850", "value": "12"}, {"name": "cp852", "value": "13"}, {"name": "cp855", "value": "14"}, {"name": "cp856", "value": "15"}, {"name": "cp857", "value": "16"}, {"name": "cp858", "value": "17"}, {"name": "cp860", "value": "18"}, {"name": "cp861", "value": "19"}, {"name": "cp862", "value": "20"}, {"name": "cp863", "value": "21"}, {"name": "cp864", "value": "22"}, {"name": "cp865", "value": "23"}, {"name": "cp866", "value": "24"}, {"name": "cp869", "value": "25"}, {"name": "cp874", "value": "26"}, {"name": "cp875", "value": "27"}, {"name": "cp932", "value": "28"}, {"name": "cp949", "value": "29"}, {"name": "cp950", "value": "30"}, {"name": "cp1006", "value": "31"}, {"name": "cp1026", "value": "32"}, {"name": "cp1125", "value": "33"}, {"name": "cp1140", "value": "34"}, {"name": "cp1250", "value": "35"}, {"name": "cp1251", "value": "36"}, {"name": "cp1252", "value": "37"}, {"name": "cp1253", "value": "38"}, {"name": "cp1254", "value": "39"}, {"name": "cp1255", "value": "40"}, {"name": "cp1256", "value": "41"}, {"name": "cp1257", "value": "42"}, {"name": "cp1258", "value": "43"}, {"name": "euc_jp", "value": "44"}, {"name": "euc_jis_2004", "value": "45"}, {"name": "euc_jisx0213", "value": "46"}, {"name": "euc_kr", "value": "47"}, {"name": "gb2312", "value": "48"}, {"name": "gbk", "value": "49"}, {"name": "gb18030", "value": "50"}, {"name": "hz", "value": "51"}, {"name": "iso2022_jp", "value": "52"}, {"name": "iso2022_jp_1", "value": "53"}, {"name": "iso2022_jp_2", "value": "54"}, {"name": "iso2022_jp_2004", "value": "55"}, {"name": "iso2022_jp_3", "value": "56"}, {"name": "iso2022_jp_ext", "value": "57"}, {"name": "iso2022_kr", "value": "58"}, {"name": "latin_1", "value": "59"}, {"name": "iso8859_2", "value": "60"}, {"name": "iso8859_3", "value": "61"}, {"name": "iso8859_4", "value": "62"}, {"name": "iso8859_5", "value": "63"}, {"name": "iso8859_6", "value": "64"}, {"name": "iso8859_7", "value": "65"}, {"name": "iso8859_8", "value": "66"}, {"name": "iso8859_9", "value": "67"}, {"name": "iso8859_10", "value": "68"}, {"name": "iso8859_11", "value": "69"}, {"name": "iso8859_13", "value": "70"}, {"name": "iso8859_14", "value": "71"}, {"name": "iso8859_15", "value": "72"}, {"name": "iso8859_16", "value": "73"}, {"name": "johab", "value": "74"}, {"name": "koi8_r", "value": "75"}, {"name": "koi8_t", "value": "76"}, {"name": "koi8_u", "value": "77"}, {"name": "kz1048", "value": "78"}, {"name": "mac_cyrillic", "value": "79"}, {"name": "mac_greek", "value": "80"}, {"name": "mac_iceland", "value": "81"}, {"name": "mac_latin2", "value": "82"}, {"name": "mac_roman", "value": "83"}, {"name": "mac_turkish", "value": "84"}, {"name": "ptcp154", "value": "85"}, {"name": "shift_jis", "value": "86"}, {"name": "shift_jis_2004", "value": "87"}, {"name": "shift_jisx0213", "value": "88"}, {"name": "utf_32", "value": "89"}, {"name": "utf_32_be", "value": "90"}, {"name": "utf_32_le", "value": "91"}, {"name": "utf_16", "value": "92"}, {"name": "utf_16_be", "value": "93"}, {"name": "utf_16_le", "value": "94"}, {"name": "utf_7", "value": "95"}, {"name": "utf_8", "value": "96"}, {"name": "utf_8_sig", "value": "97"}]}, {"type": "Enum", "name": "PabotOpt", "doc": "<div class=\"document\">\n<p>You can switch Pabot --testlevelsplit between three modes:</p>\n<ul class=\"simple\">\n<li>Equal: means it creates equal sizes groups</li>\n<li>Binary: is more complex. it created a decreasing size of containers to support better balancing.</li>\n<li>Atomic: it does not group tests at all and runs really each test case in a separate thread.</li>\n</ul>\n<p>See <a class=\"reference external\" href=\"#pabot-and-datadriver\">Pabot and DataDriver</a> for more details.</p>\n<p>This can be set by <tt class=\"docutils literal\">optimize_pabot</tt> in Library import.</p>\n</div>\n", "members": [{"name": "Equal", "value": "1"}, {"name": "Binary", "value": "2"}, {"name": "Atomic", "value": "3"}]}, {"type": "Enum", "name": "TagHandling", "doc": "<div class=\"document\">\n<p>You can configure how to handle tags from the template in generated tests:</p>\n<ul class=\"simple\">\n<li>ForceTags: Will add all tags of the template test to all data-driven test cases.</li>\n<li>UnsetTags: Will add only these tags from template test to the tests, that are not assigned to any of the test cases.</li>\n<li>DefaultTags: Will only add tags to data-driven test if no tag is set on that test.</li>\n<li>NoTags: Will not add any tags from the template to date-driven tests.</li>\n</ul>\n</div>\n", "members": [{"name": "ForceTags", "value": "1"}, {"name": "UnsetTags", "value": "2"}, {"name": "DefaultTags", "value": "3"}, {"name": "NoTags", "value": "4"}]}], "typedDicts": []}, "typedocs": [{"type": "Standard", "name": "boolean", "doc": "<p>Strings <code>TRUE</code>, <code>YES</code>, <code>ON</code> and <code>1</code> are converted to Boolean <code>True</code>, the empty string as well as strings <code>FALSE</code>, <code>NO</code>, <code>OFF</code> and <code>0</code> are converted to Boolean <code>False</code>, and the string <code>NONE</code> is converted to the Python <code>None</code> object. Other strings and other accepted values are passed as-is, allowing keywords to handle them specially if needed. All string comparisons are case-insensitive.</p>\n<p>Examples: <code>TRUE</code> (converted to <code>True</code>), <code>off</code> (converted to <code>False</code>), <code>example</code> (used as-is)</p>", "usages": ["__init__"], "accepts": ["string", "integer", "float", "None"]}, {"type": "Enum", "name": "Encodings", "doc": "<div class=\"document\">\n<p>Python comes with a number of codecs built-in,\neither implemented as C functions or with dictionaries as mapping tables.\nThe following table lists the codecs by name,\ntogether with a few common aliases, and the languages for which the encoding is likely used.\nNeither the list of aliases nor the list of languages is meant to be exhaustive.\nNotice that spelling alternatives that only differ in case or use a hyphen instead\nof an underscore are also valid aliases; therefore, e.g. <tt class=\"docutils literal\"><span class=\"pre\">utf-8<span class=\"name\"></span> is a valid alias for the </span>`utf_8</tt> codec.</p>\n<p><em>CPython implementation detail:</em> Some common encodings can bypass the codecs lookup machinery to improve performance.\nThese optimization opportunities are only recognized by CPython for a limited set of (case insensitive) aliases:\nutf-8, utf8, latin-1, latin1, iso-8859-1, iso8859-1, mbcs (Windows only),\nascii, us-ascii, utf-16, utf16, utf-32, utf32, and the same using underscores instead of dashes.\nUsing alternative aliases for these encodings may result in slower execution.</p>\n<p>Changed in version 3.6: Optimization opportunity recognized for us-ascii.</p>\n<p>Many of the character sets support the same languages. They vary in individual characters (e.g. whether the EURO SIGN is supported or not), and in the assignment of characters to code positions. For the European languages in particular, the following variants typically exist:</p>\n<ul class=\"simple\">\n<li>utf-8</li>\n<li>cp1252</li>\n<li>an ISO 8859 codeset</li>\n<li>a Microsoft Windows code page, which is typically derived from an 8859 codeset, but replaces control characters with additional graphic characters</li>\n<li>an IBM EBCDIC code page</li>\n<li>an IBM PC code page, which is ASCII compatible</li>\n</ul>\n</div>\n", "usages": ["__init__"], "accepts": ["string"], "members": [{"name": "ascii", "value": "1"}, {"name": "big5", "value": "2"}, {"name": "big5hkscs", "value": "3"}, {"name": "cp037", "value": "4"}, {"name": "cp273", "value": "5"}, {"name": "cp424", "value": "6"}, {"name": "cp437", "value": "7"}, {"name": "cp500", "value": "8"}, {"name": "cp720", "value": "9"}, {"name": "cp737", "value": "10"}, {"name": "cp775", "value": "11"}, {"name": "cp850", "value": "12"}, {"name": "cp852", "value": "13"}, {"name": "cp855", "value": "14"}, {"name": "cp856", "value": "15"}, {"name": "cp857", "value": "16"}, {"name": "cp858", "value": "17"}, {"name": "cp860", "value": "18"}, {"name": "cp861", "value": "19"}, {"name": "cp862", "value": "20"}, {"name": "cp863", "value": "21"}, {"name": "cp864", "value": "22"}, {"name": "cp865", "value": "23"}, {"name": "cp866", "value": "24"}, {"name": "cp869", "value": "25"}, {"name": "cp874", "value": "26"}, {"name": "cp875", "value": "27"}, {"name": "cp932", "value": "28"}, {"name": "cp949", "value": "29"}, {"name": "cp950", "value": "30"}, {"name": "cp1006", "value": "31"}, {"name": "cp1026", "value": "32"}, {"name": "cp1125", "value": "33"}, {"name": "cp1140", "value": "34"}, {"name": "cp1250", "value": "35"}, {"name": "cp1251", "value": "36"}, {"name": "cp1252", "value": "37"}, {"name": "cp1253", "value": "38"}, {"name": "cp1254", "value": "39"}, {"name": "cp1255", "value": "40"}, {"name": "cp1256", "value": "41"}, {"name": "cp1257", "value": "42"}, {"name": "cp1258", "value": "43"}, {"name": "euc_jp", "value": "44"}, {"name": "euc_jis_2004", "value": "45"}, {"name": "euc_jisx0213", "value": "46"}, {"name": "euc_kr", "value": "47"}, {"name": "gb2312", "value": "48"}, {"name": "gbk", "value": "49"}, {"name": "gb18030", "value": "50"}, {"name": "hz", "value": "51"}, {"name": "iso2022_jp", "value": "52"}, {"name": "iso2022_jp_1", "value": "53"}, {"name": "iso2022_jp_2", "value": "54"}, {"name": "iso2022_jp_2004", "value": "55"}, {"name": "iso2022_jp_3", "value": "56"}, {"name": "iso2022_jp_ext", "value": "57"}, {"name": "iso2022_kr", "value": "58"}, {"name": "latin_1", "value": "59"}, {"name": "iso8859_2", "value": "60"}, {"name": "iso8859_3", "value": "61"}, {"name": "iso8859_4", "value": "62"}, {"name": "iso8859_5", "value": "63"}, {"name": "iso8859_6", "value": "64"}, {"name": "iso8859_7", "value": "65"}, {"name": "iso8859_8", "value": "66"}, {"name": "iso8859_9", "value": "67"}, {"name": "iso8859_10", "value": "68"}, {"name": "iso8859_11", "value": "69"}, {"name": "iso8859_13", "value": "70"}, {"name": "iso8859_14", "value": "71"}, {"name": "iso8859_15", "value": "72"}, {"name": "iso8859_16", "value": "73"}, {"name": "johab", "value": "74"}, {"name": "koi8_r", "value": "75"}, {"name": "koi8_t", "value": "76"}, {"name": "koi8_u", "value": "77"}, {"name": "kz1048", "value": "78"}, {"name": "mac_cyrillic", "value": "79"}, {"name": "mac_greek", "value": "80"}, {"name": "mac_iceland", "value": "81"}, {"name": "mac_latin2", "value": "82"}, {"name": "mac_roman", "value": "83"}, {"name": "mac_turkish", "value": "84"}, {"name": "ptcp154", "value": "85"}, {"name": "shift_jis", "value": "86"}, {"name": "shift_jis_2004", "value": "87"}, {"name": "shift_jisx0213", "value": "88"}, {"name": "utf_32", "value": "89"}, {"name": "utf_32_be", "value": "90"}, {"name": "utf_32_le", "value": "91"}, {"name": "utf_16", "value": "92"}, {"name": "utf_16_be", "value": "93"}, {"name": "utf_16_le", "value": "94"}, {"name": "utf_7", "value": "95"}, {"name": "utf_8", "value": "96"}, {"name": "utf_8_sig", "value": "97"}]}, {"type": "Standard", "name": "integer", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#int\">int</a> built-in function. Floating point numbers are accepted only if they can be represented as integers exactly. For example, <code>1.0</code> is accepted and <code>1.1</code> is not.</p>\n<p>Starting from RF 4.1, it is possible to use hexadecimal, octal and binary numbers by prefixing values with <code>0x</code>, <code>0o</code> and <code>0b</code>, respectively.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>42</code>, <code>-1</code>, <code>0b1010</code>, <code>10 000 000</code>, <code>0xBAD_C0FFEE</code></p>", "usages": ["__init__"], "accepts": ["string", "float"]}, {"type": "Standard", "name": "None", "doc": "<p>String <code>NONE</code> (case-insensitive) is converted to Python <code>None</code> object. Other values cause an error.</p>", "usages": ["__init__"], "accepts": ["string"]}, {"type": "Enum", "name": "PabotOpt", "doc": "<div class=\"document\">\n<p>You can switch Pabot --testlevelsplit between three modes:</p>\n<ul class=\"simple\">\n<li>Equal: means it creates equal sizes groups</li>\n<li>Binary: is more complex. it created a decreasing size of containers to support better balancing.</li>\n<li>Atomic: it does not group tests at all and runs really each test case in a separate thread.</li>\n</ul>\n<p>See <a class=\"reference external\" href=\"#pabot-and-datadriver\">Pabot and DataDriver</a> for more details.</p>\n<p>This can be set by <tt class=\"docutils literal\">optimize_pabot</tt> in Library import.</p>\n</div>\n", "usages": ["__init__"], "accepts": ["string"], "members": [{"name": "Equal", "value": "1"}, {"name": "Binary", "value": "2"}, {"name": "Atomic", "value": "3"}]}, {"type": "Standard", "name": "string", "doc": "<p>All arguments are converted to Unicode strings.</p>", "usages": ["__init__"], "accepts": ["Any"]}, {"type": "Enum", "name": "TagHandling", "doc": "<div class=\"document\">\n<p>You can configure how to handle tags from the template in generated tests:</p>\n<ul class=\"simple\">\n<li>ForceTags: Will add all tags of the template test to all data-driven test cases.</li>\n<li>UnsetTags: Will add only these tags from template test to the tests, that are not assigned to any of the test cases.</li>\n<li>DefaultTags: Will only add tags to data-driven test if no tag is set on that test.</li>\n<li>NoTags: Will not add any tags from the template to date-driven tests.</li>\n</ul>\n</div>\n", "usages": ["__init__"], "accepts": ["string"], "members": [{"name": "ForceTags", "value": "1"}, {"name": "UnsetTags", "value": "2"}, {"name": "DefaultTags", "value": "3"}, {"name": "NoTags", "value": "4"}]}]}
 </script>
 <title></title>
 </head>
@@ -1215,7 +1213,7 @@ <h1>Opening library documentation failed</h1>
     }, false);
     window.addEventListener("hashchange", function() {
         if (window.location.hash.indexOf('#type-') == 0) {
-            const hash = '#' + decodeURI(window.location.hash.slice(6));
+            const hash = '#type-modal-' + decodeURI(window.location.hash.slice(6));
             const typeDoc = document.querySelector(".data-types").querySelector(hash);
             if (typeDoc) {
               showModal(typeDoc);
@@ -1230,6 +1228,7 @@ <h1>Opening library documentation failed</h1>
         parseTemplates();
         document.title = libdoc.name;
         storage.init('libdoc');
+        setTheme();
         renderTemplate('base', libdoc, $('body'));
         if (libdoc.inits.length) {
             libdoc.typedocs.map(function(type) {
@@ -1263,6 +1262,20 @@ <h1>Opening library documentation failed</h1>
         createModal();
     });
 
+    function setTheme(theme) {
+        document.documentElement.setAttribute('data-theme', theme || getTheme());
+    }
+
+    function getTheme() {
+        if (libdoc['theme']) {
+            return libdoc['theme'];
+        } else if (window.matchMedia('(prefers-color-scheme: dark)').matches) {
+            return 'dark';
+        } else {
+            return 'light;'
+        }
+    }
+
     function parseTemplates() {
         $('script[type="text/x-jquery-tmpl"]').map(function (idx, elem) {
             $.template(elem.id, elem.text);
@@ -1736,7 +1749,7 @@ <h4>Documentation</h4>
   <span class="arg-type">
     {{each types}}
       {{if $value in $data.typedocs}}
-          &lt;<a style="cursor: pointer;" class="type" title="Click to show type information" onclick="showModal(${$data.typedocs[$value]})">${$value}</a>&gt;
+          &lt;<a style="cursor: pointer;" class="type" title="Click to show type information" onclick="showModal(document.querySelector('#type-modal-${$data.typedocs[$value]}'))">${$value}</a>&gt;
       {{else}}
           &lt;<span class="type">${$value}</span>&gt;
       {{/if}}
@@ -1759,7 +1772,7 @@ <h2 id="Data types">Data types</h2>
 </script>
 
 <script type="text/x-jquery-tmpl" id="data-type-template">
-    <div class="data-type-container {{if hidden}}no-{{/if}}match" id="${name}">
+    <div class="data-type-container {{if hidden}}no-{{/if}}match" id="type-modal-${name}">
        <div class="data-type-name">
             <h2>${name} (${type})</h2>
        </div>
diff --git a/src/DataDriver/DataDriver.py b/src/DataDriver/DataDriver.py
index e42fe16..d9445a3 100644
--- a/src/DataDriver/DataDriver.py
+++ b/src/DataDriver/DataDriver.py
@@ -848,8 +848,10 @@ class DataDriver:
     File Encoding and CSV Dialect
     -----------------------------
 
-    CSV is far away from well designed and has absolutely no "common"
-    format. Therefore it is possible to define your own dialect or use
+    While there are various specifications and implementations for the CSV format
+    (see `RFC 4180 <https://www.rfc-editor.org/rfc/rfc4180.html>`_),
+    there is no formal specification in existence, which allows for a wide variety of interpretations of CSV files.
+    Therefore it is possible to define your own dialect or use
     predefined. The default is Excel-EU which is a semicolon separated
     file.
     These Settings are changeable as options of the Data Driver Library.