SeleniumLibrary/docs/SeleniumLibrary.html at master · robotframework/SeleniumLibrary

History

420 lines (418 loc) · 489 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

<!DOCTYPE html>

<head>

libdoc = {"specversion": 3, "name": "SeleniumLibrary", "doc": "<p>SeleniumLibrary is a web testing library for Robot Framework.</p>\n<p>This document explains how to use keywords provided by SeleniumLibrary. For information about installation, support, and more, please visit the <a href=\"https://github.com/robotframework/SeleniumLibrary\">project pages</a>. For more information about Robot Framework, see <a href=\"http://robotframework.org\">http://robotframework.org</a>.</p>\n<p>SeleniumLibrary uses the Selenium WebDriver modules internally to control a web browser. See <a href=\"http://seleniumhq.org\">http://seleniumhq.org</a> for more information about Selenium in general and SeleniumLibrary README.rst <a href=\"https://github.com/robotframework/SeleniumLibrary#browser-drivers\">Browser drivers chapter</a> for more details about WebDriver binary installation.</p>\n<ul>\n<li><a href=\"#Locating%20elements\" class=\"name\">Locating elements</a></li>\n<li><a href=\"#Browser%20and%20Window\" class=\"name\">Browser and Window</a></li>\n<li><a href=\"#Browser%20and%20Driver%20options%20and%20service%20class\" class=\"name\">Browser and Driver options and service class</a></li>\n<li><a href=\"#Timeouts%2C%20waits%2C%20and%20delays\" class=\"name\">Timeouts, waits, and delays</a></li>\n<li><a href=\"#Run-on-failure%20functionality\" class=\"name\">Run-on-failure functionality</a></li>\n<li><a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a></li>\n<li><a href=\"#EventFiringWebDriver\" class=\"name\">EventFiringWebDriver</a></li>\n<li><a href=\"#Thread%20support\" class=\"name\">Thread support</a></li>\n<li><a href=\"#Plugins\" class=\"name\">Plugins</a></li>\n<li><a href=\"#Language\" class=\"name\">Language</a></li>\n<li><a href=\"#Importing\" class=\"name\">Importing</a></li>\n<li><a href=\"#Keywords\" class=\"name\">Keywords</a></li>\n</ul>\n<h2 id=\"Locating elements\">Locating elements</h2>\n<p>All keywords in SeleniumLibrary that need to interact with an element on a web page take an argument typically named <code>locator</code> that specifies how to find the element. Most often the locator is given as a string using the locator syntax described below, but <a href=\"#Using%20WebElements\" class=\"name\">using WebElements</a> is possible too.</p>\n<h3 id=\"Locator syntax\">Locator syntax</h3>\n<p>SeleniumLibrary supports finding elements based on different strategies such as the element id, XPath expressions, or CSS selectors. The strategy can either be explicitly specified with a prefix or the strategy can be implicit.</p>\n<h4 id=\"Default locator strategy\">Default locator strategy</h4>\n<p>By default, locators are considered to use the keyword specific default locator strategy. All keywords support finding elements based on <code>id</code> and <code>name</code> attributes, but some keywords support additional attributes or other values that make sense in their context. For example, <a href=\"#Click%20Link\" class=\"name\">Click Link</a> supports the <code>href</code> attribute and the link text and addition to the normal <code>id</code> and <code>name</code>.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Click%20Element\" class=\"name\">Click Element</a></td>\n<td>example</td>\n<td># Match based on <code>id</code> or <code>name</code>.</td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Link\" class=\"name\">Click Link</a></td>\n<td>example</td>\n<td># Match also based on link text and <code>href</code>.</td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Button\" class=\"name\">Click Button</a></td>\n<td>example</td>\n<td># Match based on <code>id</code>, <code>name</code> or <code>value</code>.</td>\n</tr>\n</table>\n<p>If a locator accidentally starts with a prefix recognized as <a href=\"#Explicit%20locator%20strategy\" class=\"name\">explicit locator strategy</a> or <a href=\"#Implicit%20XPath%20strategy\" class=\"name\">implicit XPath strategy</a>, it is possible to use the explicit <code>default</code> prefix to enable the default strategy.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Click%20Element\" class=\"name\">Click Element</a></td>\n<td>name:foo</td>\n<td># Find element with name <code>foo</code>.</td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Element\" class=\"name\">Click Element</a></td>\n<td>default:name:foo</td>\n<td># Use default strategy with value <code>name:foo</code>.</td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Element\" class=\"name\">Click Element</a></td>\n<td>//foo</td>\n<td># Find element using XPath <code>//foo</code>.</td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Element\" class=\"name\">Click Element</a></td>\n<td>default: //foo</td>\n<td># Use default strategy with value <code>//foo</code>.</td>\n</tr>\n</table>\n<h4 id=\"Explicit locator strategy\">Explicit locator strategy</h4>\n<p>The explicit locator strategy is specified with a prefix using either syntax <code>strategy:value</code> or <code>strategy=value</code>. The former syntax is preferred because the latter is identical to Robot Framework's <a href=\"http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#named-argument-syntax\">named argument syntax</a> and that can cause problems. Spaces around the separator are ignored, so <code>id:foo</code>, <code>id: foo</code> and <code>id : foo</code> are all equivalent.</p>\n<p>Locator strategies that are supported by default are listed in the table below. In addition to them, it is possible to register <a href=\"#Custom%20locators\" class=\"name\">custom locators</a>.</p>\n<table border=\"1\">\n<tr>\n<th>Strategy</th>\n<th>Match based on</th>\n<th>Example</th>\n</tr>\n<tr>\n<td>id</td>\n<td>Element <code>id</code>.</td>\n<td><code>id:example</code></td>\n</tr>\n<tr>\n<td>name</td>\n<td><code>name</code> attribute.</td>\n<td><code>name:example</code></td>\n</tr>\n<tr>\n<td>identifier</td>\n<td>Either <code>id</code> or <code>name</code>.</td>\n<td><code>identifier:example</code></td>\n</tr>\n<tr>\n<td>class</td>\n<td>Element <code>class</code>.</td>\n<td><code>class:example</code></td>\n</tr>\n<tr>\n<td>tag</td>\n<td>Tag name.</td>\n<td><code>tag:div</code></td>\n</tr>\n<tr>\n<td>xpath</td>\n<td>XPath expression.</td>\n<td><code>xpath://div[@id=\"example\"]</code></td>\n</tr>\n<tr>\n<td>css</td>\n<td>CSS selector.</td>\n<td><code>css:div#example</code></td>\n</tr>\n<tr>\n<td>dom</td>\n<td>DOM expression.</td>\n<td><code>dom:document.images[5]</code></td>\n</tr>\n<tr>\n<td>link</td>\n<td>Exact text a link has.</td>\n<td><code>link:The example</code></td>\n</tr>\n<tr>\n<td>partial link</td>\n<td>Partial link text.</td>\n<td><code>partial link:he ex</code></td>\n</tr>\n<tr>\n<td>sizzle</td>\n<td>Sizzle selector deprecated.</td>\n<td><code>sizzle:div.example</code></td>\n</tr>\n<tr>\n<td>data</td>\n<td>Element <code>data-*</code> attribute</td>\n<td><code>data:id:my_id</code></td>\n</tr>\n<tr>\n<td>jquery</td>\n<td>jQuery expression.</td>\n<td><code>jquery:div.example</code></td>\n</tr>\n<tr>\n<td>default</td>\n<td>Keyword specific default behavior.</td>\n<td><code>default:example</code></td>\n</tr>\n</table>\n<p>See the <a href=\"#Default%20locator%20strategy\" class=\"name\">Default locator strategy</a> section below for more information about how the default strategy works. Using the explicit <code>default</code> prefix is only necessary if the locator value itself accidentally matches some of the explicit strategies.</p>\n<p>Different locator strategies have different pros and cons. Using ids, either explicitly like <code>id:foo</code> or by using the <a href=\"#Default%20locator%20strategy\" class=\"name\">default locator strategy</a> simply like <code>foo</code>, is recommended when possible, because the syntax is simple and locating elements by id is fast for browsers. If an element does not have an id or the id is not stable, other solutions need to be used. If an element has a unique tag name or class, using <code>tag</code>, <code>class</code> or <code>css</code> strategy like <code>tag:h1</code>, <code>class:example</code> or <code>css:h1.example</code> is often an easy solution. In more complex cases using XPath expressions is typically the best approach. They are very powerful but a downside is that they can also get complex.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Click%20Element\" class=\"name\">Click Element</a></td>\n<td>id:foo</td>\n<td># Element with id 'foo'.</td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Element\" class=\"name\">Click Element</a></td>\n<td>css:div#foo h1</td>\n<td># h1 element under div with id 'foo'.</td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Element\" class=\"name\">Click Element</a></td>\n<td>xpath: //div[@id=\"foo\"]//h1</td>\n<td># Same as the above using XPath, not CSS.</td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Element\" class=\"name\">Click Element</a></td>\n<td>xpath: //*[contains(text(), \"example\")]</td>\n<td># Element containing text 'example'.</td>\n</tr>\n</table>\n<p><b>NOTE:</b></p>\n<ul>\n<li>The <code>strategy:value</code> syntax is only supported by SeleniumLibrary 3.0 and newer.</li>\n<li>Using the <code>sizzle</code> strategy or its alias <code>jquery</code> requires that the system under test contains the jQuery library.</li>\n<li>Prior to SeleniumLibrary 3.0, table related keywords only supported <code>xpath</code>, <code>css</code> and <code>sizzle/jquery</code> strategies.</li>\n<li><code>data</code> strategy is conveniance locator that will construct xpath from the parameters. If you have element like <span class=\"name\"><div data-automation=\"automation-id-2\"></span>, you locate the element via <code>data:automation:automation-id-2</code>. This feature was added in SeleniumLibrary 5.2.0</li>\n</ul>\n<h4 id=\"Implicit XPath strategy\">Implicit XPath strategy</h4>\n<p>If the locator starts with <code>//</code> or multiple opening parenthesis in front of the <code>//</code>, the locator is considered to be an XPath expression. In other words, using <code>//div</code> is equivalent to using explicit <code>xpath://div</code> and <code>((//div))</code> is equivalent to using explicit <code>xpath:((//div))</code></p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Click%20Element\" class=\"name\">Click Element</a></td>\n<td>//div[@id=\"foo\"]//h1</td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Element\" class=\"name\">Click Element</a></td>\n<td>(//div)[2]</td>\n</tr>\n</table>\n<p>The support for the <code>(//</code> prefix is new in SeleniumLibrary 3.0. Supporting multiple opening parenthesis is new in SeleniumLibrary 5.0.</p>\n<h4 id=\"Chaining locators\">Chaining locators</h4>\n<p>It is possible chain multiple locators together as single locator. Each chained locator must start with locator strategy. Chained locators must be separated with single space, two greater than characters and followed with space. It is also possible mix different locator strategies, example css or xpath. Also a list can also be used to specify multiple locators. This is useful, is some part of locator would match as the locator separator but it should not. Or if there is need to existing WebElement as locator.</p>\n<p>Although all locators support chaining, some locator strategies do not abey the chaining. This is because some locator strategies use JavaScript to find elements and JavaScript is executed for the whole browser context and not for the element found be the previous locator. Chaining is supported by locator strategies which are based on Selenium API, like <span class=\"name\">xpath</span> or <span class=\"name\">css</span>, but example chaining is not supported by <span class=\"name\">sizzle</span> or `jquery</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Click%20Element\" class=\"name\">Click Element</a></td>\n<td>css:.bar >> <a href=\"xpath://a\">xpath://a</a></td>\n<td># To find a link which is present after an element with class \"bar\"</td>\n</tr>\n</table>\n<p>List examples:</p>\n<table border=\"1\">\n<tr>\n<td>${locator_list} =</td>\n<td><span class=\"name\">Create List</span></td>\n<td>css:div#div_id</td>\n<td><a href=\"xpath://*[text(\">xpath://*[text(</a>), \" >> \"]</td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a></td>\n<td>${locator_list}</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${element} =</td>\n<td>Get WebElement</td>\n<td><a href=\"xpath://*[text(\">xpath://*[text(</a>), \" >> \"]</td>\n<td></td>\n</tr>\n<tr>\n<td>${locator_list} =</td>\n<td><span class=\"name\">Create List</span></td>\n<td>css:div#div_id</td>\n<td>${element}</td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a></td>\n<td>${locator_list}</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Chaining locators in new in SeleniumLibrary 5.0</p>\n<h3 id=\"Using WebElements\">Using WebElements</h3>\n<p>In addition to specifying a locator as a string, it is possible to use Selenium's WebElement objects. This requires first getting a WebElement, for example, by using the <a href=\"#Get%20WebElement\" class=\"name\">Get WebElement</a> keyword.</p>\n<table border=\"1\">\n<tr>\n<td>${elem} =</td>\n<td><a href=\"#Get%20WebElement\" class=\"name\">Get WebElement</a></td>\n<td>id:example</td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Element\" class=\"name\">Click Element</a></td>\n<td>${elem}</td>\n<td></td>\n</tr>\n</table>\n<h3 id=\"Custom locators\">Custom locators</h3>\n<p>If more complex lookups are required than what is provided through the default locators, custom lookup strategies can be created. Using custom locators is a two part process. First, create a keyword that returns a WebElement that should be acted on:</p>\n<table border=\"1\">\n<tr>\n<td>Custom Locator Strategy</td>\n<td>[Arguments]</td>\n<td>${browser}</td>\n<td>${locator}</td>\n<td>${tag}</td>\n<td>${constraints}</td>\n</tr>\n<tr>\n<td></td>\n<td>${element}=</td>\n<td>Execute Javascript</td>\n<td>return window.document.getElementById('${locator}');</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td></td>\n<td>RETURN</td>\n<td>${element}</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>This keyword is a reimplementation of the basic functionality of the <code>id</code> locator where <code>${browser}</code> is a reference to a WebDriver instance and <code>${locator}</code> is the name of the locator strategy. To use this locator, it must first be registered by using the <a href=\"#Add%20Location%20Strategy\" class=\"name\">Add Location Strategy</a> keyword:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Add%20Location%20Strategy\" class=\"name\">Add Location Strategy</a></td>\n<td>custom</td>\n<td>Custom Locator Strategy</td>\n</tr>\n</table>\n<p>The first argument of <a href=\"#Add%20Location%20Strategy\" class=\"name\">Add Location Strategy</a> specifies the name of the strategy and it must be unique. After registering the strategy, the usage is the same as with other locators:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Click%20Element\" class=\"name\">Click Element</a></td>\n<td>custom:example</td>\n</tr>\n</table>\n<p>See the <a href=\"#Add%20Location%20Strategy\" class=\"name\">Add Location Strategy</a> keyword for more details.</p>\n<h2 id=\"Browser and Window\">Browser and Window</h2>\n<p>There is different conceptual meaning when SeleniumLibrary talks about windows or browsers. This chapter explains those differences.</p>\n<h3 id=\"Browser\">Browser</h3>\n<p>When <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> or <a href=\"#Create%20Webdriver\" class=\"name\">Create WebDriver</a> keyword is called, it will create a new Selenium WebDriver instance by using the <a href=\"https://www.seleniumhq.org/docs/03_webdriver.jsp\">Selenium WebDriver</a> API. In SeleniumLibrary terms, a new browser is created. It is possible to start multiple independent browsers (Selenium Webdriver instances) at the same time, by calling <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> or <a href=\"#Create%20Webdriver\" class=\"name\">Create WebDriver</a> multiple times. These browsers are usually independent of each other and do not share data like cookies, sessions or profiles. Typically when the browser starts, it creates a single window which is shown to the user.</p>\n<h3 id=\"Window\">Window</h3>\n<p>Windows are the part of a browser that loads the web site and presents it to the user. All content of the site is the content of the window. Windows are children of a browser. In SeleniumLibrary browser is a synonym for WebDriver instance. One browser may have multiple windows. Windows can appear as tabs, as separate windows or pop-ups with different position and size. Windows belonging to the same browser typically share the sessions detail, like cookies. If there is a need to separate sessions detail, example login with two different users, two browsers (Selenium WebDriver instances) must be created. New windows can be opened example by the application under test or by example <a href=\"#Execute%20Javascript\" class=\"name\">Execute Javascript</a> keyword:</p>\n<pre>\n<a href=\"#Execute%20Javascript\" class=\"name\">Execute Javascript</a> window.open() # Opens a new window with location about:blank\n</pre>\n<p>The example below opens multiple browsers and windows, to demonstrate how the different keywords can be used to interact with browsers, and windows attached to these browsers.</p>\n<p>Structure:</p>\n<pre>\nBrowserA\n Window 1 (location=https://robotframework.org/)\n Window 2 (location=https://robocon.io/)\n Window 3 (location=https://github.com/robotframework/)\n\nBrowserB\n Window 1 (location=https://github.com/)\n</pre>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"https://robotframework.org\">https://robotframework.org</a></td>\n<td>${BROWSER}</td>\n<td>alias=BrowserA</td>\n<td># BrowserA with first window is opened.</td>\n</tr>\n<tr>\n<td><a href=\"#Execute%20Javascript\" class=\"name\">Execute Javascript</a></td>\n<td>window.open()</td>\n<td></td>\n<td></td>\n<td># In BrowserA second window is opened.</td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Window\" class=\"name\">Switch Window</a></td>\n<td>locator=NEW</td>\n<td></td>\n<td></td>\n<td># Switched to second window in BrowserA</td>\n</tr>\n<tr>\n<td><a href=\"#Go%20To\" class=\"name\">Go To</a></td>\n<td><a href=\"https://robocon.io\">https://robocon.io</a></td>\n<td></td>\n<td></td>\n<td># Second window navigates to robocon site.</td>\n</tr>\n<tr>\n<td><a href=\"#Execute%20Javascript\" class=\"name\">Execute Javascript</a></td>\n<td>window.open()</td>\n<td></td>\n<td></td>\n<td># In BrowserA third window is opened.</td>\n</tr>\n<tr>\n<td>${handle}</td>\n<td><a href=\"#Switch%20Window\" class=\"name\">Switch Window</a></td>\n<td>locator=NEW</td>\n<td></td>\n<td># Switched to third window in BrowserA</td>\n</tr>\n<tr>\n<td><a href=\"#Go%20To\" class=\"name\">Go To</a></td>\n<td><a href=\"https://github.com/robotframework/\">https://github.com/robotframework/</a></td>\n<td></td>\n<td></td>\n<td># Third windows goes to robot framework github site.</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"https://github.com\">https://github.com</a></td>\n<td>${BROWSER}</td>\n<td>alias=BrowserB</td>\n<td># BrowserB with first windows is opened.</td>\n</tr>\n<tr>\n<td>${location}</td>\n<td><a href=\"#Get%20Location\" class=\"name\">Get Location</a></td>\n<td></td>\n<td></td>\n<td># ${location} is: <a href=\"https://www.github.com\">https://www.github.com</a></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Window\" class=\"name\">Switch Window</a></td>\n<td>${handle}</td>\n<td>browser=BrowserA</td>\n<td></td>\n<td># BrowserA second windows is selected.</td>\n</tr>\n<tr>\n<td>${location}</td>\n<td><a href=\"#Get%20Location\" class=\"name\">Get Location</a></td>\n<td></td>\n<td></td>\n<td># ${location} = <a href=\"https://robocon.io/\">https://robocon.io/</a></td>\n</tr>\n<tr>\n<td>@{locations 1}</td>\n<td><a href=\"#Get%20Locations\" class=\"name\">Get Locations</a></td>\n<td></td>\n<td></td>\n<td># By default, lists locations under the currectly active browser (BrowserA).</td>\n</tr>\n<tr>\n<td>@{locations 2}</td>\n<td><a href=\"#Get%20Locations\" class=\"name\">Get Locations</a></td>\n<td>browser=ALL</td>\n<td></td>\n<td># By using browser=ALL argument keyword list all locations from all browsers.</td>\n</tr>\n</table>\n<p>The above example, @{locations 1} contains the following items: <a href=\"https://robotframework.org/\">https://robotframework.org/</a>, <a href=\"https://robocon.io/\">https://robocon.io/</a> and <a href=\"https://github.com/robotframework/\">https://github.com/robotframework/</a>'. The @{locations 2} contains the following items: <a href=\"https://robotframework.org/\">https://robotframework.org/</a>, <a href=\"https://robocon.io/\">https://robocon.io/</a>, <a href=\"https://github.com/robotframework/\">https://github.com/robotframework/</a>' and '<a href=\"https://github.com/\">https://github.com/</a>.</p>\n<h2 id=\"Browser and Driver options and service class\">Browser and Driver options and service class</h2>\n<p>This section talks about how to configure either the browser or the driver using the options and service arguments of the <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> keyword.</p>\n<h3 id=\"Configuring the browser using the Selenium Options\">Configuring the browser using the Selenium Options</h3>\n<p>As noted within the keyword documentation for <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a>, its <code>options</code> argument accepts Selenium options in two different formats: as a string and as Python object which is an instance of the Selenium options class.</p>\n<h4 id=\"Options string format\">Options string format</h4>\n<p>The string format allows defining Selenium options methods or attributes and their arguments in Robot Framework test data. The method and attributes names are case and space sensitive and must match to the Selenium options methods and attributes names. When defining a method, it must be defined in a similar way as in python: method name, opening parenthesis, zero to many arguments and closing parenthesis. If there is a need to define multiple arguments for a single method, arguments must be separated with comma, just like in Python. Example: <span class=\"name\">add_argument(\"--headless\")</span> or <span class=\"name\">add_experimental_option(\"key\", \"value\")</span>. Attributes are defined in a similar way as in Python: attribute name, equal sign, and attribute value. Example, <span class=\"name\">headless=True</span>. Multiple methods and attributes must be separated by a semicolon. Example: <span class=\"name\">add_argument(\"--headless\");add_argument(\"--start-maximized\")</span>.</p>\n<p>Arguments allow defining Python data types and arguments are evaluated by using Python <a href=\"https://docs.python.org/3/library/ast.html#ast.literal_eval\">ast.literal_eval</a>. Strings must be quoted with single or double quotes, example \"value\" or 'value'. It is also possible to define other Python builtin data types, example <span class=\"name\">True</span> or <a href=\"#type-None\" class=\"name\">None</a>, by not using quotes around the arguments.</p>\n<p>The string format is space friendly. Usually, spaces do not alter the defining methods or attributes. There are two exceptions. In some Robot Framework test data formats, two or more spaces are considered as cell separator and instead of defining a single argument, two or more arguments may be defined. Spaces in string arguments are not removed and are left as is. Example <span class=\"name\">add_argument ( \"--headless\" )</span> is same as <span class=\"name\">add_argument(\"--headless\")</span>. But <span class=\"name\">add_argument(\" --headless \")</span> is not same same as <span class=\"name\">add_argument ( \"--headless\" )</span>, because spaces inside of quotes are not removed. Please note that if options string contains backslash, example a Windows OS path, the backslash needs escaping both in Robot Framework data and in Python side. This means single backslash must be writen using four backslash characters. Example, Windows path: \"C:\\path\\to\\profile\" must be written as \"C:\\\\\\\\path\\\\\\to\\\\\\\\profile\". Another way to write backslash is use Python <a href=\"https://docs.python.org/3/reference/lexical_analysis.html#string-and-bytes-literals\">raw strings</a> and example write: r\"C:\\\\path\\\\to\\\\profile\".</p>\n<h4 id=\"Selenium Options as Python class\">Selenium Options as Python class</h4>\n<p>As last format, <code>options</code> argument also supports receiving the Selenium options as Python class instance. In this case, the instance is used as-is and the SeleniumLibrary will not convert the instance to other formats. For example, if the following code return value is saved to <span class=\"name\">${options}</span> variable in the Robot Framework data:</p>\n<pre>\noptions = webdriver.ChromeOptions()\noptions.add_argument('--disable-dev-shm-usage')\nreturn options\n</pre>\n<p>Then the <span class=\"name\">${options}</span> variable can be used as an argument to <code>options</code>.</p>\n<p>Example the <code>options</code> argument can be used to launch Chomium-based applications which utilize the <a href=\"https://bitbucket.org/chromiumembedded/cef/wiki/UsingChromeDriver\">Chromium Embedded Framework</a> . To launch Chromium-based application, use <code>options</code> to define <span class=\"name\">binary_location</span> attribute and use <span class=\"name\">add_argument</span> method to define <span class=\"name\">remote-debugging-port</span> port for the application. Once the browser is opened, the test can interact with the embedded web-content of the system under test.</p>\n<h3 id=\"Configuring the driver using the Service class\">Configuring the driver using the Service class</h3>\n<p>With the <code>service</code> argument, one can setup and configure the driver. For example one can set the driver location and/port or specify the command line arguments. There are several browser specific attributes related to logging as well. For the various Service Class attributes refer to <a href=\"https://www.selenium.dev/documentation/webdriver/drivers/service/\">the Selenium documentation</a> . Currently the <code>service</code> argument only accepts Selenium service in the string format.</p>\n<h4 id=\"Service string format\">Service string format</h4>\n<p>The string format allows for defining Selenium service attributes and their values in the <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> keyword. The attributes names are case and space sensitive and must match to the Selenium attributes names. Attributes are defined in a similar way as in Python: attribute name, equal sign, and attribute value. Example, <span class=\"name\">port=1234</span>. Multiple attributes must be separated by a semicolon. Example: <span class=\"name\">executable_path='/path/to/driver';port=1234</span>. Don't have duplicate attributes, like <span class=\"name\">service_args=['--append-log', '--readable-timestamp']; service_args=['--log-level=DEBUG']</span> as the second will override the first. Instead combine them as in <span class=\"name\">service_args=['--append-log', '--readable-timestamp', '--log-level=DEBUG']</span></p>\n<p>Arguments allow defining Python data types and arguments are evaluated by using Python. Strings must be quoted with single or double quotes, example \"value\" or 'value'</p>\n<h2 id=\"Timeouts, waits, and delays\">Timeouts, waits, and delays</h2>\n<p>This section discusses different ways how to wait for elements to appear on web pages and to slow down execution speed otherwise. It also explains the <a href=\"#Time%20format\" class=\"name\">time format</a> that can be used when setting various timeouts, waits, and delays.</p>\n<h3 id=\"Timeout\">Timeout</h3>\n<p>SeleniumLibrary contains various keywords that have an optional <code>timeout</code> argument that specifies how long these keywords should wait for certain events or actions. These keywords include, for example, <code>Wait ...</code> keywords and keywords related to alerts. Additionally <a href=\"#Execute%20Async%20Javascript\" class=\"name\">Execute Async Javascript</a>. Although it does not have <code>timeout</code>, argument, uses a timeout to define how long asynchronous JavaScript can run.</p>\n<p>The default timeout these keywords use can be set globally either by using the <a href=\"#Set%20Selenium%20Timeout\" class=\"name\">Set Selenium Timeout</a> keyword or with the <code>timeout</code> argument when <a href=\"#Importing\" class=\"name\">importing</a> the library. If no default timeout is set globally, the default is 5 seconds. If None is specified for the timeout argument in the keywords, the default is used. See <a href=\"#Time%20format\" class=\"name\">time format</a> below for supported timeout syntax.</p>\n<h3 id=\"Implicit wait\">Implicit wait</h3>\n<p>Implicit wait specifies the maximum time how long Selenium waits when searching for elements. It can be set by using the <a href=\"#Set%20Selenium%20Implicit%20Wait\" class=\"name\">Set Selenium Implicit Wait</a> keyword or with the <code>implicit_wait</code> argument when <a href=\"#Importing\" class=\"name\">importing</a> the library. See <a href=\"https://www.seleniumhq.org/docs/04_webdriver_advanced.jsp\">Selenium documentation</a> for more information about this functionality.</p>\n<p>See <a href=\"#Time%20format\" class=\"name\">time format</a> below for supported syntax.</p>\n<h3 id=\"Page load\">Page load</h3>\n<p>Page load timeout is the amount of time to wait for page load to complete until a timeout exception is raised.</p>\n<p>The default page load timeout can be set globally when <a href=\"#Importing\" class=\"name\">importing</a> the library with the <code>page_load_timeout</code> argument or by using the <a href=\"#Set%20Selenium%20Page%20Load%20Timeout\" class=\"name\">Set Selenium Page Load Timeout</a> keyword.</p>\n<p>See <a href=\"#Time%20format\" class=\"name\">time format</a> below for supported timeout syntax.</p>\n<p>Support for page load is new in SeleniumLibrary 6.1</p>\n<h3 id=\"Selenium speed\">Selenium speed</h3>\n<p>Selenium execution speed can be slowed down globally by using <a href=\"#Set%20Selenium%20Speed\" class=\"name\">Set Selenium speed</a> keyword. This functionality is designed to be used for demonstrating or debugging purposes. Using it to make sure that elements appear on a page is not a good idea. The above-explained timeouts and waits should be used instead.</p>\n<p>See <a href=\"#Time%20format\" class=\"name\">time format</a> below for supported syntax.</p>\n<h3 id=\"Time format\">Time format</h3>\n<p>All timeouts and waits can be given as numbers considered seconds (e.g. <code>0.5</code> or <code>42</code>) or in Robot Framework's time syntax (e.g. <code>1.5 seconds</code> or <code>1 min 30 s</code>). For more information about the time syntax see the <a href=\"http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#time-format\">Robot Framework User Guide</a>.</p>\n<h2 id=\"Run-on-failure functionality\">Run-on-failure functionality</h2>\n<p>SeleniumLibrary has a handy feature that it can automatically execute a keyword if any of its own keywords fails. By default, it uses the <a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a> keyword, but this can be changed either by using the <a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a> keyword or with the <code>run_on_failure</code> argument when <a href=\"#Importing\" class=\"name\">importing</a> the library. It is possible to use any keyword from any imported library or resource file.</p>\n<p>The run-on-failure functionality can be disabled by using a special value <code>NOTHING</code> or anything considered false (see <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a>) such as <code>NONE</code>.</p>\n<h2 id=\"Boolean arguments\">Boolean arguments</h2>\n<p>Starting from 5.0 SeleniumLibrary relies on Robot Framework to perform the boolean conversion based on keyword arguments <a href=\"https://docs.python.org/3/library/typing.html\">type hint</a>. More details in Robot Framework <a href=\"http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#supported-conversions\">user guide</a></p>\n<p>Please note SeleniumLibrary 3 and 4 did have own custom methods to covert arguments to boolean values.</p>\n<h2 id=\"EventFiringWebDriver\">EventFiringWebDriver</h2>\n<p>The SeleniumLibrary offers support for <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_support/selenium.webdriver.support.event_firing_webdriver.html#module-selenium.webdriver.support.event_firing_webdriver\">EventFiringWebDriver</a>. See the Selenium and SeleniumLibrary <a href=\"https://github.com/robotframework/SeleniumLibrary/blob/master/docs/extending/extending.rst#EventFiringWebDriver\">EventFiringWebDriver support</a> documentation for further details.</p>\n<p>EventFiringWebDriver is new in SeleniumLibrary 4.0</p>\n<h2 id=\"Thread support\">Thread support</h2>\n<p>SeleniumLibrary is not thread-safe. This is mainly due because the underlying <a href=\"https://github.com/SeleniumHQ/selenium/wiki/Frequently-Asked-Questions#q-is-webdriver-thread-safe\">Selenium tool is not thread-safe</a> within one browser/driver instance. Because of the limitation in the Selenium side, the keywords or the API provided by the SeleniumLibrary is not thread-safe.</p>\n<h2 id=\"Plugins\">Plugins</h2>\n<p>SeleniumLibrary offers plugins as a way to modify and add library keywords and modify some of the internal functionality without creating a new library or hacking the source code. See <a href=\"https://github.com/robotframework/SeleniumLibrary/blob/master/docs/extending/extending.rst#Plugins\">plugin API</a> documentation for further details.</p>\n<p>Plugin API is new SeleniumLibrary 4.0</p>\n<h2 id=\"Language\">Language</h2>\n<p>SeleniumLibrary offers the possibility to translate keyword names and documentation to new language. If language is defined, SeleniumLibrary will search from <a href=\"https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#module-search-path\">module search path</a> for Python packages starting with <span class=\"name\">robotframework-seleniumlibrary-translation</span> by using the <a href=\"https://packaging.python.org/en/latest/guides/creating-and-discovering-plugins/\">Python pluging API</a>. The Library is using naming convention to find Python plugins.</p>\n<p>The package must implement a single API call, <code>get_language</code> without any arguments. The method must return a dictionary containing two keys: <code>language</code> and <code>path</code>. The language key value defines which language the package contains. Also the value should match (case insensitive) the library <code>language</code> import parameter. The path parameter value should be full path to the translation file.</p>\n<h3 id=\"Translation file\">Translation file</h3>\n<p>The file name or extension is not important, but data must be in <a href=\"https://www.json.org/json-en.html\">json</a> format. The keys of json are the methods names, not the keyword names, which implements keywords. Value of key is json object which contains two keys: <code>name</code> and <code>doc</code>. The <code>name</code> key contains the keyword translated name and <span class=\"name\">doc</span> contains translated documentation. Providing doc and name are optional, example translation json file can only provide translations to keyword names or only to documentation. But it is always recommended to provide translation to both name and doc. Special key <code>__intro__</code> is for class level documentation and <code>__init__</code> is for init level documentation. These special values <code>name</code> can not be translated, instead <code>name</code> should be kept the same.</p>\n<h3 id=\"Generating template translation file\">Generating template translation file</h3>\n<p>Template translation file, with English language can be created by running: <span class=\"name\">rfselib translation /path/to/translation.json</span> command. Command does not provide translations to other languages, it only provides easy way to create full list keywords and their documentation in correct format. It is also possible to add keywords from library plugins by providing <span class=\"name\">--plugins</span> arguments to command. Example: <span class=\"name\">rfselib translation --plugins myplugin.SomePlugin /path/to/translation.json</span> The generated json file contains <span class=\"name\">sha256</span> key, which contains the sha256 sum of the library documentation. The sha256 sum is used by <span class=\"name\">rfselib translation --compare /path/to/translation.json</span> command, which compares the translation to the library and prints outs a table which tells if there are changes needed for the translation file.</p>\n<p>Example project for translation can be found from <a href=\"https://github.com/MarketSquare/robotframework-seleniumlibrary-translation-fi\">robotframework-seleniumlibrary-translation-fi</a> repository.</p>", "version": "6.8.0", "generated": "2025-10-04T13:28:12+00:00", "type": "LIBRARY", "scope": "GLOBAL", "docFormat": "HTML", "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/__init__.py", "lineno": 60, "tags": [], "inits": [{"name": "__init__", "args": [{"name": "timeout", "type": null, "defaultValue": "0:00:05", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout=0:00:05"}, {"name": "implicit_wait", "type": null, "defaultValue": "0:00:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "implicit_wait=0:00:00"}, {"name": "run_on_failure", "type": null, "defaultValue": "Capture Page Screenshot", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "run_on_failure=Capture Page Screenshot"}, {"name": "screenshot_root_directory", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "screenshot_root_directory: str | None = None"}, {"name": "plugins", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "plugins: str | None = None"}, {"name": "event_firing_webdriver", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "event_firing_webdriver: str | None = None"}, {"name": "page_load_timeout", "type": null, "defaultValue": "0:05:00", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page_load_timeout=0:05:00"}, {"name": "action_chain_delay", "type": null, "defaultValue": "0:00:00.250000", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action_chain_delay=0:00:00.250000"}, {"name": "language", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "language: str | None = None"}], "returnType": null, "doc": "<p>SeleniumLibrary can be imported with several optional arguments.</p>\n<ul>\n<li><code>timeout</code>: Default value for <span class=\"name\">timeouts</span> used with <code>Wait ...</code> keywords.</li>\n<li><code>implicit_wait</code>: Default value for <a href=\"#Implicit%20wait\" class=\"name\">implicit wait</a> used when locating elements.</li>\n<li><code>run_on_failure</code>: Default action for the <a href=\"#Run-on-failure%20functionality\" class=\"name\">run-on-failure functionality</a>.</li>\n<li><code>screenshot_root_directory</code>: Path to folder where possible screenshots are created or EMBED or BASE64. See <a href=\"#Set%20Screenshot%20Directory\" class=\"name\">Set Screenshot Directory</a> keyword for further details about EMBED and BASE64. If not given, the directory where the log file is written is used.</li>\n<li><code>plugins</code>: Allows extending the SeleniumLibrary with external Python classes.</li>\n<li><code>event_firing_webdriver</code>: Class for wrapping Selenium with <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_support/selenium.webdriver.support.event_firing_webdriver.html#module-selenium.webdriver.support.event_firing_webdriver\">EventFiringWebDriver</a></li>\n<li><code>page_load_timeout</code>: Default value to wait for page load to complete until a timeout exception is raised.</li>\n<li><code>action_chain_delay</code>: Default value for <span class=\"name\">ActionChains</span> delay to wait in between actions.</li>\n<li><code>language</code>: Defines language which is used to translate keyword names and documentation.</li>\n</ul>", "shortdoc": "SeleniumLibrary can be imported with several optional arguments.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/__init__.py", "lineno": 595}], "keywords": [{"name": "Add Cookie", "args": [{"name": "name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}, {"name": "path", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "path: str | None = None"}, {"name": "domain", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "domain: str | None = None"}, {"name": "secure", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "secure: bool | None = None"}, {"name": "expiry", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "expiry: str | None = None"}], "returnType": null, "doc": "<p>Adds a cookie to your current session.</p>\n<p><code>name</code> and <code>value</code> are required, <code>path</code>, <code>domain</code>, <code>secure</code> and <code>expiry</code> are optional. Expiry supports the same formats as the <a href=\"http://robotframework.org/robotframework/latest/libraries/DateTime.html\">DateTime</a> library or an epoch timestamp.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a></td>\n<td>foo</td>\n<td>bar</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a></td>\n<td>foo</td>\n<td>bar</td>\n<td>domain=example.com</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a></td>\n<td>foo</td>\n<td>bar</td>\n<td>expiry=2027-09-28 16:21:35</td>\n<td># Expiry as timestamp.</td>\n</tr>\n<tr>\n<td><a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a></td>\n<td>foo</td>\n<td>bar</td>\n<td>expiry=1822137695</td>\n<td># Expiry as epoch seconds.</td>\n</tr>\n</table>\n<p>Prior to SeleniumLibrary 3.0 setting expiry did not work.</p>", "shortdoc": "Adds a cookie to your current session.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/cookie.py", "lineno": 143}, {"name": "Add Location Strategy", "args": [{"name": "strategy_name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "strategy_name: str"}, {"name": "strategy_keyword", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "strategy_keyword: str"}, {"name": "persist", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "persist: bool = False"}], "returnType": null, "doc": "<p>Adds a custom location strategy.</p>\n<p>See <a href=\"#Custom%20locators\" class=\"name\">Custom locators</a> for information on how to create and use custom strategies. <a href=\"#Remove%20Location%20Strategy\" class=\"name\">Remove Location Strategy</a> can be used to remove a registered strategy.</p>\n<p>Location strategies are automatically removed after leaving the current scope by default. Setting <code>persist</code> to a true value (see <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a>) will cause the location strategy to stay registered throughout the life of the test.</p>", "shortdoc": "Adds a custom location strategy.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 1148}, {"name": "Alert Should Be Present", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "text: str = "}, {"name": "action", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "ACCEPT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action: str = ACCEPT"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": null, "doc": "<p>Verifies that an alert is present and by default, accepts it.</p>\n<p>Fails if no alert is present. If <code>text</code> is a non-empty string, then it is used to verify alert's message. The alert is accepted by default, but that behavior can be controlled by using the <code>action</code> argument same way as with <a href=\"#Handle%20Alert\" class=\"name\">Handle Alert</a>.</p>\n<p><code>timeout</code> specifies how long to wait for the alert to appear. If it is not given, the global default <a href=\"#Timeout\" class=\"name\">timeout</a> is used instead.</p>\n<p><code>action</code> and <code>timeout</code> arguments are new in SeleniumLibrary 3.0. In earlier versions, the alert was always accepted and a timeout was hardcoded to one second.</p>", "shortdoc": "Verifies that an alert is present and by default, accepts it.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/alert.py", "lineno": 52}, {"name": "Alert Should Not Be Present", "args": [{"name": "action", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "ACCEPT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action: str = ACCEPT"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": null, "doc": "<p>Verifies that no alert is present.</p>\n<p>If the alert actually exists, the <code>action</code> argument determines how it should be handled. By default, the alert is accepted, but it can be also dismissed or left open the same way as with the <a href=\"#Handle%20Alert\" class=\"name\">Handle Alert</a> keyword.</p>\n<p><code>timeout</code> specifies how long to wait for the alert to appear. By default, is not waited for the alert at all, but a custom time can be given if alert may be delayed. See the <a href=\"#Time%20format\" class=\"name\">time format</a> section for information about the syntax.</p>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Verifies that no alert is present.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/alert.py", "lineno": 79}, {"name": "Assign Id To Element", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "id", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "id: str"}], "returnType": null, "doc": "<p>Assigns a temporary <code>id</code> to the element specified by <code>locator</code>.</p>\n<p>This is mainly useful if the locator is complicated and/or slow XPath expression and it is needed multiple times. Identifier expires when the page is reloaded.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Assign%20Id%20To%20Element\" class=\"name\">Assign ID to Element</a></td>\n<td>//ul[@class='example' and ./li[contains(., 'Stuff')]]</td>\n<td>my id</td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a></td>\n<td>my id</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Assigns a temporary ``id`` to the element specified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 227}, {"name": "Capture Element Screenshot", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "filename", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "selenium-element-screenshot-{index}.png", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename: str = selenium-element-screenshot-{index}.png"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Captures a screenshot from the element identified by <code>locator</code> and embeds it into log file.</p>\n<p>See <a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a> for details about <code>filename</code> argument. See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>An absolute path to the created element screenshot is returned. If the <code>filename</code> equals to BASE64 (case insensitive), then the base64 string is returned in addition to the screenshot embedded to the log. See <code>Capture Page Screenshot</code> for more information.</p>\n<p>Support for capturing the screenshot from an element has limited support among browser vendors. Please check the browser vendor driver documentation does the browser support capturing a screenshot from an element.</p>\n<p>New in SeleniumLibrary 3.3. Support for EMBED is new in SeleniumLibrary 4.2. Support for BASE64 is new in SeleniumLibrary 6.8.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Capture%20Element%20Screenshot\" class=\"name\">Capture Element Screenshot</a></td>\n<td>id:image_id</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Capture%20Element%20Screenshot\" class=\"name\">Capture Element Screenshot</a></td>\n<td>id:image_id</td>\n<td>${OUTPUTDIR}/id_image_id-1.png</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Capture%20Element%20Screenshot\" class=\"name\">Capture Element Screenshot</a></td>\n<td>id:image_id</td>\n<td>EMBED</td>\n<td></td>\n</tr>\n<tr>\n<td>${ess}=</td>\n<td><a href=\"#Capture%20Element%20Screenshot\" class=\"name\">Capture Element Screenshot</a></td>\n<td>id:image_id</td>\n<td>BASE64</td>\n</tr>\n</table>", "shortdoc": "Captures a screenshot from the element identified by ``locator`` and embeds it into log file.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/screenshot.py", "lineno": 147}, {"name": "Capture Page Screenshot", "args": [{"name": "filename", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "selenium-screenshot-{index}.png", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename: str = selenium-screenshot-{index}.png"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Takes a screenshot of the current page and embeds it into a log file.</p>\n<p><code>filename</code> argument specifies the name of the file to write the screenshot into. The directory where screenshots are saved can be set when <a href=\"#Importing\" class=\"name\">importing</a> the library or by using the <a href=\"#Set%20Screenshot%20Directory\" class=\"name\">Set Screenshot Directory</a> keyword. If the directory is not configured, screenshots are saved to the same directory where Robot Framework's log file is written.</p>\n<p>If <code>filename</code> equals to EMBED (case insensitive), then screenshot is embedded as Base64 image to the log.html. In this case file is not created in the filesystem. If <code>filename</code> equals to BASE64 (case insensitive), then the base64 string is returned and the screenshot is embedded to the log. This allows one to reuse the image elsewhere in the report.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${ss}=</td>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n<td>BASE64</td>\n</tr>\n<tr>\n<td>Set Test Message</td>\n<td>*HTML*Test Success<p><img src=\"data:image/png;base64,${ss}\" width=\"256px\"></td>\n<td></td>\n</tr>\n</table>\n<p>Starting from SeleniumLibrary 1.8, if <code>filename</code> contains marker <code>{index}</code>, it will be automatically replaced with an unique running index, preventing files to be overwritten. Indices start from 1, and how they are represented can be customized using Python's <a href=\"https://docs.python.org/3/library/string.html#format-string-syntax\">format string syntax</a>.</p>\n<p>An absolute path to the created screenshot file is returned or if <code>filename</code> equals to EMBED, word <span class=\"name\">EMBED</span> is returned. If <code>filename</code> equals to BASE64, the base64 string containing the screenshot is returned.</p>\n<p>Support for BASE64 is new in SeleniumLibrary 6.8</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Exist</span></td>\n<td>${OUTPUTDIR}/selenium-screenshot-1.png</td>\n</tr>\n<tr>\n<td>${path} =</td>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Exist</span></td>\n<td>${OUTPUTDIR}/selenium-screenshot-2.png</td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Exist</span></td>\n<td>${path}</td>\n</tr>\n<tr>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n<td>custom_name.png</td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Exist</span></td>\n<td>${OUTPUTDIR}/custom_name.png</td>\n</tr>\n<tr>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n<td>custom_with_index_{index}.png</td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Exist</span></td>\n<td>${OUTPUTDIR}/custom_with_index_1.png</td>\n</tr>\n<tr>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n<td>formatted_index_{index:03}.png</td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Exist</span></td>\n<td>${OUTPUTDIR}/formatted_index_001.png</td>\n</tr>\n<tr>\n<td><a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a></td>\n<td>EMBED</td>\n</tr>\n<tr>\n<td><span class=\"name\">File Should Not Exist</span></td>\n<td>EMBED</td>\n</tr>\n</table>", "shortdoc": "Takes a screenshot of the current page and embeds it into a log file.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/screenshot.py", "lineno": 74}, {"name": "Checkbox Should Be Selected", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Verifies checkbox <code>locator</code> is selected/checked.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Verifies checkbox ``locator`` is selected/checked.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 44}, {"name": "Checkbox Should Not Be Selected", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Verifies checkbox <code>locator</code> is not selected/checked.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Verifies checkbox ``locator`` is not selected/checked.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 58}, {"name": "Choose File", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "file_path", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "file_path: str"}], "returnType": null, "doc": "<p>Inputs the <code>file_path</code> into the file input field <code>locator</code>.</p>\n<p>This keyword is most often used to input files into upload forms. The keyword does not check <code>file_path</code> is the file or folder available on the machine where tests are executed. If the <code>file_path</code> points at a file and when using Selenium Grid, Selenium will <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_remote/selenium.webdriver.remote.command.html?highlight=upload#selenium.webdriver.remote.command.Command.UPLOAD_FILE\">magically</a>, transfer the file from the machine where the tests are executed to the Selenium Grid node where the browser is running. Then Selenium will send the file path, from the nodes file system, to the browser.</p>\n<p>That <code>file_path</code> is not checked, is new in SeleniumLibrary 4.0.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Choose%20File\" class=\"name\">Choose File</a></td>\n<td>my_upload_field</td>\n<td>${CURDIR}/trades.csv</td>\n</tr>\n</table>", "shortdoc": "Inputs the ``file_path`` into the file input field ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 216}, {"name": "Clear Element Text", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Clears the value of the text-input-element identified by <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Clears the value of the text-input-element identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 561}, {"name": "Click Button", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "modifier", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "modifier: bool | str = False"}], "returnType": null, "doc": "<p>Clicks the button identified by <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax. When using the default locator strategy, buttons are searched using <code>id</code>, <code>name</code>, and <code>value</code>.</p>\n<p>See the <a href=\"#Click%20Element\" class=\"name\">Click Element</a> keyword for details about the <code>modifier</code> argument.</p>\n<p>The <code>modifier</code> argument is new in SeleniumLibrary 3.3</p>", "shortdoc": "Clicks the button identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 584}, {"name": "Click Element", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "modifier", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "modifier: bool | str = False"}, {"name": "action_chain", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action_chain: bool = False"}], "returnType": null, "doc": "<p>Click the element identified by <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>The <code>modifier</code> argument can be used to pass <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html#selenium.webdriver.common.keys.Keys\">Selenium Keys</a> when clicking the element. The <span class=\"name\">+</span> can be used as a separator for different Selenium Keys. The <span class=\"name\">CTRL</span> is internally translated to the <span class=\"name\">CONTROL</span> key. The <code>modifier</code> is space and case insensitive, example \"alt\" and \" aLt \" are supported formats to <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html#selenium.webdriver.common.keys.Keys.ALT\">ALT key</a> . If <code>modifier</code> does not match to Selenium Keys, keyword fails.</p>\n<p>If <code>action_chain</code> argument is true, see <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a> for more details on how to set boolean argument, then keyword uses ActionChain based click instead of the <web_element>.click() function. If both <code>action_chain</code> and <code>modifier</code> are defined, the click will be performed using <code>modifier</code> and <code>action_chain</code> will be ignored.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>Click Element</td>\n<td>id:button</td>\n<td></td>\n<td># Would click element without any modifiers.</td>\n</tr>\n<tr>\n<td>Click Element</td>\n<td>id:button</td>\n<td>CTRL</td>\n<td># Would click element with CTLR key pressed down.</td>\n</tr>\n<tr>\n<td>Click Element</td>\n<td>id:button</td>\n<td>CTRL+ALT</td>\n<td># Would click element with CTLR and ALT keys pressed down.</td>\n</tr>\n<tr>\n<td>Click Element</td>\n<td>id:button</td>\n<td>action_chain=True</td>\n<td># Clicks the button using an Selenium ActionChains</td>\n</tr>\n</table>\n<p>The <code>modifier</code> argument is new in SeleniumLibrary 3.2 The <code>action_chain</code> argument is new in SeleniumLibrary 4.1</p>", "shortdoc": "Click the element identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 654}, {"name": "Click Element At Coordinates", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "xoffset", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xoffset: int"}, {"name": "yoffset", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "yoffset: int"}], "returnType": null, "doc": "<p>Click the element <code>locator</code> at <code>xoffset/yoffset</code>.</p>\n<p>The Cursor is moved and the center of the element and x/y coordinates are calculated from that point.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Click the element ``locator`` at ``xoffset/yoffset``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 722}, {"name": "Click Image", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "modifier", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "modifier: bool | str = False"}], "returnType": null, "doc": "<p>Clicks an image identified by <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax. When using the default locator strategy, images are searched using <code>id</code>, <code>name</code>, <code>src</code> and <code>alt</code>.</p>\n<p>See the <a href=\"#Click%20Element\" class=\"name\">Click Element</a> keyword for details about the <code>modifier</code> argument.</p>\n<p>The <code>modifier</code> argument is new in SeleniumLibrary 3.3</p>", "shortdoc": "Clicks an image identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 608}, {"name": "Click Link", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "modifier", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "modifier: bool | str = False"}], "returnType": null, "doc": "<p>Clicks a link identified by <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax. When using the default locator strategy, links are searched using <code>id</code>, <code>name</code>, <code>href</code> and the link text.</p>\n<p>See the <a href=\"#Click%20Element\" class=\"name\">Click Element</a> keyword for details about the <code>modifier</code> argument.</p>\n<p>The <code>modifier</code> argument is new in SeleniumLibrary 3.3</p>", "shortdoc": "Clicks a link identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 633}, {"name": "Close All Browsers", "args": [], "returnType": null, "doc": "<p>Closes all open browsers and resets the browser cache.</p>\n<p>After this keyword, new indexes returned from <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> keyword are reset to 1.</p>\n<p>This keyword should be used in test or suite teardown to make sure all browsers are closed.</p>", "shortdoc": "Closes all open browsers and resets the browser cache.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 40}, {"name": "Close Browser", "args": [], "returnType": null, "doc": "<p>Closes the current browser.</p>", "shortdoc": "Closes the current browser.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 53}, {"name": "Close Window", "args": [], "returnType": null, "doc": "<p>Closes currently opened and selected browser window/tab.</p>", "shortdoc": "Closes currently opened and selected browser window/tab.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/window.py", "lineno": 125}, {"name": "Cover Element", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Will cover elements identified by <code>locator</code> with a blue div without breaking page layout.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>New in SeleniumLibrary 3.3.0</p>\n<p>Example: |<a href=\"#Cover%20Element\" class=\"name\">Cover Element</a> | css:div#container |</p>", "shortdoc": "Will cover elements identified by ``locator`` with a blue div without breaking page layout.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 511}, {"name": "Create Webdriver", "args": [{"name": "driver_name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "driver_name: str"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "kwargs", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "dict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "kwargs: dict | None = None"}, {"name": "init_kwargs", "type": null, "defaultValue": null, "kind": "VAR_NAMED", "required": false, "repr": "**init_kwargs"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Creates an instance of Selenium WebDriver.</p>\n<p>Like <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a>, but allows passing arguments to the created WebDriver instance directly. This keyword should only be used if the functionality provided by <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> is not adequate.</p>\n<p><code>driver_name</code> must be a WebDriver implementation name like Firefox, Chrome, Ie, Edge, Safari, or Remote.</p>\n<p>The initialized WebDriver can be configured either with a Python dictionary <code>kwargs</code> or by using keyword arguments <code>**init_kwargs</code>. These arguments are passed directly to WebDriver without any processing. See <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/api.html\">Selenium API documentation</a> for details about the supported arguments.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td># Use proxy with Firefox</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${proxy}=</td>\n<td><span class=\"name\">Evaluate</span></td>\n<td>selenium.webdriver.Proxy()</td>\n<td>modules=selenium, selenium.webdriver</td>\n</tr>\n<tr>\n<td>${proxy.http_proxy}=</td>\n<td><span class=\"name\">Set Variable</span></td>\n<td>localhost:8888</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Create%20Webdriver\" class=\"name\">Create Webdriver</a></td>\n<td>Firefox</td>\n<td>proxy=${proxy}</td>\n<td></td>\n</tr>\n</table>\n<p>Returns the index of this browser instance which can be used later to switch back to it. Index starts from 1 and is reset back to it when <a href=\"#Close%20All%20Browsers\" class=\"name\">Close All Browsers</a> keyword is used. See <a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a> for an example.</p>", "shortdoc": "Creates an instance of Selenium WebDriver.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 277}, {"name": "Current Frame Should Contain", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies that the current frame contains <code>text</code>.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about the <code>loglevel</code> argument.</p>\n<p>Prior to SeleniumLibrary 3.0 this keyword was named <span class=\"name\">Current Frame Contains</span>.</p>", "shortdoc": "Verifies that the current frame contains ``text``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/frames.py", "lineno": 53}, {"name": "Current Frame Should Not Contain", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies that the current frame does not contain <code>text</code>.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies that the current frame does not contain ``text``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/frames.py", "lineno": 70}, {"name": "Delete All Cookies", "args": [], "returnType": null, "doc": "<p>Deletes all cookies.</p>", "shortdoc": "Deletes all cookies.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/cookie.py", "lineno": 57}, {"name": "Delete Cookie", "args": [{"name": "name", "type": null, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name"}], "returnType": null, "doc": "<p>Deletes the cookie matching <code>name</code>.</p>\n<p>If the cookie is not found, nothing happens.</p>", "shortdoc": "Deletes the cookie matching ``name``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/cookie.py", "lineno": 62}, {"name": "Double Click Element", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Double clicks the element identified by <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Double clicks the element identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 744}, {"name": "Drag And Drop", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "target", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "target: WebElement | str"}], "returnType": null, "doc": "<p>Drags the element identified by <code>locator</code> into the <code>target</code> element.</p>\n<p>The <code>locator</code> argument is the locator of the dragged element and the <code>target</code> is the locator of the target. See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Drag%20And%20Drop\" class=\"name\">Drag And Drop</a></td>\n<td>css:div#element</td>\n<td>css:div.target</td>\n</tr>\n</table>", "shortdoc": "Drags the element identified by ``locator`` into the ``target`` element.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 780}, {"name": "Drag And Drop By Offset", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "xoffset", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "xoffset: int"}, {"name": "yoffset", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "yoffset: int"}], "returnType": null, "doc": "<p>Drags the element identified with <code>locator</code> by <code>xoffset/yoffset</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>The element will be moved by <code>xoffset</code> and <code>yoffset</code>, each of which is a negative or positive number specifying the offset.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Drag%20And%20Drop%20By%20Offset\" class=\"name\">Drag And Drop By Offset</a></td>\n<td>myElem</td>\n<td>50</td>\n<td>-35</td>\n<td># Move myElem 50px right and 35px down</td>\n</tr>\n</table>", "shortdoc": "Drags the element identified with ``locator`` by ``xoffset/yoffset``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 798}, {"name": "Element Attribute Value Should Be", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "attribute", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: str"}, {"name": "expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "None", "typedoc": "None", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: None | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Verifies element identified by <code>locator</code> contains expected attribute value.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>Example: <a href=\"#Element%20Attribute%20Value%20Should%20Be\" class=\"name\">Element Attribute Value Should Be</a> | css:img | href | value</p>\n<p>New in SeleniumLibrary 3.2.</p>", "shortdoc": "Verifies element identified by ``locator`` contains expected attribute value.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 451}, {"name": "Element Should Be Disabled", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Verifies that element identified by <code>locator</code> is disabled.</p>\n<p>This keyword considers also elements that are read-only to be disabled.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Verifies that element identified by ``locator`` is disabled.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 246}, {"name": "Element Should Be Enabled", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Verifies that element identified by <code>locator</code> is enabled.</p>\n<p>This keyword considers also elements that are read-only to be disabled.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Verifies that element identified by ``locator`` is enabled.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 259}, {"name": "Element Should Be Focused", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Verifies that element identified by <code>locator</code> is focused.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Verifies that element identified by ``locator`` is focused.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 272}, {"name": "Element Should Be Visible", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Verifies that the element identified by <code>locator</code> is visible.</p>\n<p>Herein, visible means that the element is logically visible, not optically visible in the current browser viewport. For example, an element that carries <code>display:none</code> is not logically visible, so using this keyword on that element would fail.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>", "shortdoc": "Verifies that the element identified by ``locator`` is visible.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 289}, {"name": "Element Should Contain", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "None", "typedoc": "None", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: None | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "ignore_case", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignore_case: bool = False"}], "returnType": null, "doc": "<p>Verifies that element <code>locator</code> contains text <code>expected</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>The <code>ignore_case</code> argument can be set to True to compare case insensitive, default is False. New in SeleniumLibrary 3.1.</p>\n<p><code>ignore_case</code> argument is new in SeleniumLibrary 3.1.</p>\n<p>Use <a href=\"#Element%20Text%20Should%20Be\" class=\"name\">Element Text Should Be</a> if you want to match the exact text, not a substring.</p>", "shortdoc": "Verifies that element ``locator`` contains text ``expected``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 54}, {"name": "Element Should Not Be Visible", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Verifies that the element identified by <code>locator</code> is NOT visible.</p>\n<p>Passes if the element does not exists. See <a href=\"#Element%20Should%20Be%20Visible\" class=\"name\">Element Should Be Visible</a> for more information about visibility and supported arguments.</p>", "shortdoc": "Verifies that the element identified by ``locator`` is NOT visible.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 312}, {"name": "Element Should Not Contain", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "None", "typedoc": "None", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: None | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "ignore_case", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignore_case: bool = False"}], "returnType": null, "doc": "<p>Verifies that element <code>locator</code> does not contain text <code>expected</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>The <code>ignore_case</code> argument can be set to True to compare case insensitive, default is False.</p>\n<p><code>ignore_case</code> argument new in SeleniumLibrary 3.1.</p>", "shortdoc": "Verifies that element ``locator`` does not contain text ``expected``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 92}, {"name": "Element Text Should Be", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "None", "typedoc": "None", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: None | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "ignore_case", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignore_case: bool = False"}], "returnType": null, "doc": "<p>Verifies that element <code>locator</code> contains exact the text <code>expected</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>The <code>ignore_case</code> argument can be set to True to compare case insensitive, default is False.</p>\n<p><code>ignore_case</code> argument is new in SeleniumLibrary 3.1.</p>\n<p>Use <a href=\"#Element%20Should%20Contain\" class=\"name\">Element Should Contain</a> if a substring match is desired.</p>", "shortdoc": "Verifies that element ``locator`` contains exact the text ``expected``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 331}, {"name": "Element Text Should Not Be", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "not_expected", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "None", "typedoc": "None", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "not_expected: None | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "ignore_case", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignore_case: bool = False"}], "returnType": null, "doc": "<p>Verifies that element <code>locator</code> does not contain exact the text <code>not_expected</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>The <code>ignore_case</code> argument can be set to True to compare case insensitive, default is False.</p>\n<p>New in SeleniumLibrary 3.1.1</p>", "shortdoc": "Verifies that element ``locator`` does not contain exact the text ``not_expected``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 367}, {"name": "Execute Async Javascript", "args": [{"name": "code", "type": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*code: Any"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Executes asynchronous JavaScript code with possible arguments.</p>\n<p>Similar to <a href=\"#Execute%20Javascript\" class=\"name\">Execute Javascript</a> except that scripts executed with this keyword must explicitly signal they are finished by invoking the provided callback. This callback is always injected into the executed function as the last argument.</p>\n<p>Scripts must complete within the script timeout or this keyword will fail. See the <a href=\"#Timeout\" class=\"name\">Timeout</a> section for more information.</p>\n<p>Starting from SeleniumLibrary 3.2 it is possible to provide JavaScript <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_remote/selenium.webdriver.remote.webdriver.html#selenium.webdriver.remote.webdriver.WebDriver.execute_async_script\">arguments</a> as part of <code>code</code> argument. See <a href=\"#Execute%20Javascript\" class=\"name\">Execute Javascript</a> for more details.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Execute%20Async%20Javascript\" class=\"name\">Execute Async JavaScript</a></td>\n<td>var callback = arguments[arguments.length - 1]; window.setTimeout(callback, 2000);</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Execute%20Async%20Javascript\" class=\"name\">Execute Async JavaScript</a></td>\n<td>${CURDIR}/async_js_to_execute.js</td>\n<td></td>\n</tr>\n<tr>\n<td>${result} =</td>\n<td><a href=\"#Execute%20Async%20Javascript\" class=\"name\">Execute Async JavaScript</a></td>\n<td></td>\n</tr>\n<tr>\n<td>...</td>\n<td>var callback = arguments[arguments.length - 1];</td>\n<td></td>\n</tr>\n<tr>\n<td>...</td>\n<td>function answer(){callback(\"text\");};</td>\n<td></td>\n</tr>\n<tr>\n<td>...</td>\n<td>window.setTimeout(answer, 2000);</td>\n<td></td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${result}</td>\n<td>text</td>\n</tr>\n</table>", "shortdoc": "Executes asynchronous JavaScript code with possible arguments.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/javascript.py", "lineno": 76}, {"name": "Execute Javascript", "args": [{"name": "code", "type": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*code: Any"}], "returnType": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "doc": "<p>Executes the given JavaScript code with possible arguments.</p>\n<p><code>code</code> may be divided into multiple cells in the test data and <code>code</code> may contain multiple lines of code and arguments. In that case, the JavaScript code parts are concatenated together without adding spaces and optional arguments are separated from <code>code</code>.</p>\n<p>If <code>code</code> is a path to an existing file, the JavaScript to execute will be read from that file. Forward slashes work as a path separator on all operating systems.</p>\n<p>The JavaScript executes in the context of the currently selected frame or window as the body of an anonymous function. Use <code>window</code> to refer to the window of your application and <code>document</code> to refer to the document object of the current frame or window, e.g. <code>document.getElementById('example')</code>.</p>\n<p>This keyword returns whatever the executed JavaScript code returns. Return values are converted to the appropriate Python types.</p>\n<p>Starting from SeleniumLibrary 3.2 it is possible to provide JavaScript <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_remote/selenium.webdriver.remote.webdriver.html#selenium.webdriver.remote.webdriver.WebDriver.execute_script\">arguments</a> as part of <code>code</code> argument. The JavaScript code and arguments must be separated with <span class=\"name\">JAVASCRIPT</span> and <span class=\"name\">ARGUMENTS</span> markers and must be used exactly with this format. If the Javascript code is first, then the <span class=\"name\">JAVASCRIPT</span> marker is optional. The order of <span class=\"name\">JAVASCRIPT</span> and <span class=\"name\">ARGUMENTS</span> markers can be swapped, but if <span class=\"name\">ARGUMENTS</span> is the first marker, then <span class=\"name\">JAVASCRIPT</span> marker is mandatory. It is only allowed to use <span class=\"name\">JAVASCRIPT</span> and <span class=\"name\">ARGUMENTS</span> markers only one time in the <code>code</code> argument.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Execute%20Javascript\" class=\"name\">Execute JavaScript</a></td>\n<td>window.myFunc('arg1', 'arg2')</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Execute%20Javascript\" class=\"name\">Execute JavaScript</a></td>\n<td>${CURDIR}/js_to_execute.js</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Execute%20Javascript\" class=\"name\">Execute JavaScript</a></td>\n<td>alert(arguments[0]);</td>\n<td>ARGUMENTS</td>\n<td>123</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Execute%20Javascript\" class=\"name\">Execute JavaScript</a></td>\n<td>ARGUMENTS</td>\n<td>123</td>\n<td>JAVASCRIPT</td>\n<td>alert(arguments[0]);</td>\n</tr>\n</table>", "shortdoc": "Executes the given JavaScript code with possible arguments.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/javascript.py", "lineno": 33}, {"name": "Frame Should Contain", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies that frame identified by <code>locator</code> contains <code>text</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies that frame identified by ``locator`` contains ``text``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/frames.py", "lineno": 84}, {"name": "Get Action Chain Delay", "args": [], "returnType": null, "doc": "<p>Gets the currently stored value for chain_delay_value in timestr format.</p>", "shortdoc": "Gets the currently stored value for chain_delay_value in timestr format.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 656}, {"name": "Get All Links", "args": [], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns a list containing ids of all links found in current page.</p>\n<p>If a link has no id, an empty string will be in the list instead.</p>", "shortdoc": "Returns a list containing ids of all links found in current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 1027}, {"name": "Get Browser Aliases", "args": [], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns aliases of all active browser that has an alias as NormalizedDict. The dictionary contains the aliases as keys and the index as value. This can be accessed as dictionary <code>${aliases.key}</code> or as list <code>@{aliases}[0]</code>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"https://example.com\">https://example.com</a></td>\n<td>alias=BrowserA</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"https://example.com\">https://example.com</a></td>\n<td>alias=BrowserB</td>\n<td></td>\n</tr>\n<tr>\n<td>&{aliases}</td>\n<td><a href=\"#Get%20Browser%20Aliases\" class=\"name\">Get Browser Aliases</a></td>\n<td></td>\n<td># &{aliases} = { BrowserA=1|BrowserB=2 }</td>\n</tr>\n<tr>\n<td><span class=\"name\">Log</span></td>\n<td>${aliases.BrowserA}</td>\n<td></td>\n<td># logs <code>1</code></td>\n</tr>\n<tr>\n<td>FOR</td>\n<td>${alias}</td>\n<td>IN</td>\n<td>@{aliases}</td>\n</tr>\n<tr>\n<td></td>\n<td><span class=\"name\">Log</span></td>\n<td>${alias}</td>\n<td># logs <code>BrowserA</code> and <code>BrowserB</code></td>\n</tr>\n<tr>\n<td>END</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>See <a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a> for more information and examples.</p>\n<p>New in SeleniumLibrary 4.0</p>", "shortdoc": "Returns aliases of all active browser that has an alias as NormalizedDict. The dictionary contains the aliases as keys and the index as value. This can be accessed as dictionary ``${aliases.key}`` or as list ``@{aliases}[0]``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 388}, {"name": "Get Browser Ids", "args": [], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns index of all active browser as list.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>@{browser_ids}=</td>\n<td>Get Browser Ids</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>FOR</td>\n<td>${id}</td>\n<td>IN</td>\n<td>@{browser_ids}</td>\n</tr>\n<tr>\n<td></td>\n<td>@{window_titles}=</td>\n<td>Get Window Titles</td>\n<td>browser=${id}</td>\n</tr>\n<tr>\n<td></td>\n<td>Log</td>\n<td>Browser ${id} has these windows: ${window_titles}</td>\n<td></td>\n</tr>\n<tr>\n<td>END</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>See <a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a> for more information and examples.</p>\n<p>New in SeleniumLibrary 4.0</p>", "shortdoc": "Returns index of all active browser as list.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 371}, {"name": "Get Cookie", "args": [{"name": "name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "name: str"}], "returnType": {"name": "CookieInformation", "typedoc": null, "nested": [], "union": false}, "doc": "<p>Returns information of cookie with <code>name</code> as an object.</p>\n<p>If no cookie is found with <code>name</code>, keyword fails. The cookie object contains details about the cookie. Attributes available in the object are documented in the table below.</p>\n<table border=\"1\">\n<tr>\n<th>Attribute</th>\n<th>Explanation</th>\n</tr>\n<tr>\n<td>name</td>\n<td>The name of a cookie.</td>\n</tr>\n<tr>\n<td>value</td>\n<td>Value of the cookie.</td>\n</tr>\n<tr>\n<td>path</td>\n<td>Indicates a URL path, for example <code>/</code>.</td>\n</tr>\n<tr>\n<td>domain</td>\n<td>The domain, the cookie is visible to.</td>\n</tr>\n<tr>\n<td>secure</td>\n<td>When true, the cookie is only used with HTTPS connections.</td>\n</tr>\n<tr>\n<td>httpOnly</td>\n<td>When true, the cookie is not accessible via JavaScript.</td>\n</tr>\n<tr>\n<td>expiry</td>\n<td>Python datetime object indicating when the cookie expires.</td>\n</tr>\n<tr>\n<td>extra</td>\n<td>Possible attributes outside of the WebDriver specification</td>\n</tr>\n</table>\n<p>See the <a href=\"https://w3c.github.io/webdriver/#cookies\">WebDriver specification</a> for details about the cookie information. Notice that <code>expiry</code> is specified as a <a href=\"https://docs.python.org/3/library/datetime.html#datetime.datetime\">datetime object</a>, not as seconds since Unix Epoch like WebDriver natively does.</p>\n<p>In some cases, example when running a browser in the cloud, it is possible that the cookie contains other attributes than is defined in the <a href=\"https://w3c.github.io/webdriver/#cookies\">WebDriver specification</a>. These other attributes are available in an <code>extra</code> attribute in the cookie object and it contains a dictionary of the other attributes. The <code>extra</code> attribute is new in SeleniumLibrary 4.0.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Add%20Cookie\" class=\"name\">Add Cookie</a></td>\n<td>foo</td>\n<td>bar</td>\n</tr>\n<tr>\n<td>${cookie} =</td>\n<td><a href=\"#Get%20Cookie\" class=\"name\">Get Cookie</a></td>\n<td>foo</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${cookie.name}</td>\n<td>foo</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be Equal</span></td>\n<td>${cookie.value}</td>\n<td>bar</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be True</span></td>\n<td>${cookie.expiry.year} > 2017</td>\n<td></td>\n</tr>\n</table>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Returns information of cookie with ``name`` as an object.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/cookie.py", "lineno": 97}, {"name": "Get Cookies", "args": [{"name": "as_dict", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "as_dict: bool = False"}], "returnType": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "dict", "typedoc": "dictionary", "nested": [], "union": false}], "union": true}, "doc": "<p>Returns all cookies of the current page.</p>\n<p>If <code>as_dict</code> argument evaluates as false, see <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a> for more details, then cookie information is returned as a single string in format <code>name1=value1; name2=value2; name3=value3</code>. When <code>as_dict</code> argument evaluates as true, cookie information is returned as Robot Framework dictionary format. The string format can be used, for example, for logging purposes or in headers when sending HTTP requests. The dictionary format is helpful when the result can be passed to requests library's Create Session keyword's optional cookies parameter.</p>\n<p>The <span class=\"name\">` as_dict</span>` argument is new in SeleniumLibrary 3.3</p>", "shortdoc": "Returns all cookies of the current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/cookie.py", "lineno": 70}, {"name": "Get Dom Attribute", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "attribute", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: str"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the value of <code>attribute</code> from the element <code>locator</code>. <a href=\"#Get%20Dom%20Attribute\" class=\"name\">Get DOM Attribute</a> keyword only returns attributes declared within the element's HTML markup. If the requested attribute is not there, the keyword returns ${None}.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${id}=</td>\n<td><a href=\"#Get%20Dom%20Attribute\" class=\"name\">Get DOM Attribute</a></td>\n<td>css:h1</td>\n<td>id</td>\n</tr>\n</table>", "shortdoc": "Returns the value of ``attribute`` from the element ``locator``. `Get DOM Attribute` keyword only returns attributes declared within the element's HTML markup. If the requested attribute is not there, the keyword returns ${None}.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 419}, {"name": "Get Element Attribute", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "attribute", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "attribute: str"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the value of <code>attribute</code> from the element <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${id}=</td>\n<td><a href=\"#Get%20Element%20Attribute\" class=\"name\">Get Element Attribute</a></td>\n<td>css:h1</td>\n<td>id</td>\n</tr>\n</table>\n<p>Passing attribute name as part of the <code>locator</code> was removed in SeleniumLibrary 3.2. The explicit <code>attribute</code> argument should be used instead.</p>", "shortdoc": "Returns the value of ``attribute`` from the element ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 401}, {"name": "Get Element Count", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "doc": "<p>Returns the number of elements matching <code>locator</code>.</p>\n<p>If you wish to assert the number of matching elements, use <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> with <code>limit</code> argument. Keyword will always return an integer.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${count} =</td>\n<td><a href=\"#Get%20Element%20Count\" class=\"name\">Get Element Count</a></td>\n<td>name:div_name</td>\n</tr>\n<tr>\n<td><span class=\"name\">Should Be True</span></td>\n<td>${count} > 2</td>\n<td></td>\n</tr>\n</table>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Returns the number of elements matching ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 1132}, {"name": "Get Element Size", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": {"name": "Tuple", "typedoc": "tuple", "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns width and height of the element identified by <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>Both width and height are returned as integers.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${width}</td>\n<td>${height} =</td>\n<td><a href=\"#Get%20Element%20Size\" class=\"name\">Get Element Size</a></td>\n<td>css:div#container</td>\n</tr>\n</table>", "shortdoc": "Returns width and height of the element identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 496}, {"name": "Get Horizontal Position", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "doc": "<p>Returns the horizontal position of the element identified by <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>The position is returned in pixels off the left side of the page, as an integer.</p>\n<p>See also <a href=\"#Get%20Vertical%20Position\" class=\"name\">Get Vertical Position</a>.</p>", "shortdoc": "Returns the horizontal position of the element identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 482}, {"name": "Get List Items", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "values", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "values: bool = False"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns all labels or values of selection list <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>Returns visible labels by default, but values can be returned by setting the <code>values</code> argument to a true value (see <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a>).</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${labels} =</td>\n<td><a href=\"#Get%20List%20Items\" class=\"name\">Get List Items</a></td>\n<td>mylist</td>\n<td></td>\n</tr>\n<tr>\n<td>${values} =</td>\n<td><a href=\"#Get%20List%20Items\" class=\"name\">Get List Items</a></td>\n<td>css:#example select</td>\n<td>values=True</td>\n</tr>\n</table>\n<p>Support to return values is new in SeleniumLibrary 3.0.</p>", "shortdoc": "Returns all labels or values of selection list ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/selectelement.py", "lineno": 27}, {"name": "Get Location", "args": [], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the current browser window URL.</p>", "shortdoc": "Returns the current browser window URL.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 427}, {"name": "Get Locations", "args": [{"name": "browser", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns and logs URLs of all windows of the selected browser.</p>\n<p><b>Browser Scope:</b></p>\n<p>The <code>browser</code> argument specifies the browser that shall return its windows information.</p>\n<ul>\n<li><code>browser</code> can be <code>index_or_alias</code> like in <a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a>.</li>\n</ul>\n<ul>\n<li>If <code>browser</code> is <code>CURRENT</code> (default, case-insensitive) the currently active browser is selected.</li>\n</ul>\n<ul>\n<li>If <code>browser</code> is <code>ALL</code> (case-insensitive) the window information of all windows of all opened browsers are returned.</li>\n</ul>", "shortdoc": "Returns and logs URLs of all windows of the selected browser.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/window.py", "lineno": 166}, {"name": "Get Property", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "property", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "property: str"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the value of <code>property</code> from the element <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${text_length}=</td>\n<td><a href=\"#Get%20Property\" class=\"name\">Get Property</a></td>\n<td>css:h1</td>\n<td>text_length</td>\n</tr>\n</table>", "shortdoc": "Returns the value of ``property`` from the element ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 436}, {"name": "Get Selected List Label", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the label of selected option from selection list <code>locator</code>.</p>\n<p>If there are multiple selected options, the label of the first option is returned.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Returns the label of selected option from selection list ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/selectelement.py", "lineno": 52}, {"name": "Get Selected List Labels", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns labels of selected options from selection list <code>locator</code>.</p>\n<p>Starting from SeleniumLibrary 3.0, returns an empty list if there are no selections. In earlier versions, this caused an error.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Returns labels of selected options from selection list ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/selectelement.py", "lineno": 65}, {"name": "Get Selected List Value", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the value of selected option from selection list <code>locator</code>.</p>\n<p>If there are multiple selected options, the value of the first option is returned.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Returns the value of selected option from selection list ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/selectelement.py", "lineno": 78}, {"name": "Get Selected List Values", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns values of selected options from selection list <code>locator</code>.</p>\n<p>Starting from SeleniumLibrary 3.0, returns an empty list if there are no selections. In earlier versions, this caused an error.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Returns values of selected options from selection list ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/selectelement.py", "lineno": 91}, {"name": "Get Selenium Implicit Wait", "args": [], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Gets the implicit wait value used by Selenium.</p>\n<p>The value is returned as a human-readable string like <code>1 second</code>.</p>\n<p>See the <a href=\"#Implicit%20wait\" class=\"name\">Implicit wait</a> section above for more information.</p>", "shortdoc": "Gets the implicit wait value used by Selenium.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 549}, {"name": "Get Selenium Page Load Timeout", "args": [], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Gets the time to wait for a page load to complete before raising a timeout exception.</p>\n<p>The value is returned as a human-readable string like <code>1 second</code>.</p>\n<p>See the <a href=\"#Page%20load\" class=\"name\">Page load</a> section above for more information.</p>\n<p>New in SeleniumLibrary 6.1</p>", "shortdoc": "Gets the time to wait for a page load to complete before raising a timeout exception.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 559}, {"name": "Get Selenium Speed", "args": [], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Gets the delay that is waited after each Selenium command.</p>\n<p>The value is returned as a human-readable string like <code>1 second</code>.</p>\n<p>See the <a href=\"#Selenium%20speed\" class=\"name\">Selenium Speed</a> section above for more information.</p>", "shortdoc": "Gets the delay that is waited after each Selenium command.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 529}, {"name": "Get Selenium Timeout", "args": [], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Gets the timeout that is used by various keywords.</p>\n<p>The value is returned as a human-readable string like <code>1 second</code>.</p>\n<p>See the <a href=\"#Timeout\" class=\"name\">Timeout</a> section above for more information.</p>", "shortdoc": "Gets the timeout that is used by various keywords.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 539}, {"name": "Get Session Id", "args": [], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the currently active browser session id.</p>\n<p>New in SeleniumLibrary 3.2</p>", "shortdoc": "Returns the currently active browser session id.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 409}, {"name": "Get Source", "args": [], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the entire HTML source of the current page or frame.</p>", "shortdoc": "Returns the entire HTML source of the current page or frame.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 417}, {"name": "Get Table Cell", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "row", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "row: int"}, {"name": "column", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "column: int"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns contents of a table cell.</p>\n<p>The table is located using the <code>locator</code> argument and its cell found using <code>row</code> and <code>column</code>. See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>Both row and column indexes start from 1, and header and footer rows are included in the count. It is possible to refer to rows and columns from the end by using negative indexes so that -1 is the last row/column, -2 is the second last, and so on.</p>\n<p>All <code><th></code> and <code><td></code> elements anywhere in the table are considered to be cells.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Returns contents of a table cell.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/tableelement.py", "lineno": 26}, {"name": "Get Text", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the text value of the element identified by <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Returns the text value of the element identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 552}, {"name": "Get Title", "args": [], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the title of the current page.</p>", "shortdoc": "Returns the title of the current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 422}, {"name": "Get Value", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Returns the value attribute of the element identified by <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Returns the value attribute of the element identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 543}, {"name": "Get Vertical Position", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "doc": "<p>Returns the vertical position of the element identified by <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>The position is returned in pixels off the top of the page, as an integer.</p>\n<p>See also <a href=\"#Get%20Horizontal%20Position\" class=\"name\">Get Horizontal Position</a>.</p>", "shortdoc": "Returns the vertical position of the element identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 570}, {"name": "Get WebElement", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": {"name": "WebElement", "typedoc": null, "nested": [], "union": false}, "doc": "<p>Returns the first WebElement matching the given <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Returns the first WebElement matching the given ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 32}, {"name": "Get WebElements", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}], "union": false}, "doc": "<p>Returns a list of WebElement objects matching the <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>Starting from SeleniumLibrary 3.0, the keyword returns an empty list if there are no matching elements. In previous releases, the keyword failed in this case.</p>", "shortdoc": "Returns a list of WebElement objects matching the ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 41}, {"name": "Get Window Handles", "args": [{"name": "browser", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns all child window handles of the selected browser as a list.</p>\n<p>Can be used as a list of windows to exclude with <span class=\"name\">Select Window</span>.</p>\n<p>How to select the <code>browser</code> scope of this keyword, see <a href=\"#Get%20Locations\" class=\"name\">Get Locations</a>.</p>\n<p>Prior to SeleniumLibrary 3.0, this keyword was named <span class=\"name\">List Windows</span>.</p>", "shortdoc": "Returns all child window handles of the selected browser as a list.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/window.py", "lineno": 130}, {"name": "Get Window Identifiers", "args": [{"name": "browser", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "returnType": {"name": "List", "typedoc": "list", "nested": [], "union": false}, "doc": "<p>Returns and logs id attributes of all windows of the selected browser.</p>\n<p>How to select the <code>browser</code> scope of this keyword, see <a href=\"#Get%20Locations\" class=\"name\">Get Locations</a>.</p>", "shortdoc": "Returns and logs id attributes of all windows of the selected browser.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/window.py", "lineno": 142}, {"name": "Get Window Names", "args": [{"name": "browser", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns and logs names of all windows of the selected browser.</p>\n<p>How to select the <code>browser</code> scope of this keyword, see <a href=\"#Get%20Locations\" class=\"name\">Get Locations</a>.</p>", "shortdoc": "Returns and logs names of all windows of the selected browser.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/window.py", "lineno": 150}, {"name": "Get Window Position", "args": [], "returnType": {"name": "Tuple", "typedoc": "tuple", "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns current window position.</p>\n<p>The position is relative to the top left corner of the screen. Returned values are integers. See also <a href=\"#Set%20Window%20Position\" class=\"name\">Set Window Position</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${x}</td>\n<td>${y}=</td>\n<td><a href=\"#Get%20Window%20Position\" class=\"name\">Get Window Position</a></td>\n</tr>\n</table>", "shortdoc": "Returns current window position.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/window.py", "lineno": 261}, {"name": "Get Window Size", "args": [{"name": "inner", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "inner: bool = False"}], "returnType": {"name": "Tuple", "typedoc": "tuple", "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns current window width and height as integers.</p>\n<p>See also <a href=\"#Set%20Window%20Size\" class=\"name\">Set Window Size</a>.</p>\n<p>If <code>inner</code> parameter is set to True, keyword returns HTML DOM window.innerWidth and window.innerHeight properties. See <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a> for more details on how to set boolean arguments. The <code>inner</code> is new in SeleniumLibrary 4.0.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${width}</td>\n<td>${height}=</td>\n<td><a href=\"#Get%20Window%20Size\" class=\"name\">Get Window Size</a></td>\n<td></td>\n</tr>\n<tr>\n<td>${width}</td>\n<td>${height}=</td>\n<td><a href=\"#Get%20Window%20Size\" class=\"name\">Get Window Size</a></td>\n<td>True</td>\n</tr>\n</table>", "shortdoc": "Returns current window width and height as integers.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/window.py", "lineno": 195}, {"name": "Get Window Titles", "args": [{"name": "browser", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "returnType": {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, "doc": "<p>Returns and logs titles of all windows of the selected browser.</p>\n<p>How to select the <code>browser</code> scope of this keyword, see <a href=\"#Get%20Locations\" class=\"name\">Get Locations</a>.</p>", "shortdoc": "Returns and logs titles of all windows of the selected browser.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/window.py", "lineno": 158}, {"name": "Go Back", "args": [], "returnType": null, "doc": "<p>Simulates the user clicking the back button on their browser.</p>", "shortdoc": "Simulates the user clicking the back button on their browser.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 513}, {"name": "Go To", "args": [{"name": "url", "type": null, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url"}], "returnType": null, "doc": "<p>Navigates the current browser window to the provided <code>url</code>.</p>", "shortdoc": "Navigates the current browser window to the provided ``url``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 518}, {"name": "Handle Alert", "args": [{"name": "action", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "ACCEPT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action: str = ACCEPT"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": null, "doc": "<p>Handles the current alert and returns its message.</p>\n<p>By default, the alert is accepted, but this can be controlled with the <code>action</code> argument that supports the following case-insensitive values:</p>\n<ul>\n<li><code>ACCEPT</code>: Accept the alert i.e. press <code>Ok</code>. Default.</li>\n<li><code>DISMISS</code>: Dismiss the alert i.e. press <code>Cancel</code>.</li>\n<li><code>LEAVE</code>: Leave the alert open.</li>\n</ul>\n<p>The <code>timeout</code> argument specifies how long to wait for the alert to appear. If it is not given, the global default <a href=\"#Timeout\" class=\"name\">timeout</a> is used instead.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td>Handle Alert</td>\n<td></td>\n<td></td>\n<td># Accept alert.</td>\n</tr>\n<tr>\n<td>Handle Alert</td>\n<td>action=DISMISS</td>\n<td></td>\n<td># Dismiss alert.</td>\n</tr>\n<tr>\n<td>Handle Alert</td>\n<td>timeout=10 s</td>\n<td></td>\n<td># Use custom timeout and accept alert.</td>\n</tr>\n<tr>\n<td>Handle Alert</td>\n<td>DISMISS</td>\n<td>1 min</td>\n<td># Use custom timeout and dismiss alert.</td>\n</tr>\n<tr>\n<td>${message} =</td>\n<td>Handle Alert</td>\n<td></td>\n<td># Accept alert and get its message.</td>\n</tr>\n<tr>\n<td>${message} =</td>\n<td>Handle Alert</td>\n<td>LEAVE</td>\n<td># Leave alert open and get its message.</td>\n</tr>\n</table>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Handles the current alert and returns its message.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/alert.py", "lineno": 104}, {"name": "Input Password", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "password", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "password: str"}, {"name": "clear", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clear: bool = True"}], "returnType": null, "doc": "<p>Types the given password into the text field identified by <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax. See <a href=\"#Input%20Text\" class=\"name\">Input Text</a> for <code>clear</code> argument details.</p>\n<p>Difference compared to <a href=\"#Input%20Text\" class=\"name\">Input Text</a> is that this keyword does not log the given password on the INFO level. Notice that if you use the keyword like</p>\n<table border=\"1\">\n<tr>\n<td>Input Password</td>\n<td>password_field</td>\n<td>password</td>\n</tr>\n</table>\n<p>the password is shown as a normal keyword argument. A way to avoid that is using variables like</p>\n<table border=\"1\">\n<tr>\n<td>Input Password</td>\n<td>password_field</td>\n<td>${PASSWORD}</td>\n</tr>\n</table>\n<p>Please notice that Robot Framework logs all arguments using the TRACE level and tests must not be executed using level below DEBUG if the password should not be logged in any format.</p>\n<p>The <span class=\"name\">clear</span> argument is new in SeleniumLibrary 4.0. Hiding password logging from Selenium logs is new in SeleniumLibrary 4.2.</p>", "shortdoc": "Types the given password into the text field identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 242}, {"name": "Input Text", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "clear", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "clear: bool = True"}], "returnType": null, "doc": "<p>Types the given <code>text</code> into the text field identified by <code>locator</code>.</p>\n<p>When <code>clear</code> is true, the input element is cleared before the text is typed into the element. When false, the previous text is not cleared from the element. Use <a href=\"#Input%20Password\" class=\"name\">Input Password</a> if you do not want the given <code>text</code> to be logged.</p>\n<p>If <a href=\"https://github.com/SeleniumHQ/selenium/wiki/Grid2\">Selenium Grid</a> is used and the <code>text</code> argument points to a file in the file system, then this keyword prevents the Selenium to transfer the file to the Selenium Grid hub. Instead, this keyword will send the <code>text</code> string as is to the element. If a file should be transferred to the hub and upload should be performed, please use <a href=\"#Choose%20File\" class=\"name\">Choose File</a> keyword.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax. See the <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a> section how Boolean values are handled.</p>\n<p>Disabling the file upload the Selenium Grid node and the <span class=\"name\">clear</span> argument are new in SeleniumLibrary 4.0</p>", "shortdoc": "Types the given ``text`` into the text field identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 272}, {"name": "Input Text Into Alert", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "action", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "ACCEPT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "action: str = ACCEPT"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}], "returnType": null, "doc": "<p>Types the given <code>text</code> into an input field in an alert.</p>\n<p>The alert is accepted by default, but that behavior can be controlled by using the <code>action</code> argument same way as with <a href=\"#Handle%20Alert\" class=\"name\">Handle Alert</a>.</p>\n<p><code>timeout</code> specifies how long to wait for the alert to appear. If it is not given, the global default <a href=\"#Timeout\" class=\"name\">timeout</a> is used instead.</p>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Types the given ``text`` into an input field in an alert.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/alert.py", "lineno": 34}, {"name": "List Selection Should Be", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*expected: str"}], "returnType": null, "doc": "<p>Verifies selection list <code>locator</code> has <code>expected</code> options selected.</p>\n<p>It is possible to give expected options both as visible labels and as values. Starting from SeleniumLibrary 3.0, mixing labels and values is not possible. Order of the selected options is not validated.</p>\n<p>If no expected options are given, validates that the list has no selections. A more explicit alternative is using <a href=\"#List%20Should%20Have%20No%20Selections\" class=\"name\">List Should Have No Selections</a>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#List%20Selection%20Should%20Be\" class=\"name\">List Selection Should Be</a></td>\n<td>gender</td>\n<td>Female</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#List%20Selection%20Should%20Be\" class=\"name\">List Selection Should Be</a></td>\n<td>interests</td>\n<td>Test Automation</td>\n<td>Python</td>\n</tr>\n</table>", "shortdoc": "Verifies selection list ``locator`` has ``expected`` options selected.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/selectelement.py", "lineno": 104}, {"name": "List Should Have No Selections", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Verifies selection list <code>locator</code> has no options selected.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Verifies selection list ``locator`` has no options selected.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/selectelement.py", "lineno": 141}, {"name": "Location Should Be", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Verifies that the current URL is exactly <code>url</code>.</p>\n<p>The <code>url</code> argument contains the exact url that should exist in browser.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p><code>message</code> argument is new in SeleniumLibrary 3.2.0.</p>", "shortdoc": "Verifies that the current URL is exactly ``url``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 432}, {"name": "Location Should Contain", "args": [{"name": "expected", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Verifies that the current URL contains <code>expected</code>.</p>\n<p>The <code>expected</code> argument contains the expected value in url.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p><code>message</code> argument is new in SeleniumLibrary 3.2.0.</p>", "shortdoc": "Verifies that the current URL contains ``expected``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 450}, {"name": "Log Location", "args": [], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Logs and returns the current browser window URL.</p>", "shortdoc": "Logs and returns the current browser window URL.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 471}, {"name": "Log Source", "args": [{"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "INFO", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = INFO"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Logs and returns the HTML source of the current page or frame.</p>\n<p>The <code>loglevel</code> argument defines the used log level. Valid log levels are <code>WARN</code>, <code>INFO</code> (default), <code>DEBUG</code>, <code>TRACE</code> and <code>NONE</code> (no logging).</p>", "shortdoc": "Logs and returns the HTML source of the current page or frame.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 478}, {"name": "Log Title", "args": [], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Logs and returns the title of the current page.</p>", "shortdoc": "Logs and returns the title of the current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 490}, {"name": "Maximize Browser Window", "args": [], "returnType": null, "doc": "<p>Maximizes current browser window.</p>", "shortdoc": "Maximizes current browser window.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/window.py", "lineno": 185}, {"name": "Minimize Browser Window", "args": [], "returnType": null, "doc": "<p>Minimizes current browser window.</p>", "shortdoc": "Minimizes current browser window.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/window.py", "lineno": 190}, {"name": "Mouse Down", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Simulates pressing the left mouse button on the element <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>The element is pressed without releasing the mouse button.</p>\n<p>See also the more specific keywords <a href=\"#Mouse%20Down%20On%20Image\" class=\"name\">Mouse Down On Image</a> and <a href=\"#Mouse%20Down%20On%20Link\" class=\"name\">Mouse Down On Link</a>.</p>", "shortdoc": "Simulates pressing the left mouse button on the element ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 818}, {"name": "Mouse Down On Image", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Simulates a mouse down event on an image identified by <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax. When using the default locator strategy, images are searched using <code>id</code>, <code>name</code>, <code>src</code> and <code>alt</code>.</p>", "shortdoc": "Simulates a mouse down event on an image identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 1084}, {"name": "Mouse Down On Link", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Simulates a mouse down event on a link identified by <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax. When using the default locator strategy, links are searched using <code>id</code>, <code>name</code>, <code>href</code> and the link text.</p>", "shortdoc": "Simulates a mouse down event on a link identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 1036}, {"name": "Mouse Out", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Simulates moving the mouse away from the element <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Simulates moving the mouse away from the element ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 835}, {"name": "Mouse Over", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Simulates hovering the mouse over the element <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Simulates hovering the mouse over the element ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 852}, {"name": "Mouse Up", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Simulates releasing the left mouse button on the element <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Simulates releasing the left mouse button on the element ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 864}, {"name": "Open Browser", "args": [{"name": "url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "url: str | None = None"}, {"name": "browser", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "firefox", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = firefox"}, {"name": "alias", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "alias: str | None = None"}, {"name": "remote_url", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "remote_url: bool | str = False"}, {"name": "desired_capabilities", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "dict", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "desired_capabilities: dict | None | str = None"}, {"name": "ff_profile_dir", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "FirefoxProfile", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ff_profile_dir: FirefoxProfile | str | None = None"}, {"name": "options", "type": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "options: Any = None"}, {"name": "service_log_path", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "service_log_path: str | None = None"}, {"name": "executable_path", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "executable_path: str | None = None"}, {"name": "service", "type": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "service: Any = None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Opens a new browser instance to the optional <code>url</code>.</p>\n<p>The <code>browser</code> argument specifies which browser to use. The supported browsers are listed in the table below. The browser names are case-insensitive and some browsers have multiple supported names.</p>\n<table border=\"1\">\n<tr>\n<th>Browser</th>\n<th>Name(s)</th>\n</tr>\n<tr>\n<td>Firefox</td>\n<td>firefox, ff</td>\n</tr>\n<tr>\n<td>Google Chrome</td>\n<td>googlechrome, chrome, gc</td>\n</tr>\n<tr>\n<td>Headless Firefox</td>\n<td>headlessfirefox</td>\n</tr>\n<tr>\n<td>Headless Chrome</td>\n<td>headlesschrome</td>\n</tr>\n<tr>\n<td>Internet Explorer</td>\n<td>internetexplorer, ie</td>\n</tr>\n<tr>\n<td>Edge</td>\n<td>edge</td>\n</tr>\n<tr>\n<td>Safari</td>\n<td>safari</td>\n</tr>\n</table>\n<p>To be able to actually use one of these browsers, you need to have a matching Selenium browser driver available. See the <a href=\"https://github.com/robotframework/SeleniumLibrary#browser-drivers\">project documentation</a> for more details.</p>\n<p>After opening the browser, it is possible to use optional <code>url</code> to navigate the browser to the desired address.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Chrome</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Firefox</td>\n<td>alias=Firefox</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Edge</td>\n<td>remote_url=http://127.0.0.1:4444/wd/hub</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td>about:blank</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td>browser=Chrome</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Optional <code>alias</code> is an alias given for this browser instance and it can be used for switching between browsers. When same <code>alias</code> is given with two <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> keywords, the first keyword will open a new browser, but the second one will switch to the already opened browser and will not open a new browser. The <code>alias</code> definition overrules <code>browser</code> definition. When same <code>alias</code> is used but a different <code>browser</code> is defined, then switch to a browser with same alias is done and new browser is not opened. An alternative approach for switching is using an index returned by this keyword. These indices start from 1, are incremented when new browsers are opened, and reset back to 1 when <a href=\"#Close%20All%20Browsers\" class=\"name\">Close All Browsers</a> is called. See <a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a> for more information and examples.</p>\n<p>Alias examples:</p>\n<table border=\"1\">\n<tr>\n<td>${1_index} =</td>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Chrome</td>\n<td>alias=Chrome</td>\n<td># Opens new browser because alias is new.</td>\n</tr>\n<tr>\n<td>${2_index} =</td>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Firefox</td>\n<td></td>\n<td># Opens new browser because alias is not defined.</td>\n</tr>\n<tr>\n<td>${3_index} =</td>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Chrome</td>\n<td>alias=Chrome</td>\n<td># Switches to the browser with Chrome alias.</td>\n</tr>\n<tr>\n<td>${4_index} =</td>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Chrome</td>\n<td>alias=${1_index}</td>\n<td># Switches to the browser with Chrome alias.</td>\n</tr>\n<tr>\n<td>Should Be Equal</td>\n<td>${1_index}</td>\n<td>${3_index}</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Should Be Equal</td>\n<td>${1_index}</td>\n<td>${4_index}</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>Should Be Equal</td>\n<td>${2_index}</td>\n<td>${2}</td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Optional <code>remote_url</code> is the URL for a <a href=\"https://github.com/SeleniumHQ/selenium/wiki/Grid2\">Selenium Grid</a>.</p>\n<p>Optional <code>desired_capabilities</code> is deprecated and will be removed in the next release. Capabilities of each individual browser is now done through options or services. Please refer to those arguments for configuring specific browsers.</p>\n<p>Optional <code>ff_profile_dir</code> is the path to the Firefox profile directory if you wish to overwrite the default profile Selenium uses. The <code>ff_profile_dir</code> can also be an instance of the <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_firefox/selenium.webdriver.firefox.firefox_profile.html\">selenium.webdriver.FirefoxProfile</a> . As a third option, it is possible to use <span class=\"name\">FirefoxProfile</span> methods and attributes to define the profile using methods and attributes in the same way as with <code>options</code> argument. Example: It is possible to use FirefoxProfile <span class=\"name\">set_preference</span> to define different profile settings. See <code>options</code> argument documentation in below how to handle backslash escaping.</p>\n<p>Example for FirefoxProfile</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Firefox</td>\n<td>ff_profile_dir=/path/to/profile</td>\n<td># Using profile from disk.</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Firefox</td>\n<td>ff_profile_dir=${FirefoxProfile_instance}</td>\n<td># Using instance of FirefoxProfile.</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Firefox</td>\n<td>ff_profile_dir=set_preference(\"key\", \"value\");set_preference(\"other\", \"setting\")</td>\n<td># Defining profile using FirefoxProfile mehtods.</td>\n</tr>\n</table>\n<p>Optional <code>options</code> argument allows defining browser specific Selenium options. Example for Chrome, the <code>options</code> argument allows defining the following <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_chrome/selenium.webdriver.chrome.options.html#selenium.webdriver.chrome.options.Options\">methods and attributes</a> and for Firefox these <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_firefox/selenium.webdriver.firefox.options.html?highlight=firefox#selenium.webdriver.firefox.options.Options\">methods and attributes</a> are available. Selenium options are also supported, when <code>remote_url</code> argument is used.</p>\n<p>The SeleniumLibrary <code>options</code> argument accepts Selenium options in two different formats: as a string and as Python object which is an instance of the Selenium options class.</p>\n<p>The string format uses a Python like syntax to define Selenium options methods or attributes.</p>\n<p>Example when using <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver_chrome/selenium.webdriver.chrome.options.html#selenium.webdriver.chrome.options.Options\">Chrome options</a> method:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://example.com\">http://example.com</a></td>\n<td>Chrome</td>\n<td>options=add_argument(\"--disable-popup-blocking\"); add_argument(\"--ignore-certificate-errors\")</td>\n<td># Sting format.</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td>None</td>\n<td>Chrome</td>\n<td>options=binary_location=\"/path/to/binary\";add_argument(\"remote-debugging-port=port\")</td>\n<td># Start Chomium-based application.</td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td>None</td>\n<td>Chrome</td>\n<td>options=binary_location=r\"C:\\\\path\\\\to\\\\binary\"</td>\n<td># Windows OS path escaping.</td>\n</tr>\n</table>\n<p><code>options</code> argument also supports receiving the Selenium options as Python class instance.</p>\n<p>See the <span class=\"name\">Browser and Driver options</span> section for more details on how to use the either the string format or Python object syntax with the <code>options</code> argument.</p>\n<p>Optional <code>service_log_path</code> will be deprecated in the next release. Please use the browser specific <code>service</code> attribute instead. The <code>service_log_path</code> argument defines the name of the file where to write the browser driver logs. If the <code>service_log_path</code> argument contains a marker <code>{index}</code>, it will be automatically replaced with unique running index preventing files to be overwritten. Indices start's from 1, and how they are represented can be customized using Python's <a href=\"https://docs.python.org/3/library/string.html#format-string-syntax\">format string syntax</a>.</p>\n<p>Optional <code>executable_path</code> will be deprecated in the next release. Please use the <span class=\"name\">executable_path</span> and, if needed, <span class=\"name\">port</span> attribute on the <code>service</code> argument instead. The <code>executable_path</code> argument defines the path to the driver executable, example to a chromedriver or a geckodriver. If not defined it is assumed the executable is in the <a href=\"https://en.wikipedia.org/wiki/PATH_(variable)\">$PATH</a>.</p>\n<p>Optional <code>service</code> argument allows for managing the local drivers as well as setting some browser specific settings like logging. Service classes are not supported when <code>remote_url</code> argument is used. See the <span class=\"name\">Browser and Driver options</span> section for more details on how to use the <code>service</code> argument.</p>\n<p>If the provided configuration options are not enough, it is possible to use <a href=\"#Create%20Webdriver\" class=\"name\">Create Webdriver</a> to customize browser initialization even more.</p>\n<p>The <code>service</code> argument is new in SeleniumLibrary 6.4.</p>", "shortdoc": "Opens a new browser instance to the optional ``url``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 60}, {"name": "Open Context Menu", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Opens the context menu on the element identified by <code>locator</code>.</p>", "shortdoc": "Opens the context menu on the element identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 875}, {"name": "Page Should Contain", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies that current page contains <code>text</code>.</p>\n<p>If this keyword fails, it automatically logs the page source using the log level specified with the optional <code>loglevel</code> argument. Valid log levels are <code>TRACE</code> (default), <code>DEBUG</code>, <code>INFO</code>, <code>WARN</code>, and <code>NONE</code>. If the log level is <code>NONE</code> or below the current active log level the source will not be logged.</p>\n<p>!! WARNING !! If you have an iframe selected, <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> will reset the frame reference back to the main frame. This is due to the fact that is searches for the <code>text</code> in all frames. To locate an element in an iframe after calling <span class=\"name\">Page Should Contian</span> one needs to (re)select the frame.</p>", "shortdoc": "Verifies that current page contains ``text``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 127}, {"name": "Page Should Contain Button", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies button <code>locator</code> is found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax. When using the default locator strategy, buttons are searched using <code>id</code>, <code>name</code>, and <code>value</code>.</p>", "shortdoc": "Verifies button ``locator`` is found from current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 430}, {"name": "Page Should Contain Checkbox", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies checkbox <code>locator</code> is found from the current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Verifies checkbox ``locator`` is found from the current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 70}, {"name": "Page Should Contain Element", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str | List[WebElement | str]"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}, {"name": "limit", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "limit: int | None = None"}], "returnType": null, "doc": "<p>Verifies that element <code>locator</code> is found on the current page.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>The <code>limit</code> argument can used to define how many elements the page should contain. When <code>limit</code> is <code>None</code> (default) page can contain one or more elements. When limit is a number, page must contain same number of elements.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about the <code>loglevel</code> argument.</p>\n<p>Examples assumes that locator matches to two elements.</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a></td>\n<td>div_name</td>\n<td>limit=1</td>\n<td># Keyword fails.</td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a></td>\n<td>div_name</td>\n<td>limit=2</td>\n<td># Keyword passes.</td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a></td>\n<td>div_name</td>\n<td>limit=none</td>\n<td># None is considered one or more.</td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a></td>\n<td>div_name</td>\n<td></td>\n<td># Same as above.</td>\n</tr>\n</table>\n<p>The <code>limit</code> argument is new in SeleniumLibrary 3.0.</p>", "shortdoc": "Verifies that element ``locator`` is found on the current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 150}, {"name": "Page Should Contain Image", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies image identified by <code>locator</code> is found from current page.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax. When using the default locator strategy, images are searched using <code>id</code>, <code>name</code>, <code>src</code> and <code>alt</code>.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>", "shortdoc": "Verifies image identified by ``locator`` is found from current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 1096}, {"name": "Page Should Contain Link", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies link identified by <code>locator</code> is found from current page.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax. When using the default locator strategy, links are searched using <code>id</code>, <code>name</code>, <code>href</code> and the link text.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>", "shortdoc": "Verifies link identified by ``locator`` is found from current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 1048}, {"name": "Page Should Contain List", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies selection list <code>locator</code> is found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Verifies selection list ``locator`` is found from current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/selectelement.py", "lineno": 159}, {"name": "Page Should Contain Radio Button", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies radio button <code>locator</code> is found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax. When using the default locator strategy, radio buttons are searched using <code>id</code>, <code>name</code> and <code>value</code>.</p>", "shortdoc": "Verifies radio button ``locator`` is found from current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 132}, {"name": "Page Should Contain Textfield", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies text field <code>locator</code> is found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Verifies text field ``locator`` is found from current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 300}, {"name": "Page Should Not Contain", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies the current page does not contain <code>text</code>.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies the current page does not contain ``text``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 198}, {"name": "Page Should Not Contain Button", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies button <code>locator</code> is not found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax. When using the default locator strategy, buttons are searched using <code>id</code>, <code>name</code>, and <code>value</code>.</p>", "shortdoc": "Verifies button ``locator`` is not found from current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 451}, {"name": "Page Should Not Contain Checkbox", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies checkbox <code>locator</code> is not found from the current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Verifies checkbox ``locator`` is not found from the current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 87}, {"name": "Page Should Not Contain Element", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies that element <code>locator</code> is not found on the current page.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>See <a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>", "shortdoc": "Verifies that element ``locator`` is not found on the current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 210}, {"name": "Page Should Not Contain Image", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies image identified by <code>locator</code> is not found from current page.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax. When using the default locator strategy, images are searched using <code>id</code>, <code>name</code>, <code>src</code> and <code>alt</code>.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>", "shortdoc": "Verifies image identified by ``locator`` is not found from current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 1114}, {"name": "Page Should Not Contain Link", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies link identified by <code>locator</code> is not found from current page.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax. When using the default locator strategy, links are searched using <code>id</code>, <code>name</code>, <code>href</code> and the link text.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>", "shortdoc": "Verifies link identified by ``locator`` is not found from current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 1066}, {"name": "Page Should Not Contain List", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies selection list <code>locator</code> is not found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Verifies selection list ``locator`` is not found from current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/selectelement.py", "lineno": 176}, {"name": "Page Should Not Contain Radio Button", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies radio button <code>locator</code> is not found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax. When using the default locator strategy, radio buttons are searched using <code>id</code>, <code>name</code> and <code>value</code>.</p>", "shortdoc": "Verifies radio button ``locator`` is not found from current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 150}, {"name": "Page Should Not Contain Textfield", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies text field <code>locator</code> is not found from current page.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about <code>message</code> and <code>loglevel</code> arguments.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Verifies text field ``locator`` is not found from current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 317}, {"name": "Press Key", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "key", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "key: str"}], "returnType": null, "doc": "<p>Simulates user pressing key on element identified by <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p><code>key</code> is either a single character, a string, or a numerical ASCII code of the key lead by '\\'.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Press%20Key\" class=\"name\">Press Key</a></td>\n<td>text_field</td>\n<td>q</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Key\" class=\"name\">Press Key</a></td>\n<td>text_field</td>\n<td>abcde</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Key\" class=\"name\">Press Key</a></td>\n<td>login_button</td>\n<td>\\13</td>\n<td># ASCII code for enter key</td>\n</tr>\n</table>\n<p><a href=\"#Press%20Key\" class=\"name\">Press Key</a> and <a href=\"#Press%20Keys\" class=\"name\">Press Keys</a> differ in the methods to simulate key presses. <a href=\"#Press%20Key\" class=\"name\">Press Key</a> uses the WebDriver <span class=\"name\">SEND_KEYS_TO_ELEMENT</span> command using the selenium send_keys method. Although one is not recommended over the other if <a href=\"#Press%20Key\" class=\"name\">Press Key</a> does not work we recommend trying <a href=\"#Press%20Keys\" class=\"name\">Press Keys</a>.</p>", "shortdoc": "Simulates user pressing key on element identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 907}, {"name": "Press Keys", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "locator: WebElement | None | str = None"}, {"name": "keys", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*keys: str"}], "returnType": null, "doc": "<p>Simulates the user pressing key(s) to an element or on the active browser.</p>\n<p>If <code>locator</code> evaluates as false, see <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a> for more details, then the <code>keys</code> are sent to the currently active browser. Otherwise element is searched and <code>keys</code> are send to the element identified by the <code>locator</code>. In later case, keyword fails if element is not found. See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p><code>keys</code> arguments can contain one or many strings, but it can not be empty. <code>keys</code> can also be a combination of <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html\">Selenium Keys</a> and strings or a single Selenium Key. If Selenium Key is combined with strings, Selenium key and strings must be separated by the <span class=\"name\">+</span> character, like in <span class=\"name\">CONTROL+c</span>. Selenium Keys are space and case sensitive and Selenium Keys are not parsed inside of the string. Example AALTO, would send string <span class=\"name\">AALTO</span> and <span class=\"name\">ALT</span> not parsed inside of the string. But <span class=\"name\">A+ALT+O</span> would found Selenium ALT key from the <code>keys</code> argument. It also possible to press many Selenium Keys down at the same time, example 'ALT+ARROW_DOWN`.</p>\n<p>If Selenium Keys are detected in the <code>keys</code> argument, keyword will press the Selenium Key down, send the strings and then release the Selenium Key. If keyword needs to send a Selenium Key as a string, then each character must be separated with <span class=\"name\">+</span> character, example <span class=\"name\">E+N+D</span>.</p>\n<p><span class=\"name\">CTRL</span> is alias for <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html#selenium.webdriver.common.keys.Keys.CONTROL\">Selenium CONTROL</a> and ESC is alias for <a href=\"https://seleniumhq.github.io/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html#selenium.webdriver.common.keys.Keys.ESCAPE\">Selenium ESCAPE</a></p>\n<p>New in SeleniumLibrary 3.3</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>AAAAA</td>\n<td></td>\n<td># Sends string \"AAAAA\" to element.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>None</td>\n<td>BBBBB</td>\n<td></td>\n<td># Sends string \"BBBBB\" to currently active browser.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>E+N+D</td>\n<td></td>\n<td># Sends string \"END\" to element.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>XXX</td>\n<td>YY</td>\n<td># Sends strings \"XXX\" and \"YY\" to element.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>XXX+YY</td>\n<td></td>\n<td># Same as above.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>ALT+ARROW_DOWN</td>\n<td></td>\n<td># Pressing \"ALT\" key down, then pressing ARROW_DOWN and then releasing both keys.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>ALT</td>\n<td>ARROW_DOWN</td>\n<td># Pressing \"ALT\" key and then pressing ARROW_DOWN.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>text_field</td>\n<td>CTRL+c</td>\n<td></td>\n<td># Pressing CTRL key down, sends string \"c\" and then releases CTRL key.</td>\n</tr>\n<tr>\n<td><a href=\"#Press%20Keys\" class=\"name\">Press Keys</a></td>\n<td>button</td>\n<td>RETURN</td>\n<td></td>\n<td># Pressing \"ENTER\" key to element.</td>\n</tr>\n</table>\n<p><a href=\"#Press%20Key\" class=\"name\">Press Key</a> and <a href=\"#Press%20Keys\" class=\"name\">Press Keys</a> differ in the methods to simulate key presses. <a href=\"#Press%20Keys\" class=\"name\">Press Keys</a> uses the Selenium/WebDriver Actions. <a href=\"#Press%20Keys\" class=\"name\">Press Keys</a> also has a more extensive syntax for describing keys, key combinations, and key actions. Although one is not recommended over the other if <a href=\"#Press%20Keys\" class=\"name\">Press Keys</a> does not work we recommend trying <a href=\"#Press%20Key\" class=\"name\">Press Key</a>.</p>", "shortdoc": "Simulates the user pressing key(s) to an element or on the active browser.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 933}, {"name": "Print Page As Pdf", "args": [{"name": "filename", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "selenium-page-{index}.pdf", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "filename: str = selenium-page-{index}.pdf"}, {"name": "background", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "background: bool | None = None"}, {"name": "margin_bottom", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "margin_bottom: float | None = None"}, {"name": "margin_left", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "margin_left: float | None = None"}, {"name": "margin_right", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "margin_right: float | None = None"}, {"name": "margin_top", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "margin_top: float | None = None"}, {"name": "orientation", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "orientation: str | None = None"}, {"name": "page_height", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page_height: float | None = None"}, {"name": "page_ranges", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "list", "typedoc": "list", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page_ranges: list | None = None"}, {"name": "page_width", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "page_width: float | None = None"}, {"name": "scale", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "scale: float | None = None"}, {"name": "shrink_to_fit", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "shrink_to_fit: bool | None = None"}], "returnType": null, "doc": "<p>Print the current page as a PDF</p>\n<p><code>page_ranges</code> defaults to <span class=\"name\">['-']</span> or \"all\" pages. <code>page_ranges</code> takes a list of strings indicating the ranges.</p>\n<p>The page size defaults to 21.59 for <code>page_width</code> and 27.94 for <code>page_height</code>. This is the equivalent size of US-Letter. The assumed units on these parameters is centimeters.</p>\n<p>The default margin for top, left, bottom, right is <span class=\"name\">1</span>. The assumed units on these parameters is centimeters.</p>\n<p>The default <code>orientation</code> is <span class=\"name\">portrait</span>. <code>orientation</code> can be either <span class=\"name\">portrait</span> or <span class=\"name\">landscape</span>.</p>\n<p>The default <code>scale</code> is <span class=\"name\">1</span>. <code>scale</code> must be greater than or equal to <span class=\"name\">0.1</span> and less than or equal to <span class=\"name\">2</span>.</p>\n<p><code>background</code> and <code>scale_to_fit</code> can be either <span class=\"name\">${True}</span> or <span class=\"name\">${False}</span>..</p>\n<p>If all print options are None then a pdf will fail to print silently.</p>", "shortdoc": "Print the current page as a PDF", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/screenshot.py", "lineno": 267}, {"name": "Radio Button Should Be Set To", "args": [{"name": "group_name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group_name: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}], "returnType": null, "doc": "<p>Verifies radio button group <code>group_name</code> is set to <code>value</code>.</p>\n<p><code>group_name</code> is the <code>name</code> of the radio button group.</p>", "shortdoc": "Verifies radio button group ``group_name`` is set to ``value``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 168}, {"name": "Radio Button Should Not Be Selected", "args": [{"name": "group_name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group_name: str"}], "returnType": null, "doc": "<p>Verifies radio button group <code>group_name</code> has no selection.</p>\n<p><code>group_name</code> is the <code>name</code> of the radio button group.</p>", "shortdoc": "Verifies radio button group ``group_name`` has no selection.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 183}, {"name": "Register Keyword To Run On Failure", "args": [{"name": "keyword", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "keyword: str | None"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Sets the keyword to execute, when a SeleniumLibrary keyword fails.</p>\n<p><code>keyword</code> is the name of a keyword that will be executed if a SeleniumLibrary keyword fails. It is possible to use any available keyword, including user keywords or keywords from other libraries, but the keyword must not take any arguments.</p>\n<p>The initial keyword to use is set when <a href=\"#Importing\" class=\"name\">importing</a> the library, and the keyword that is used by default is <a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a>. Taking a screenshot when something failed is a very useful feature, but notice that it can slow down the execution.</p>\n<p>It is possible to use string <code>NOTHING</code> or <code>NONE</code>, case-insensitively, as well as Python <code>None</code> to disable this feature altogether.</p>\n<p>This keyword returns the name of the previously registered failure keyword or Python <code>None</code> if this functionality was previously disabled. The return value can be always used to restore the original value later.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a></td>\n<td>Log Source</td>\n<td></td>\n</tr>\n<tr>\n<td>${previous kw}=</td>\n<td><a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a></td>\n<td>NONE</td>\n</tr>\n<tr>\n<td><a href=\"#Register%20Keyword%20To%20Run%20On%20Failure\" class=\"name\">Register Keyword To Run On Failure</a></td>\n<td>${previous kw}</td>\n<td></td>\n</tr>\n</table>\n<p>Changes in SeleniumLibrary 3.0:</p>\n<ul>\n<li>Possible to use string <code>NONE</code> or Python <code>None</code> to disable the functionality.</li>\n<li>Return Python <code>None</code> when the functionality was disabled earlier. In previous versions special value <code>No Keyword</code> was returned and it could not be used to restore the original state.</li>\n</ul>", "shortdoc": "Sets the keyword to execute, when a SeleniumLibrary keyword fails.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/runonfailure.py", "lineno": 23}, {"name": "Reload Page", "args": [], "returnType": null, "doc": "<p>Simulates user reloading page.</p>", "shortdoc": "Simulates user reloading page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 524}, {"name": "Remove Location Strategy", "args": [{"name": "strategy_name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "strategy_name: str"}], "returnType": null, "doc": "<p>Removes a previously added custom location strategy.</p>\n<p>See <a href=\"#Custom%20locators\" class=\"name\">Custom locators</a> for information on how to create and use custom strategies.</p>", "shortdoc": "Removes a previously added custom location strategy.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 1165}, {"name": "Scroll Element Into View", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Scrolls the element identified by <code>locator</code> into view.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>New in SeleniumLibrary 3.2.0</p>", "shortdoc": "Scrolls the element identified by ``locator`` into view.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 768}, {"name": "Select All From List", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Selects all options from multi-selection list <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Selects all options from multi-selection list ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/selectelement.py", "lineno": 193}, {"name": "Select Checkbox", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Selects the checkbox identified by <code>locator</code>.</p>\n<p>Does nothing if checkbox is already selected.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Selects the checkbox identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 104}, {"name": "Select Frame", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Sets frame identified by <code>locator</code> as the current frame.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>Works both with frames and iframes. Use <a href=\"#Unselect%20Frame\" class=\"name\">Unselect Frame</a> to cancel the frame selection and return to the main frame.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Select%20Frame\" class=\"name\">Select Frame</a></td>\n<td>top-frame</td>\n<td># Select frame with id or name 'top-frame'</td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Link\" class=\"name\">Click Link</a></td>\n<td>example</td>\n<td># Click link 'example' in the selected frame</td>\n</tr>\n<tr>\n<td><a href=\"#Unselect%20Frame\" class=\"name\">Unselect Frame</a></td>\n<td></td>\n<td># Back to main frame.</td>\n</tr>\n<tr>\n<td><a href=\"#Select%20Frame\" class=\"name\">Select Frame</a></td>\n<td>//iframe[@name='xxx']</td>\n<td># Select frame using xpath</td>\n</tr>\n</table>", "shortdoc": "Sets frame identified by ``locator`` as the current frame.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/frames.py", "lineno": 25}, {"name": "Select From List By Index", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "indexes", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*indexes: str"}], "returnType": null, "doc": "<p>Selects options from selection list <code>locator</code> by <code>indexes</code>.</p>\n<p>Indexes of list options start from 0.</p>\n<p>If more than one option is given for a single-selection list, the last value will be selected. With multi-selection lists all specified options are selected, but possible old selections are not cleared.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Selects options from selection list ``locator`` by ``indexes``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/selectelement.py", "lineno": 209}, {"name": "Select From List By Label", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "labels", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*labels: str"}], "returnType": null, "doc": "<p>Selects options from selection list <code>locator</code> by <code>labels</code>.</p>\n<p>If more than one option is given for a single-selection list, the last value will be selected. With multi-selection lists all specified options are selected, but possible old selections are not cleared.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Selects options from selection list ``locator`` by ``labels``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/selectelement.py", "lineno": 256}, {"name": "Select From List By Value", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "values", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*values: str"}], "returnType": null, "doc": "<p>Selects options from selection list <code>locator</code> by <code>values</code>.</p>\n<p>If more than one option is given for a single-selection list, the last value will be selected. With multi-selection lists all specified options are selected, but possible old selections are not cleared.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Selects options from selection list ``locator`` by ``values``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/selectelement.py", "lineno": 234}, {"name": "Select Radio Button", "args": [{"name": "group_name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "group_name: str"}, {"name": "value", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: str"}], "returnType": null, "doc": "<p>Sets the radio button group <code>group_name</code> to <code>value</code>.</p>\n<p>The radio button to be selected is located by two arguments:</p>\n<ul>\n<li><code>group_name</code> is the name of the radio button group.</li>\n<li><code>value</code> is the <code>id</code> or <code>value</code> attribute of the actual radio button.</li>\n</ul>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Select%20Radio%20Button\" class=\"name\">Select Radio Button</a></td>\n<td>size</td>\n<td>XL</td>\n</tr>\n<tr>\n<td><a href=\"#Select%20Radio%20Button\" class=\"name\">Select Radio Button</a></td>\n<td>contact</td>\n<td>email</td>\n</tr>\n</table>", "shortdoc": "Sets the radio button group ``group_name`` to ``value``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 198}, {"name": "Set Action Chain Delay", "args": [{"name": "value", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: timedelta"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Sets the duration of delay in ActionChains() used by SeleniumLibrary.</p>\n<p>The value can be given as a number that is considered to be seconds or as a human-readable string like <code>1 second</code>.</p>\n<p>Value is always stored as milliseconds internally.</p>\n<p>The previous value is returned and can be used to restore the original value later if needed.</p>", "shortdoc": "Sets the duration of delay in ActionChains() used by SeleniumLibrary.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 640}, {"name": "Set Browser Implicit Wait", "args": [{"name": "value", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: timedelta"}], "returnType": null, "doc": "<p>Sets the implicit wait value used by Selenium.</p>\n<p>Same as <a href=\"#Set%20Selenium%20Implicit%20Wait\" class=\"name\">Set Selenium Implicit Wait</a> but only affects the current browser.</p>", "shortdoc": "Sets the implicit wait value used by Selenium.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 662}, {"name": "Set Focus To Element", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Sets the focus to the element identified by <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>Prior to SeleniumLibrary 3.0 this keyword was named <span class=\"name\">Focus</span>.</p>", "shortdoc": "Sets the focus to the element identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 756}, {"name": "Set Screenshot Directory", "args": [{"name": "path", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "None", "typedoc": "None", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: None | str"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Sets the directory for captured screenshots.</p>\n<p><code>path</code> argument specifies the absolute path to a directory where the screenshots should be written to. If the directory does not exist, it will be created. The directory can also be set when <a href=\"#Importing\" class=\"name\">importing</a> the library. If it is not configured anywhere, screenshots are saved to the same directory where Robot Framework's log file is written.</p>\n<p>If <code>path</code> equals to EMBED (case insensitive) and <a href=\"#Capture%20Page%20Screenshot\" class=\"name\">Capture Page Screenshot</a> or <a href=\"#Capture%20Element%20Screenshot\" class=\"name\">capture Element Screenshot</a> keywords filename argument is not changed from the default value, then the page or element screenshot is embedded as Base64 image to the log.html.</p>\n<p>The previous value is returned and can be used to restore the original value later if needed.</p>\n<p>Returning the previous value is new in SeleniumLibrary 3.0. The persist argument was removed in SeleniumLibrary 3.2 and EMBED is new in SeleniumLibrary 4.2.</p>", "shortdoc": "Sets the directory for captured screenshots.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/screenshot.py", "lineno": 37}, {"name": "Set Selenium Implicit Wait", "args": [{"name": "value", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: timedelta"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Sets the implicit wait value used by Selenium.</p>\n<p>The value can be given as a number that is considered to be seconds or as a human-readable string like <code>1 second</code>. The previous value is returned and can be used to restore the original value later if needed.</p>\n<p>This keyword sets the implicit wait for all opened browsers. Use <a href=\"#Set%20Browser%20Implicit%20Wait\" class=\"name\">Set Browser Implicit Wait</a> to set it only to the current browser.</p>\n<p>See the <a href=\"#Implicit%20wait\" class=\"name\">Implicit wait</a> section above for more information.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${orig wait} =</td>\n<td><a href=\"#Set%20Selenium%20Implicit%20Wait\" class=\"name\">Set Selenium Implicit Wait</a></td>\n<td>10 seconds</td>\n</tr>\n<tr>\n<td><span class=\"name\">Perform AJAX call that is slow</span></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Selenium%20Implicit%20Wait\" class=\"name\">Set Selenium Implicit Wait</a></td>\n<td>${orig wait}</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Sets the implicit wait value used by Selenium.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 614}, {"name": "Set Selenium Page Load Timeout", "args": [{"name": "value", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: timedelta"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Sets the page load timeout value used by Selenium.</p>\n<p>The value can be given as a number that is considered to be seconds or as a human-readable string like <code>1 second</code>. The previous value is returned and can be used to restore the original value later if needed.</p>\n<p>In contrast to <a href=\"#Set%20Selenium%20Timeout\" class=\"name\">Set Selenium Timeout</a> and <a href=\"#Set%20Selenium%20Implicit%20Wait\" class=\"name\">Set Selenium Implicit Wait</a>, this keywords sets the time for the Webdriver to wait until the page is loaded before raising a timeout exception.</p>\n<p>See the <a href=\"#Page%20load\" class=\"name\">Page load</a> section above for more information.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${orig page load timeout} =</td>\n<td><a href=\"#Set%20Selenium%20Page%20Load%20Timeout\" class=\"name\">Set Selenium Page Load Timeout</a></td>\n<td>30 seconds</td>\n</tr>\n<tr>\n<td><span class=\"name\">Open page that loads slowly</span></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Selenium%20Page%20Load%20Timeout\" class=\"name\">Set Selenium Page Load Timeout</a></td>\n<td>${orig page load timeout}</td>\n<td></td>\n</tr>\n</table>\n<p>New in SeleniumLibrary 6.1</p>", "shortdoc": "Sets the page load timeout value used by Selenium.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 671}, {"name": "Set Selenium Speed", "args": [{"name": "value", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: timedelta"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Sets the delay that is waited after each Selenium command.</p>\n<p>The value can be given as a number that is considered to be seconds or as a human-readable string like <code>1 second</code>. The previous value is returned and can be used to restore the original value later if needed.</p>\n<p>See the <a href=\"#Selenium%20speed\" class=\"name\">Selenium Speed</a> section above for more information.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Set%20Selenium%20Speed\" class=\"name\">Set Selenium Speed</a></td>\n<td>0.5 seconds</td>\n</tr>\n</table>", "shortdoc": "Sets the delay that is waited after each Selenium command.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 572}, {"name": "Set Selenium Timeout", "args": [{"name": "value", "type": {"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "value: timedelta"}], "returnType": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "doc": "<p>Sets the timeout that is used by various keywords.</p>\n<p>The value can be given as a number that is considered to be seconds or as a human-readable string like <code>1 second</code>. The previous value is returned and can be used to restore the original value later if needed.</p>\n<p>See the <a href=\"#Timeout\" class=\"name\">Timeout</a> section above for more information.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td>${orig timeout} =</td>\n<td><a href=\"#Set%20Selenium%20Timeout\" class=\"name\">Set Selenium Timeout</a></td>\n<td>15 seconds</td>\n</tr>\n<tr>\n<td><span class=\"name\">Open page that loads slowly</span></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Selenium%20Timeout\" class=\"name\">Set Selenium Timeout</a></td>\n<td>${orig timeout}</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Sets the timeout that is used by various keywords.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 592}, {"name": "Set Window Position", "args": [{"name": "x", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "x: int"}, {"name": "y", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "y: int"}], "returnType": null, "doc": "<p>Sets window position using <code>x</code> and <code>y</code> coordinates.</p>\n<p>The position is relative to the top left corner of the screen, but some browsers exclude possible task bar set by the operating system from the calculation. The actual position may thus be different with different browsers.</p>\n<p>Values can be given using strings containing numbers or by using actual numbers. See also <a href=\"#Get%20Window%20Position\" class=\"name\">Get Window Position</a>.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Set%20Window%20Position\" class=\"name\">Set Window Position</a></td>\n<td>100</td>\n<td>200</td>\n</tr>\n</table>", "shortdoc": "Sets window position using ``x`` and ``y`` coordinates.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/window.py", "lineno": 274}, {"name": "Set Window Size", "args": [{"name": "width", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "width: int"}, {"name": "height", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "height: int"}, {"name": "inner", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "inner: bool = False"}], "returnType": null, "doc": "<p>Sets current windows size to given <code>width</code> and <code>height</code>.</p>\n<p>Values can be given using strings containing numbers or by using actual numbers. See also <a href=\"#Get%20Window%20Size\" class=\"name\">Get Window Size</a>.</p>\n<p>Browsers have a limit on their minimum size. Trying to set them smaller will cause the actual size to be bigger than the requested size.</p>\n<p>If <code>inner</code> parameter is set to True, keyword sets the necessary window width and height to have the desired HTML DOM <i>window.innerWidth</i> and <i>window.innerHeight</i>. See <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments</a> for more details on how to set boolean arguments.</p>\n<p>The <code>inner</code> argument is new since SeleniumLibrary 4.0.</p>\n<p>This <code>inner</code> argument does not support Frames. If a frame is selected, switch to default before running this.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Set%20Window%20Size\" class=\"name\">Set Window Size</a></td>\n<td>800</td>\n<td>600</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Set%20Window%20Size\" class=\"name\">Set Window Size</a></td>\n<td>800</td>\n<td>600</td>\n<td>True</td>\n</tr>\n</table>", "shortdoc": "Sets current windows size to given ``width`` and ``height``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/window.py", "lineno": 217}, {"name": "Simulate Event", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "event", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "event: str"}], "returnType": null, "doc": "<p>Simulates <code>event</code> on the element identified by <code>locator</code>.</p>\n<p>This keyword is useful if element has <code>OnEvent</code> handler that needs to be explicitly invoked.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>Prior to SeleniumLibrary 3.0 this keyword was named <span class=\"name\">Simulate</span>.</p>", "shortdoc": "Simulates ``event`` on the element identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/element.py", "lineno": 882}, {"name": "Submit Form", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "locator: WebElement | None | str = None"}], "returnType": null, "doc": "<p>Submits a form identified by <code>locator</code>.</p>\n<p>If <code>locator</code> is not given, first form on the page is submitted.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Submits a form identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 29}, {"name": "Switch Browser", "args": [{"name": "index_or_alias", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "index_or_alias: str"}], "returnType": null, "doc": "<p>Switches between active browsers using <code>index_or_alias</code>.</p>\n<p>Indices are returned by the <a href=\"#Open%20Browser\" class=\"name\">Open Browser</a> keyword and aliases can be given to it explicitly. Indices start from 1.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://google.com\">http://google.com</a></td>\n<td>ff</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Location%20Should%20Be\" class=\"name\">Location Should Be</a></td>\n<td><a href=\"http://google.com\">http://google.com</a></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://yahoo.com\">http://yahoo.com</a></td>\n<td>ie</td>\n<td>alias=second</td>\n</tr>\n<tr>\n<td><a href=\"#Location%20Should%20Be\" class=\"name\">Location Should Be</a></td>\n<td><a href=\"http://yahoo.com\">http://yahoo.com</a></td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a></td>\n<td>1</td>\n<td># index</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a></td>\n<td>I'm feeling lucky</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a></td>\n<td>second</td>\n<td># alias</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Page%20Should%20Contain\" class=\"name\">Page Should Contain</a></td>\n<td>More Yahoo!</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Close%20All%20Browsers\" class=\"name\">Close All Browsers</a></td>\n<td></td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>Above example expects that there was no other open browsers when opening the first one because it used index <code>1</code> when switching to it later. If you are not sure about that, you can store the index into a variable as below.</p>\n<table border=\"1\">\n<tr>\n<td>${index} =</td>\n<td><a href=\"#Open%20Browser\" class=\"name\">Open Browser</a></td>\n<td><a href=\"http://google.com\">http://google.com</a></td>\n</tr>\n<tr>\n<td># Do something ...</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a></td>\n<td>${index}</td>\n<td></td>\n</tr>\n</table>", "shortdoc": "Switches between active browsers using ``index_or_alias``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 334}, {"name": "Switch Window", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "list", "typedoc": "list", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": "MAIN", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "locator: list | str = MAIN"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: str | None = None"}, {"name": "browser", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "CURRENT", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "browser: str = CURRENT"}], "returnType": null, "doc": "<p>Switches to browser window matching <code>locator</code>.</p>\n<p>If the window is found, all subsequent commands use the selected window, until this keyword is used again. If the window is not found, this keyword fails. The previous windows handle is returned and can be used to switch back to it later.</p>\n<p>Notice that alerts should be handled with <a href=\"#Handle%20Alert\" class=\"name\">Handle Alert</a> or other alert related keywords.</p>\n<p>The <code>locator</code> can be specified using different strategies somewhat similarly as when <a href=\"#Locating%20elements\" class=\"name\">locating elements</a> on pages.</p>\n<ul>\n<li>By default, the <code>locator</code> is matched against window handle, name, title, and URL. Matching is done in that order and the first matching window is selected.</li>\n</ul>\n<ul>\n<li>The <code>locator</code> can specify an explicit strategy by using the format <code>strategy:value</code> (recommended) or <code>strategy=value</code>. Supported strategies are <code>name</code>, <code>title</code>, and <code>url</code>. These matches windows using their name, title, or URL, respectively. Additionally, <code>default</code> can be used to explicitly use the default strategy explained above.</li>\n</ul>\n<ul>\n<li>If the <code>locator</code> is <code>NEW</code> (case-insensitive), the latest opened window is selected. It is an error if this is the same as the current window.</li>\n</ul>\n<ul>\n<li>If the <code>locator</code> is <code>MAIN</code> (default, case-insensitive), the main window is selected.</li>\n</ul>\n<ul>\n<li>If the <code>locator</code> is <code>CURRENT</code> (case-insensitive), nothing is done. This effectively just returns the current window handle.</li>\n</ul>\n<ul>\n<li>If the <code>locator</code> is not a string, it is expected to be a list of window handles <i>to exclude</i>. Such a list of excluded windows can be got from <a href=\"#Get%20Window%20Handles\" class=\"name\">Get Window Handles</a> before doing an action that opens a new window.</li>\n</ul>\n<p>The <code>timeout</code> is used to specify how long keyword will poll to select the new window. The <code>timeout</code> is new in SeleniumLibrary 3.2.</p>\n<p>Example:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Click%20Link\" class=\"name\">Click Link</a></td>\n<td>popup1</td>\n<td></td>\n<td># Open new window</td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Window\" class=\"name\">Switch Window</a></td>\n<td>example</td>\n<td></td>\n<td># Select window using default strategy</td>\n</tr>\n<tr>\n<td><a href=\"#Title%20Should%20Be\" class=\"name\">Title Should Be</a></td>\n<td>Pop-up 1</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Button\" class=\"name\">Click Button</a></td>\n<td>popup2</td>\n<td></td>\n<td># Open another window</td>\n</tr>\n<tr>\n<td>${handle} =</td>\n<td><a href=\"#Switch%20Window\" class=\"name\">Switch Window</a></td>\n<td>NEW</td>\n<td># Select latest opened window</td>\n</tr>\n<tr>\n<td><a href=\"#Title%20Should%20Be\" class=\"name\">Title Should Be</a></td>\n<td>Pop-up 2</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Window\" class=\"name\">Switch Window</a></td>\n<td>${handle}</td>\n<td></td>\n<td># Select window using handle</td>\n</tr>\n<tr>\n<td><a href=\"#Title%20Should%20Be\" class=\"name\">Title Should Be</a></td>\n<td>Pop-up 1</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Window\" class=\"name\">Switch Window</a></td>\n<td>MAIN</td>\n<td></td>\n<td># Select the main window</td>\n</tr>\n<tr>\n<td><a href=\"#Title%20Should%20Be\" class=\"name\">Title Should Be</a></td>\n<td>Main</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>${excludes} =</td>\n<td><a href=\"#Get%20Window%20Handles\" class=\"name\">Get Window Handles</a></td>\n<td></td>\n<td># Get list of current windows</td>\n</tr>\n<tr>\n<td><a href=\"#Click%20Link\" class=\"name\">Click Link</a></td>\n<td>popup3</td>\n<td></td>\n<td># Open one more window</td>\n</tr>\n<tr>\n<td><a href=\"#Switch%20Window\" class=\"name\">Switch Window</a></td>\n<td>${excludes}</td>\n<td></td>\n<td># Select window using excludes</td>\n</tr>\n<tr>\n<td><a href=\"#Title%20Should%20Be\" class=\"name\">Title Should Be</a></td>\n<td>Pop-up 3</td>\n<td></td>\n<td></td>\n</tr>\n</table>\n<p>The <code>browser</code> argument allows with <code>index_or_alias</code> to implicitly switch to a specific browser when switching to a window. See <a href=\"#Switch%20Browser\" class=\"name\">Switch Browser</a></p>\n<ul>\n<li>If the <code>browser</code> is <code>CURRENT</code> (case-insensitive), no other browser is selected.</li>\n</ul>\n<p><b>NOTE:</b></p>\n<ul>\n<li>The <code>strategy:value</code> syntax is only supported by SeleniumLibrary 3.0 and newer.</li>\n<li>Prior to SeleniumLibrary 3.0 matching windows by name, title and URL was case-insensitive.</li>\n<li>Earlier versions supported aliases <code>None</code>, <code>null</code> and the empty string for selecting the main window, and alias <code>self</code> for selecting the current window. Support for these aliases was removed in SeleniumLibrary 3.2.</li>\n</ul>", "shortdoc": "Switches to browser window matching ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/window.py", "lineno": 33}, {"name": "Table Cell Should Contain", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "row", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "row: int"}, {"name": "column", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "column: int"}, {"name": "expected", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies table cell contains text <code>expected</code>.</p>\n<p>See <a href=\"#Get%20Table%20Cell\" class=\"name\">Get Table Cell</a> that this keyword uses internally for an explanation about accepted arguments.</p>", "shortdoc": "Verifies table cell contains text ``expected``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/tableelement.py", "lineno": 90}, {"name": "Table Column Should Contain", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "column", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "column: int"}, {"name": "expected", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies table column contains text <code>expected</code>.</p>\n<p>The table is located using the <code>locator</code> argument and its column found using <code>column</code>. See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>Column indexes start from 1. It is possible to refer to columns from the end by using negative indexes so that -1 is the last column, -2 is the second last, and so on.</p>\n<p>If a table contains cells that span multiple columns, those merged cells count as a single column.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies table column contains text ``expected``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/tableelement.py", "lineno": 113}, {"name": "Table Footer Should Contain", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies table footer contains text <code>expected</code>.</p>\n<p>Any <code><td></code> element inside <code><tfoot></code> element is considered to be part of the footer.</p>\n<p>The table is located using the <code>locator</code> argument. See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies table footer contains text ``expected``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/tableelement.py", "lineno": 144}, {"name": "Table Header Should Contain", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies table header contains text <code>expected</code>.</p>\n<p>Any <code><th></code> element anywhere in the table is considered to be part of the header.</p>\n<p>The table is located using the <code>locator</code> argument. See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies table header contains text ``expected``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/tableelement.py", "lineno": 169}, {"name": "Table Row Should Contain", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "row", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "row: int"}, {"name": "expected", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies that table row contains text <code>expected</code>.</p>\n<p>The table is located using the <code>locator</code> argument and its column found using <code>column</code>. See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>Row indexes start from 1. It is possible to refer to rows from the end by using negative indexes so that -1 is the last row, -2 is the second last, and so on.</p>\n<p>If a table contains cells that span multiple rows, a match only occurs for the uppermost row of those merged cells.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies that table row contains text ``expected``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/tableelement.py", "lineno": 194}, {"name": "Table Should Contain", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "loglevel", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": "TRACE", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "loglevel: str = TRACE"}], "returnType": null, "doc": "<p>Verifies table contains text <code>expected</code>.</p>\n<p>The table is located using the <code>locator</code> argument. See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>See <a href=\"#Page%20Should%20Contain%20Element\" class=\"name\">Page Should Contain Element</a> for an explanation about the <code>loglevel</code> argument.</p>", "shortdoc": "Verifies table contains text ``expected``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/tableelement.py", "lineno": 225}, {"name": "Textarea Should Contain", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Verifies text area <code>locator</code> contains text <code>expected</code>.</p>\n<p><code>message</code> can be used to override default error message.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Verifies text area ``locator`` contains text ``expected``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 382}, {"name": "Textarea Value Should Be", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Verifies text area <code>locator</code> has exactly text <code>expected</code>.</p>\n<p><code>message</code> can be used to override default error message.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Verifies text area ``locator`` has exactly text ``expected``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 406}, {"name": "Textfield Should Contain", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Verifies text field <code>locator</code> contains text <code>expected</code>.</p>\n<p><code>message</code> can be used to override the default error message.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Verifies text field ``locator`` contains text ``expected``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 334}, {"name": "Textfield Value Should Be", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "expected", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Verifies text field <code>locator</code> has exactly text <code>expected</code>.</p>\n<p><code>message</code> can be used to override default error message.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Verifies text field ``locator`` has exactly text ``expected``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 358}, {"name": "Title Should Be", "args": [{"name": "title", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "title: str"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Verifies that the current page title equals <code>title</code>.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p><code>message</code> argument is new in SeleniumLibrary 3.1.</p>", "shortdoc": "Verifies that the current page title equals ``title``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/browsermanagement.py", "lineno": 497}, {"name": "Unselect All From List", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Unselects all options from multi-selection list <code>locator</code>.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p>New in SeleniumLibrary 3.0.</p>", "shortdoc": "Unselects all options from multi-selection list ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/selectelement.py", "lineno": 278}, {"name": "Unselect Checkbox", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}], "returnType": null, "doc": "<p>Removes the selection of checkbox identified by <code>locator</code>.</p>\n<p>Does nothing if the checkbox is not selected.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Removes the selection of checkbox identified by ``locator``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/formelement.py", "lineno": 118}, {"name": "Unselect Frame", "args": [], "returnType": null, "doc": "<p>Sets the main frame as the current frame.</p>\n<p>In practice cancels the previous <a href=\"#Select%20Frame\" class=\"name\">Select Frame</a> call.</p>", "shortdoc": "Sets the main frame as the current frame.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/frames.py", "lineno": 45}, {"name": "Unselect From List By Index", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "indexes", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*indexes: str"}], "returnType": null, "doc": "<p>Unselects options from selection list <code>locator</code> by <code>indexes</code>.</p>\n<p>Indexes of list options start from 0. This keyword works only with multi-selection lists.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Unselects options from selection list ``locator`` by ``indexes``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/selectelement.py", "lineno": 295}, {"name": "Unselect From List By Label", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "labels", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*labels: str"}], "returnType": null, "doc": "<p>Unselects options from selection list <code>locator</code> by <code>labels</code>.</p>\n<p>This keyword works only with multi-selection lists.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Unselects options from selection list ``locator`` by ``labels``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/selectelement.py", "lineno": 347}, {"name": "Unselect From List By Value", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "values", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*values: str"}], "returnType": null, "doc": "<p>Unselects options from selection list <code>locator</code> by <code>values</code>.</p>\n<p>This keyword works only with multi-selection lists.</p>\n<p>See the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>", "shortdoc": "Unselects options from selection list ``locator`` by ``values``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/selectelement.py", "lineno": 322}, {"name": "Wait For Condition", "args": [{"name": "condition", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "condition: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "error", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str | None = None"}], "returnType": null, "doc": "<p>Waits until <code>condition</code> is true or <code>timeout</code> expires.</p>\n<p>The condition can be arbitrary JavaScript expression but it must return a value to be evaluated. See <a href=\"#Execute%20Javascript\" class=\"name\">Execute JavaScript</a> for information about accessing content on pages.</p>\n<p>Fails if the timeout expires before the condition becomes true. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a></td>\n<td>return document.title == \"New Title\"</td>\n</tr>\n<tr>\n<td><a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a></td>\n<td>return jQuery.active == 0</td>\n</tr>\n<tr>\n<td><a href=\"#Wait%20For%20Condition\" class=\"name\">Wait For Condition</a></td>\n<td>style = document.querySelector('h1').style; return style.background == \"red\" && style.color == \"white\"</td>\n</tr>\n</table>", "shortdoc": "Waits until ``condition`` is true or ``timeout`` expires.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/waiting.py", "lineno": 31}, {"name": "Wait For Expected Condition", "args": [{"name": "condition", "type": {"name": "<module 'string' from '/Users/emanlove/.pyenv/versions/3.12.6/lib/python3.12/string.py'>", "typedoc": null, "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "condition: <module 'string' from '/Users/emanlove/.pyenv/versions/3.12.6/lib/python3.12/string.py'>"}, {"name": "args", "type": null, "defaultValue": null, "kind": "VAR_POSITIONAL", "required": false, "repr": "*args"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "10", "kind": "NAMED_ONLY", "required": false, "repr": "timeout: float | None = 10"}], "returnType": null, "doc": "<p>Waits until <code>condition</code> is true or <code>timeout</code> expires.</p>\n<p>The condition must be one of selenium's expected condition which can be found within the selenium <a href=\"https://www.selenium.dev/selenium/docs/api/py/webdriver_support/selenium.webdriver.support.expected_conditions.html#module-selenium.webdriver.support.expected_conditions\">Python API</a> documentation. The expected condition can written as snake_case (ex title_is) or it can be space delimited (ex Title Is). Some conditions require additional arguments or <code>args</code> which should be passed along after the expected condition.</p>\n<p>Fails if the timeout expires before the condition becomes true. The default value is 10 seconds.</p>\n<p>Examples:</p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Wait%20For%20Expected%20Condition\" class=\"name\">Wait For Expected Condition</a></td>\n<td>alert_is_present</td>\n<td></td>\n</tr>\n<tr>\n<td><a href=\"#Wait%20For%20Expected%20Condition\" class=\"name\">Wait For Expected Condition</a></td>\n<td>Title Is</td>\n<td>New Title</td>\n</tr>\n</table>\n<p>If the expected condition expects a locator then one can pass as arguments a tuple containing the selenium locator strategies and the locator.</p>\n<p>Example of expected condition expecting locator:</p>\n<pre>\n${byElem}= | Evaluate (\"id\",\"added_btn\")\n<a href=\"#Wait%20For%20Expected%20Condition\" class=\"name\">Wait For Expected Condition</a> | Presence Of Element Located | ${byElem}\n</pre>", "shortdoc": "Waits until ``condition`` is true or ``timeout`` expires.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/expectedconditions.py", "lineno": 24}, {"name": "Wait Until Element Contains", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "error", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str | None = None"}], "returnType": null, "doc": "<p>Waits until the element <code>locator</code> contains <code>text</code>.</p>\n<p>Fails if <code>timeout</code> expires before the text appears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>", "shortdoc": "Waits until the element ``locator`` contains ``text``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/waiting.py", "lineno": 373}, {"name": "Wait Until Element Does Not Contain", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "error", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str | None = None"}], "returnType": null, "doc": "<p>Waits until the element <code>locator</code> does not contain <code>text</code>.</p>\n<p>Fails if <code>timeout</code> expires before the text disappears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>", "shortdoc": "Waits until the element ``locator`` does not contain ``text``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/waiting.py", "lineno": 397}, {"name": "Wait Until Element Is Enabled", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "error", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str | None = None"}], "returnType": null, "doc": "<p>Waits until the element <code>locator</code> is enabled.</p>\n<p>Element is considered enabled if it is not disabled nor read-only.</p>\n<p>Fails if <code>timeout</code> expires before the element is enabled. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>Considering read-only elements to be disabled is a new feature in SeleniumLibrary 3.0.</p>", "shortdoc": "Waits until the element ``locator`` is enabled.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/waiting.py", "lineno": 345}, {"name": "Wait Until Element Is Not Visible", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "error", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str | None = None"}], "returnType": null, "doc": "<p>Waits until the element <code>locator</code> is not visible.</p>\n<p>Fails if <code>timeout</code> expires before the element is not visible. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>", "shortdoc": "Waits until the element ``locator`` is not visible.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/waiting.py", "lineno": 322}, {"name": "Wait Until Element Is Visible", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "error", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str | None = None"}], "returnType": null, "doc": "<p>Waits until the element <code>locator</code> is visible.</p>\n<p>Fails if <code>timeout</code> expires before the element is visible. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>", "shortdoc": "Waits until the element ``locator`` is visible.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/waiting.py", "lineno": 299}, {"name": "Wait Until Location Contains", "args": [{"name": "expected", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Waits until the current URL contains <code>expected</code>.</p>\n<p>The <code>expected</code> argument contains the expected value in url.</p>\n<p>Fails if <code>timeout</code> expires before the location contains. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>New in SeleniumLibrary 4.0</p>", "shortdoc": "Waits until the current URL contains ``expected``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/waiting.py", "lineno": 123}, {"name": "Wait Until Location Does Not Contain", "args": [{"name": "location", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "location: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Waits until the current URL does not contains <code>location</code>.</p>\n<p>The <code>location</code> argument contains value not expected in url.</p>\n<p>Fails if <code>timeout</code> expires before the location not contains. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>New in SeleniumLibrary 4.3</p>", "shortdoc": "Waits until the current URL does not contains ``location``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/waiting.py", "lineno": 151}, {"name": "Wait Until Location Is", "args": [{"name": "expected", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "expected: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Waits until the current URL is <code>expected</code>.</p>\n<p>The <code>expected</code> argument is the expected value in url.</p>\n<p>Fails if <code>timeout</code> expires before the location is. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>New in SeleniumLibrary 4.0</p>", "shortdoc": "Waits until the current URL is ``expected``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/waiting.py", "lineno": 66}, {"name": "Wait Until Location Is Not", "args": [{"name": "location", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "location: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "message", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "message: str | None = None"}], "returnType": null, "doc": "<p>Waits until the current URL is not <code>location</code>.</p>\n<p>The <code>location</code> argument is the unexpected value in url.</p>\n<p>Fails if <code>timeout</code> expires before the location is not. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p>The <code>message</code> argument can be used to override the default error message.</p>\n<p>New in SeleniumLibrary 4.3</p>", "shortdoc": "Waits until the current URL is not ``location``.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/waiting.py", "lineno": 95}, {"name": "Wait Until Page Contains", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "error", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str | None = None"}], "returnType": null, "doc": "<p>Waits until <code>text</code> appears on the current page.</p>\n<p>Fails if <code>timeout</code> expires before the text appears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p><code>error</code> can be used to override the default error message.</p>", "shortdoc": "Waits until ``text`` appears on the current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/waiting.py", "lineno": 179}, {"name": "Wait Until Page Contains Element", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "error", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str | None = None"}, {"name": "limit", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "limit: int | None = None"}], "returnType": null, "doc": "<p>Waits until the element <code>locator</code> appears on the current page.</p>\n<p>Fails if <code>timeout</code> expires before the element appears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>The <code>limit</code> argument can used to define how many elements the page should contain. When <code>limit</code> is <a href=\"#type-None\" class=\"name\">None</a> (default) page can contain one or more elements. When limit is a number, page must contain same number of elements.</p>\n<p><code>limit</code> is new in SeleniumLibrary 4.4</p>", "shortdoc": "Waits until the element ``locator`` appears on the current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/waiting.py", "lineno": 223}, {"name": "Wait Until Page Does Not Contain", "args": [{"name": "text", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "text: str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "error", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str | None = None"}], "returnType": null, "doc": "<p>Waits until <code>text</code> disappears from the current page.</p>\n<p>Fails if <code>timeout</code> expires before the text disappears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value.</p>\n<p><code>error</code> can be used to override the default error message.</p>", "shortdoc": "Waits until ``text`` disappears from the current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/waiting.py", "lineno": 201}, {"name": "Wait Until Page Does Not Contain Element", "args": [{"name": "locator", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "WebElement", "typedoc": null, "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": true}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "locator: WebElement | str"}, {"name": "timeout", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "timedelta", "typedoc": "timedelta", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "timeout: timedelta | None = None"}, {"name": "error", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "error: str | None = None"}, {"name": "limit", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "limit: int | None = None"}], "returnType": null, "doc": "<p>Waits until the element <code>locator</code> disappears from the current page.</p>\n<p>Fails if <code>timeout</code> expires before the element disappears. See the <span class=\"name\">Timeouts</span> section for more information about using timeouts and their default value and the <a href=\"#Locating%20elements\" class=\"name\">Locating elements</a> section for details about the locator syntax.</p>\n<p><code>error</code> can be used to override the default error message.</p>\n<p>The <code>limit</code> argument can used to define how many elements the page should not contain. When <code>limit</code> is <a href=\"#type-None\" class=\"name\">None</a> (default) page can`t contain any elements. When limit is a number, page must not contain same number of elements.</p>\n<p><code>limit</code> is new in SeleniumLibrary 4.4</p>", "shortdoc": "Waits until the element ``locator`` disappears from the current page.", "tags": [], "source": "/Users/emanlove/code/seleniumlibrary/rf-sl/src/SeleniumLibrary/keywords/waiting.py", "lineno": 261}], "typedocs": [{"type": "Standard", "name": "Any", "doc": "<p>Any value is accepted. No conversion is done.</p>", "usages": ["Execute Async Javascript", "Execute Javascript", "Open Browser"], "accepts": ["Any"]}, {"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": ["Add Cookie", "Add Location Strategy", "Click Button", "Click Element", "Click Image", "Click Link", "Element Should Contain", "Element Should Not Contain", "Element Text Should Be", "Element Text Should Not Be", "Get Cookies", "Get List Items", "Get Window Size", "Input Password", "Input Text", "Open Browser", "Print Page As Pdf", "Set Window Size"], "accepts": ["string", "integer", "float", "None"]}, {"type": "Standard", "name": "dictionary", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#dict\">dictionary</a> literals. They are converted to actual dictionaries using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including dictionaries and other containers.</p>\n<p>If the type has nested types like <code>dict[str, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>{'a': 1, 'b': 2}</code>, <code>{'key': 1, 'nested': {'key': 2}}</code></p>", "usages": ["Create Webdriver", "Get Cookies", "Open Browser"], "accepts": ["string", "Mapping"]}, {"type": "Standard", "name": "float", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#float\">float</a> built-in function.</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>3.14</code>, <code>2.9979e8</code>, <code>10 000.000 01</code></p>", "usages": ["Get Window Size", "Print Page As Pdf", "Wait For Expected Condition"], "accepts": ["string", "Real"]}, {"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": ["Click Element At Coordinates", "Drag And Drop By Offset", "Get Element Count", "Get Element Size", "Get Horizontal Position", "Get Table Cell", "Get Vertical Position", "Get Window Position", "Page Should Contain Element", "Set Window Position", "Set Window Size", "Table Cell Should Contain", "Table Column Should Contain", "Table Row Should Contain", "Wait Until Page Contains Element", "Wait Until Page Does Not Contain Element"], "accepts": ["string", "float"]}, {"type": "Standard", "name": "list", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#list\">list</a> literals. They are converted to actual lists using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including lists and other containers.</p>\n<p>If the type has nested types like <code>list[int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>['one', 'two']</code>, <code>[('one', 1), ('two', 2)]</code></p>", "usages": ["Get All Links", "Get Browser Aliases", "Get Browser Ids", "Get List Items", "Get Locations", "Get Selected List Labels", "Get Selected List Values", "Get WebElements", "Get Window Handles", "Get Window Identifiers", "Get Window Names", "Get Window Titles", "Page Should Contain Element", "Print Page As Pdf", "Switch Window"], "accepts": ["string", "Sequence"]}, {"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__", "Add Cookie", "Alert Should Be Present", "Alert Should Not Be Present", "Create Webdriver", "Element Attribute Value Should Be", "Element Should Be Visible", "Element Should Contain", "Element Should Not Be Visible", "Element Should Not Contain", "Element Text Should Be", "Element Text Should Not Be", "Handle Alert", "Input Text Into Alert", "Location Should Be", "Location Should Contain", "Open Browser", "Page Should Contain Button", "Page Should Contain Checkbox", "Page Should Contain Element", "Page Should Contain Image", "Page Should Contain Link", "Page Should Contain List", "Page Should Contain Radio Button", "Page Should Contain Textfield", "Page Should Not Contain Button", "Page Should Not Contain Checkbox", "Page Should Not Contain Element", "Page Should Not Contain Image", "Page Should Not Contain Link", "Page Should Not Contain List", "Page Should Not Contain Radio Button", "Page Should Not Contain Textfield", "Press Keys", "Print Page As Pdf", "Register Keyword To Run On Failure", "Set Screenshot Directory", "Submit Form", "Switch Window", "Textarea Should Contain", "Textarea Value Should Be", "Textfield Should Contain", "Textfield Value Should Be", "Title Should Be", "Wait For Condition", "Wait For Expected Condition", "Wait Until Element Contains", "Wait Until Element Does Not Contain", "Wait Until Element Is Enabled", "Wait Until Element Is Not Visible", "Wait Until Element Is Visible", "Wait Until Location Contains", "Wait Until Location Does Not Contain", "Wait Until Location Is", "Wait Until Location Is Not", "Wait Until Page Contains", "Wait Until Page Contains Element", "Wait Until Page Does Not Contain", "Wait Until Page Does Not Contain Element"], "accepts": ["string"]}, {"type": "Standard", "name": "string", "doc": "<p>All arguments are converted to Unicode strings.</p>", "usages": ["__init__", "Add Cookie", "Add Location Strategy", "Alert Should Be Present", "Alert Should Not Be Present", "Assign Id To Element", "Capture Element Screenshot", "Capture Page Screenshot", "Checkbox Should Be Selected", "Checkbox Should Not Be Selected", "Choose File", "Clear Element Text", "Click Button", "Click Element", "Click Element At Coordinates", "Click Image", "Click Link", "Cover Element", "Create Webdriver", "Current Frame Should Contain", "Current Frame Should Not Contain", "Double Click Element", "Drag And Drop", "Drag And Drop By Offset", "Element Attribute Value Should Be", "Element Should Be Disabled", "Element Should Be Enabled", "Element Should Be Focused", "Element Should Be Visible", "Element Should Contain", "Element Should Not Be Visible", "Element Should Not Contain", "Element Text Should Be", "Element Text Should Not Be", "Frame Should Contain", "Get All Links", "Get Browser Aliases", "Get Browser Ids", "Get Cookie", "Get Cookies", "Get Dom Attribute", "Get Element Attribute", "Get Element Count", "Get Element Size", "Get Horizontal Position", "Get List Items", "Get Location", "Get Locations", "Get Property", "Get Selected List Label", "Get Selected List Labels", "Get Selected List Value", "Get Selected List Values", "Get Selenium Implicit Wait", "Get Selenium Page Load Timeout", "Get Selenium Speed", "Get Selenium Timeout", "Get Session Id", "Get Source", "Get Table Cell", "Get Text", "Get Title", "Get Value", "Get Vertical Position", "Get WebElement", "Get WebElements", "Get Window Handles", "Get Window Identifiers", "Get Window Names", "Get Window Titles", "Handle Alert", "Input Password", "Input Text", "Input Text Into Alert", "List Selection Should Be", "List Should Have No Selections", "Location Should Be", "Location Should Contain", "Log Location", "Log Source", "Log Title", "Mouse Down", "Mouse Down On Image", "Mouse Down On Link", "Mouse Out", "Mouse Over", "Mouse Up", "Open Browser", "Open Context Menu", "Page Should Contain", "Page Should Contain Button", "Page Should Contain Checkbox", "Page Should Contain Element", "Page Should Contain Image", "Page Should Contain Link", "Page Should Contain List", "Page Should Contain Radio Button", "Page Should Contain Textfield", "Page Should Not Contain", "Page Should Not Contain Button", "Page Should Not Contain Checkbox", "Page Should Not Contain Element", "Page Should Not Contain Image", "Page Should Not Contain Link", "Page Should Not Contain List", "Page Should Not Contain Radio Button", "Page Should Not Contain Textfield", "Press Key", "Press Keys", "Print Page As Pdf", "Radio Button Should Be Set To", "Radio Button Should Not Be Selected", "Register Keyword To Run On Failure", "Remove Location Strategy", "Scroll Element Into View", "Select All From List", "Select Checkbox", "Select Frame", "Select From List By Index", "Select From List By Label", "Select From List By Value", "Select Radio Button", "Set Action Chain Delay", "Set Focus To Element", "Set Screenshot Directory", "Set Selenium Implicit Wait", "Set Selenium Page Load Timeout", "Set Selenium Speed", "Set Selenium Timeout", "Simulate Event", "Submit Form", "Switch Browser", "Switch Window", "Table Cell Should Contain", "Table Column Should Contain", "Table Footer Should Contain", "Table Header Should Contain", "Table Row Should Contain", "Table Should Contain", "Textarea Should Contain", "Textarea Value Should Be", "Textfield Should Contain", "Textfield Value Should Be", "Title Should Be", "Unselect All From List", "Unselect Checkbox", "Unselect From List By Index", "Unselect From List By Label", "Unselect From List By Value", "Wait For Condition", "Wait Until Element Contains", "Wait Until Element Does Not Contain", "Wait Until Element Is Enabled", "Wait Until Element Is Not Visible", "Wait Until Element Is Visible", "Wait Until Location Contains", "Wait Until Location Does Not Contain", "Wait Until Location Is", "Wait Until Location Is Not", "Wait Until Page Contains", "Wait Until Page Contains Element", "Wait Until Page Does Not Contain", "Wait Until Page Does Not Contain Element"], "accepts": ["Any"]}, {"type": "Standard", "name": "timedelta", "doc": "<p>Strings are expected to represent a time interval in one of the time formats Robot Framework supports:</p>\n<ul>\n<li>a number representing seconds like <code>42</code> or <code>10.5</code></li>\n<li>a time string like <code>1 hour 2 seconds</code> or <code>1h 2s</code></li>\n<li>a \"timer\" string like <code>01:02</code> (1 minute 2 seconds) or <code>01:00:03</code> (1 hour 3 seconds)</li>\n</ul>\n<p>Integers and floats are considered to be seconds.</p>\n<p>See the <a href=\"https://robotframework.org/robotframework/\">Robot Framework User Guide</a> for more details about the supported time formats.</p>", "usages": ["Alert Should Be Present", "Alert Should Not Be Present", "Handle Alert", "Input Text Into Alert", "Set Action Chain Delay", "Set Browser Implicit Wait", "Set Selenium Implicit Wait", "Set Selenium Page Load Timeout", "Set Selenium Speed", "Set Selenium Timeout", "Wait For Condition", "Wait Until Element Contains", "Wait Until Element Does Not Contain", "Wait Until Element Is Enabled", "Wait Until Element Is Not Visible", "Wait Until Element Is Visible", "Wait Until Location Contains", "Wait Until Location Does Not Contain", "Wait Until Location Is", "Wait Until Location Is Not", "Wait Until Page Contains", "Wait Until Page Contains Element", "Wait Until Page Does Not Contain", "Wait Until Page Does Not Contain Element"], "accepts": ["string", "integer", "float"]}, {"type": "Standard", "name": "tuple", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#tuple\">tuple</a> literals. They are converted to actual tuples using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including tuples and other containers.</p>\n<p>If the type has nested types like <code>tuple[str, int, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>('one', 'two')</code>, <code>(('one', 1), ('two', 2))</code></p>", "usages": ["Get Element Size", "Get Window Position", "Get Window Size"], "accepts": ["string", "Sequence"]}]}

</script>

window.dataLayer = window.dataLayer || [];

function gtag(){dataLayer.push(arguments);}

gtag('js', new Date());

gtag('config', 'UA-106835747-4', {

'anonymize_ip': true,

'page_path': location.pathname+location.search+location.hash });

window.onhashchange = function() {

gtag('event', 'HashChange', {

'event_category': 'Subsection',

'event_label': window.location.hash

});

}

</script></head>

<body>

<h1>Opening library documentation failed</h1>

<ul>

<li>Verify that you have <b>JavaScript enabled</b> in your browser.</li>

<li>

Make sure you are using a <b>modern enough browser</b>. If using

Internet Explorer, version 11 is required.

</li>

<li>

Check are there messages in your browser's

<b>JavaScript error log</b>. Please report the problem if you suspect

you have encountered a bug.

</li>

</ul>

</div>

</div>

<input

id="hamburger-menu-input"

class="hamburger-menu"

type="checkbox"

{{#if version}}<tr><th>{{t "libVersion"}}:</th><td

>{{version}}</td></tr>{{/if}}

{{#if scope}}<tr><th>{{t "libScope"}}:</th><td

>{{scope}}</td></tr>{{/if}}

</table>

<h2 id="introduction">{{t "intro"}}</h2>

</div>

</div>

<svg

xmlns:dc="http://purl.org/dc/elements/1.1/"

xmlns:cc="http://creativecommons.org/ns#"

xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"

xmlns:svg="http://www.w3.org/2000/svg"

xmlns="http://www.w3.org/2000/svg"

viewBox="0 0 202.4325 202.34125"

height="42"

width="42"

xml:space="preserve"

version="1.1"

><metadata id="metadata8"><rdf:RDF><cc:Work rdf:about=""><dc:format

>image/svg+xml</dc:format><dc:type

rdf:resource="http://purl.org/dc/dcmitype/StillImage"

/></cc:Work></rdf:RDF></metadata><defs id="defs6"><clipPath

id="clipPath16"

clipPathUnits="userSpaceOnUse"

><path

id="path18"

d="m 0,161.873 161.946,0 L 161.946,0 0,0 0,161.873 Z"

/></clipPath></defs><g

transform="matrix(1.25,0,0,-1.25,0,202.34125)"

id="g10"

><g id="g12"><g clip-path="url(#clipPath16)" id="g14"><g

transform="translate(52.4477,88.1268)"

id="g20"

><path

id="robot-svg-path"

d="m 0,0 c 0,7.6 6.179,13.779 13.77,13.779 7.6,0 13.779,-6.179 13.779,-13.779 0,-2.769 -2.238,-5.007 -4.998,-5.007 -2.761,0 -4.999,2.238 -4.999,5.007 0,2.078 -1.695,3.765 -3.782,3.765 C 11.693,3.765 9.997,2.078 9.997,0 9.997,-2.769 7.76,-5.007 4.999,-5.007 2.238,-5.007 0,-2.769 0,0 m 57.05,-23.153 c 0,-2.771 -2.237,-5.007 -4.998,-5.007 l -46.378,0 c -2.761,0 -4.999,2.236 -4.999,5.007 0,2.769 2.238,5.007 4.999,5.007 l 46.378,0 c 2.761,0 4.998,-2.238 4.998,-5.007 M 35.379,-2.805 c -1.545,2.291 -0.941,5.398 1.35,6.943 l 11.594,7.83 c 2.273,1.58 5.398,0.941 6.943,-1.332 1.545,-2.29 0.941,-5.398 -1.35,-6.943 l -11.594,-7.83 c -0.852,-0.586 -1.829,-0.87 -2.788,-0.87 -1.607,0 -3.187,0.781 -4.155,2.202 m 31.748,-30.786 c 0,-0.945 -0.376,-1.852 -1.045,-2.522 l -8.617,-8.617 c -0.669,-0.668 -1.576,-1.045 -2.523,-1.045 l -52.833,0 c -0.947,0 -1.854,0.377 -2.523,1.045 l -8.617,8.617 c -0.669,0.67 -1.045,1.577 -1.045,2.522 l 0,52.799 c 0,0.947 0.376,1.854 1.045,2.522 l 8.617,8.619 c 0.669,0.668 1.576,1.044 2.523,1.044 l 52.833,0 c 0.947,0 1.854,-0.376 2.523,-1.044 l 8.617,-8.619 c 0.669,-0.668 1.045,-1.575 1.045,-2.522 l 0,-52.799 z m 7.334,61.086 -11.25,11.25 c -1.705,1.705 -4.018,2.663 -6.428,2.663 l -56.523,0 c -2.412,0 -4.725,-0.959 -6.43,-2.665 L -17.412,27.494 c -1.704,-1.705 -2.661,-4.016 -2.661,-6.427 l 0,-56.515 c 0,-2.411 0.958,-4.725 2.663,-6.428 l 11.25,-11.25 c 1.705,-1.705 4.017,-2.662 6.428,-2.662 l 56.515,0 c 2.41,0 4.723,0.957 6.428,2.662 l 11.25,11.25 c 1.705,1.703 2.663,4.017 2.663,6.428 l 0,56.514 c 0,2.412 -0.958,4.724 -2.663,6.429"

/></g></g></g></g></svg>

</a>

</div>

</script>

<path stroke-width="26"

d="M209,15a195,195 0 1,0 2,0z"/>

<path stroke-width="18"

d="m210,15v390m195-195H15M59,90a260,260 0 0,0 302,0 m0,240 a260,260 0 0,0-302,0M195,20a250,250 0 0,0 0,382 m30,0 a250,250 0 0,0 0-382"/>

</svg>

</button>

</ul>

</script>

<h2 id="Importing">{{t "importing"}}</h2>

<h4>{{t "arguments"}}</h4>

</div>

</div>

</script>

<input

placeholder="{{t 'search'}}"

type="text"

class="search-input"

</div>

</select>

<h4>{{t "keywords"}}

(<span id="keyword-statistics-header"></span>)

</h4>

</div>

</ul>

</div>

</script>

<li>

href="#{{encodeURIComponent this.name}}"

class="match"

title="{{value.shortdoc}}"

>{{this.name}}</a>

</li>

<li>

href="#{{encodeURIComponent this.name}}"

class="no-match"

title="{{value.shortdoc}}"

>{{this.name}}</a>

</li>

</script>

<h2 id="Keywords">{{t "keywords"}}</h2>

</div>

</script>

<h2>

<a class="kw-name" href="#{{encodeURIComponent name}}"

title="{{t 'kwLink'}}">{{name}}</a>

</h2>

</div>

<h4>{{t "arguments"}}</h4>

</div>

<h4>{{t "returnType"}}</h4>

</span>

</div>

<span class="tag-link"

title="Show keywords with this tag">{{this}}</span>{{#unless @last}},<br>{{/unless}}

</span>

</div>

</div>

</script>

{{#ifEquals kind "VAR_POSITIONAL"}}<span class="arg-kind" title="{{t 'varArgs'}}">*</span>{{/ifEquals}}

{{#ifEquals kind "VAR_NAMED"}}<span class="arg-kind" title="{{t 'varNamedArgs'}}">**</span>{{/ifEquals}}

{{#ifEquals kind "NAMED_ONLY"}}<span class="arg-kind" title="{{t 'namedOnlyArg'}}">🏷</span>{{/ifEquals}}

{{#ifEquals kind "POSITIONAL_ONLY"}}<span class="arg-kind" title="{{t 'posOnlyArg'}}">⟶</span>{{/ifEquals}}

</span>

<span class="arg-default-value" title="{{t 'defaultTitle'}}">{{defaultValue}}</span>

</div>

</span>

</script>

<option {{#ifEquals ../selectedTag this}}selected{{/ifEquals}}>{{this}}

</option>

</script>

{{#unless @last}}|{{/unless}}

[

{{~#unless @last}}, {{/unless}}

]

</script>

<h2 id="Data types">{{t "dataTypes"}}</h2>

</div>

</script>

</div>

</div>

<h4>{{t "allowedValues"}}</h4>

<li>

  (<span class="enum-member">{{value.value}}</span>)

</li>

</ul>

</div>

<h4>{{t "dictStructure"}}</h4>

{

{{#each items}}<br><span

class="td-item {{#if required}}required-key{{else}}optional-key{{/if}}"

title="{{#if required}}required-key{{else}}optional-key{{/if}}"

class="td-item"

>'{{key}}': </span>

{{/each}}<br>

}</span>

</div>

<h4>{{t "convertedTypes"}}</h4>

</ul>

</div>

<h4>{{t "usages"}}</h4>

</ul>

</div>

</script>

href="http://robotframework.org/robotframework/#built-in-tools"

>Libdoc</a>

{{generated}}.

</p>

</script>

http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="2em" height="2em" className="block" data-v-2754030d="" data-v-512b0344="">

<path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"

data-v-2754030d="" fill="var(--text-color)"></path></svg>`,t.classList.add("modal-close-button");let r=document.createElement("div");r.classList.add("modal-close-button-container"),r.appendChild(t),t.addEventListener("click",()=>{rd()}),e.appendChild(r),r.addEventListener("click",()=>{rd()});let n=document.createElement("div");n.id="modal",n.classList.add("modal"),n.addEventListener("click",({target:e})=>{"A"===e.tagName.toUpperCase()&&rd()});let o=document.createElement("div");o.id="modal-content",o.classList.add("modal-content"),n.appendChild(o),e.appendChild(n),document.body.appendChild(e),document.addEventListener("keydown",({key:e})=>{"Escape"===e&&rd()})}()}renderTemplates(){this.renderLibdocTemplate("base",this.libdoc,"#root"),this.renderImporting(),this.renderShortcuts(),this.renderKeywords(),this.renderLibdocTemplate("data-types"),document.querySelectorAll(".dtdoc pre, .kwdoc pre").forEach(e=>{e.textContent=e.textContent.split("\n").map(e=>e.trim()).join("\n")}),this.renderLibdocTemplate("footer")}initHashEvents(){window.addEventListener("hashchange",function(){document.getElementsByClassName("hamburger-menu")[0].checked=!1},!1),window.addEventListener("hashchange",function(){if(0==window.location.hash.indexOf("#type-")){let e="#type-modal-"+decodeURI(window.location.hash.slice(6)),t=document.querySelector(".data-types").querySelector(e);t&&rp(t)}},!1),this.scrollToHash()}initTagSearch(){let e=new URLSearchParams(window.location.search),t="";e.has("tag")&&(t=e.get("tag"),this.tagSearch(t,window.location.hash)),this.libdoc.tags.length&&(this.libdoc.selectedTag=t,this.renderLibdocTemplate("tags-shortcuts"),document.getElementById("tags-shortcuts-container").onchange=e=>{let t=e.target.selectedOptions[0].value;""!=t?this.tagSearch(t):this.clearTagSearch()})}initLanguageMenu(){this.renderTemplate("language",{languages:this.translations.getLanguageCodes()}),document.querySelectorAll("#language-container ul a").forEach(e=>{e.innerHTML===this.translations.currentLanguage()&&e.classList.toggle("selected"),e.addEventListener("click",()=>{this.translations.setLanguage(e.innerHTML)&&this.render()})}),document.querySelector("#language-container button").addEventListener("click",()=>{document.querySelector("#language-container ul").classList.toggle("hidden")})}renderImporting(){this.renderLibdocTemplate("importing"),this.registerTypeDocHandlers("#importing-container")}renderShortcuts(){this.renderLibdocTemplate("shortcuts"),document.getElementById("toggle-keyword-shortcuts").addEventListener("click",()=>this.toggleShortcuts()),document.querySelector(".clear-search").addEventListener("click",()=>this.clearSearch()),document.querySelector(".search-input").addEventListener("keydown",()=>rf(()=>this.searching(),150)),this.renderLibdocTemplate("keyword-shortcuts"),document.querySelectorAll("a.match").forEach(e=>e.addEventListener("click",this.closeMenu))}registerTypeDocHandlers(e){document.querySelectorAll(`${e} a.type`).forEach(e=>e.addEventListener("click",e=>{let t=e.target.dataset.typedoc;rp(document.querySelector(`#type-modal-${t}`))}))}renderKeywords(e=null){null==e&&(e=this.libdoc),this.renderLibdocTemplate("keywords",e),document.querySelectorAll(".kw-tags span").forEach(e=>{e.addEventListener("click",e=>{this.tagSearch(e.target.innerText)})}),this.registerTypeDocHandlers("#keywords-container"),document.getElementById("keyword-statistics-header").innerText=""+this.libdoc.keywords.length}setTheme(){document.documentElement.setAttribute("data-theme",this.getTheme())}getTheme(){return null!=this.libdoc.theme?this.libdoc.theme:window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light"}scrollToHash(){if(window.location.hash){let e=window.location.hash.substring(1),t=document.getElementById(decodeURIComponent(e));null!=t&&t.scrollIntoView()}}tagSearch(e,t){document.getElementsByClassName("search-input")[0].value="";let r={tags:!0,tagsExact:!0},n=window.location.pathname+"?tag="+e+(t||"");this.markMatches(e,r),this.highlightMatches(e,r),history.replaceState&&history.replaceState(null,"",n),document.getElementById("keyword-shortcuts-container").scrollTop=0}clearTagSearch(){document.getElementsByClassName("search-input")[0].value="",history.replaceState&&history.replaceState(null,"",window.location.pathname),this.resetKeywords()}searching(){this.searchTime=Date.now();let e=document.getElementsByClassName("search-input")[0].value,t={name:!0,args:!0,doc:!0,tags:!0};e?requestAnimationFrame(()=>{this.markMatches(e,t,this.searchTime,()=>{this.highlightMatches(e,t,this.searchTime),document.getElementById("keyword-shortcuts-container").scrollTop=0})}):this.resetKeywords()}highlightMatches(e,t,n){if(n&&n!==this.searchTime)return;let o=document.querySelectorAll("#shortcuts-container .match"),i=document.querySelectorAll("#keywords-container .match");if(t.name&&(new(r(eb))(o).mark(e),new(r(eb))(i).mark(e)),t.args&&new(r(eb))(document.querySelectorAll("#keywords-container .match .args")).mark(e),t.doc&&new(r(eb))(document.querySelectorAll("#keywords-container .match .doc")).mark(e),t.tags){let n=document.querySelectorAll("#keywords-container .match .tags a, #tags-shortcuts-container .match .tags a");if(t.tagsExact){let t=[];n.forEach(r=>{r.textContent?.toUpperCase()==e.toUpperCase()&&t.push(r)}),new(r(eb))(t).mark(e)}else new(r(eb))(n).mark(e)}}markMatches(e,t,r,n){if(r&&r!==this.searchTime)return;let o=e.replace(/[-[\]{}()+?*.,\\^$|#]/g,"\\$&");t.tagsExact&&(o="^"+o+"$");let i=RegExp(o,"i"),a=i.test.bind(i),s={},l=0;s.keywords=this.libdoc.keywords.map(e=>{let r={...e};return r.hidden=!(t.name&&a(r.name))&&!(t.args&&a(r.args))&&!(t.doc&&a(r.doc))&&!(t.tags&&r.tags.some(a)),!r.hidden&&l++,r}),this.renderLibdocTemplate("keyword-shortcuts",s),this.renderKeywords(s),this.libdoc.tags.length&&(this.libdoc.selectedTag=t.tagsExact?e:"",this.renderLibdocTemplate("tags-shortcuts")),document.getElementById("keyword-statistics-header").innerText=l+" / "+s.keywords.length,0===l&&(document.querySelector("#keywords-container table").innerHTML=""),n&&requestAnimationFrame(n)}closeMenu(){document.getElementById("hamburger-menu-input").checked=!1}openKeywordWall(){document.getElementsByClassName("shortcuts")[0].classList.add("keyword-wall"),this.storage.set("keyword-wall","open"),document.getElementById("toggle-keyword-shortcuts").innerText="-"}closeKeywordWall(){document.getElementsByClassName("shortcuts")[0].classList.remove("keyword-wall"),this.storage.set("keyword-wall","close"),document.getElementById("toggle-keyword-shortcuts").innerText="+"}toggleShortcuts(){document.getElementsByClassName("shortcuts")[0].classList.contains("keyword-wall")?this.closeKeywordWall():this.openKeywordWall()}resetKeywords(){this.renderLibdocTemplate("keyword-shortcuts"),this.renderKeywords(),this.libdoc.tags.length&&(this.libdoc.selectedTag="",this.renderLibdocTemplate("tags-shortcuts")),history.replaceState&&history.replaceState(null,"",location.pathname)}clearSearch(){document.getElementsByClassName("search-input")[0].value="";let e=document.getElementById("tags-shortcuts-container");e&&(e.selectedIndex=0),this.resetKeywords()}renderLibdocTemplate(e,t=null,r=""){null==t&&(t=this.libdoc),this.renderTemplate(e,t,r)}renderTemplate(e,t,n=""){let o=document.getElementById(`${e}-template`)?.innerHTML,i=r(ew).compile(o);""===n&&(n=`#${e}-container`),document.body.querySelector(n).innerHTML=i(t)}};!function(e){let t=new ek("libdoc"),r=eS.getInstance(e.lang);new rg(e,t,r).render()}(libdoc);</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

SeleniumLibrary.html

Latest commit

History

SeleniumLibrary.html

File metadata and controls