| <!DOCTYPE html> |
| |
| <html lang="en" data-content_root="../"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <meta http-equiv="x-ua-compatible" content="ie=edge"> |
| <meta name="lang:clipboard.copy" content="Copy to clipboard"> |
| <meta name="lang:clipboard.copied" content="Copied to clipboard"> |
| <meta name="lang:search.language" content="en"> |
| <meta name="lang:search.pipeline.stopwords" content="True"> |
| <meta name="lang:search.pipeline.trimmer" content="True"> |
| <meta name="lang:search.result.none" content="No matching documents"> |
| <meta name="lang:search.result.one" content="1 matching document"> |
| <meta name="lang:search.result.other" content="# matching documents"> |
| <meta name="lang:search.tokenizer" content="[\s\-]+"> |
| |
| |
| <link href="https://fonts.gstatic.com/" rel="preconnect" crossorigin> |
| <link href="https://fonts.googleapis.com/css?family=Roboto+Mono:400,500,700|Roboto:300,400,400i,700&display=fallback" rel="stylesheet"> |
| |
| <style> |
| body, |
| input { |
| font-family: "Roboto", "Helvetica Neue", Helvetica, Arial, sans-serif |
| } |
| |
| code, |
| kbd, |
| pre { |
| font-family: "Roboto Mono", "Courier New", Courier, monospace |
| } |
| </style> |
| |
| |
| <link rel="stylesheet" href="../_static/stylesheets/application.css"/> |
| <link rel="stylesheet" href="../_static/stylesheets/application-palette.css"/> |
| <link rel="stylesheet" href="../_static/stylesheets/application-fixes.css"/> |
| |
| <link rel="stylesheet" href="../_static/fonts/material-icons.css"/> |
| |
| <meta name="theme-color" content="#3f51b5"> |
| <script src="../_static/javascripts/modernizr.js"></script> |
| |
| |
| |
| <title>selenium.webdriver.common.utils — Selenium 4.35.0.202506301117 documentation</title> |
| <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" /> |
| <link rel="stylesheet" type="text/css" href="../_static/material.css?v=79c92029" /> |
| <script src="../_static/documentation_options.js?v=9464611f"></script> |
| <script src="../_static/doctools.js?v=9a2dae69"></script> |
| <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> |
| <link rel="index" title="Index" href="../genindex.html" /> |
| <link rel="search" title="Search" href="../search.html" /> |
| |
| |
| |
| </head> |
| <body dir=ltr |
| data-md-color-primary=blue-grey data-md-color-accent=blue> |
| |
| <svg class="md-svg"> |
| <defs data-children-count="0"> |
| |
| <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg> |
| |
| </defs> |
| </svg> |
| |
| <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer"> |
| <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search"> |
| <label class="md-overlay" data-md-component="overlay" for="__drawer"></label> |
| <a href="#webdriver/selenium.webdriver.common.utils" tabindex="1" class="md-skip"> Skip to content </a> |
| <header class="md-header" data-md-component="header"> |
| <nav class="md-header-nav md-grid"> |
| <div class="md-flex navheader"> |
| <div class="md-flex__cell md-flex__cell--shrink"> |
| <a href="../index.html" title="Selenium 4.35.0.202506301117 documentation" |
| class="md-header-nav__button md-logo"> |
| |
| |
| |
| </a> |
| </div> |
| <div class="md-flex__cell md-flex__cell--shrink"> |
| <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> |
| </div> |
| <div class="md-flex__cell md-flex__cell--stretch"> |
| <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> |
| <span class="md-header-nav__topic">Selenium 4.35.0.202506301117 documentation</span> |
| <span class="md-header-nav__topic"> selenium.webdriver.common.utils </span> |
| </div> |
| </div> |
| <div class="md-flex__cell md-flex__cell--shrink"> |
| <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> |
| |
| <div class="md-search" data-md-component="search" role="dialog"> |
| <label class="md-search__overlay" for="__search"></label> |
| <div class="md-search__inner" role="search"> |
| <form class="md-search__form" action="../search.html" method="get" name="search"> |
| <input type="text" class="md-search__input" name="q" placeholder=""Search"" |
| autocapitalize="off" autocomplete="off" spellcheck="false" |
| data-md-component="query" data-md-state="active"> |
| <label class="md-icon md-search__icon" for="__search"></label> |
| <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> |
|  |
| </button> |
| </form> |
| <div class="md-search__output"> |
| <div class="md-search__scrollwrap" data-md-scrollfix> |
| <div class="md-search-result" data-md-component="result"> |
| <div class="md-search-result__meta"> |
| Type to start searching |
| </div> |
| <ol class="md-search-result__list"></ol> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| </div> |
| |
| |
| |
| <script src="../_static/javascripts/version_dropdown.js"></script> |
| <script> |
| var json_loc = "../"versions.json"", |
| target_loc = "../../", |
| text = "Versions"; |
| $( document ).ready( add_version_dropdown(json_loc, target_loc, text)); |
| </script> |
| |
| |
| </div> |
| </nav> |
| </header> |
| |
| |
| <div class="md-container"> |
| |
| |
| |
| <nav class="md-tabs" data-md-component="tabs"> |
| <div class="md-tabs__inner md-grid"> |
| <ul class="md-tabs__list"> |
| <li class="md-tabs__item"><a href="../index.html" class="md-tabs__link">Selenium 4.35.0.202506301117 documentation</a></li> |
| </ul> |
| </div> |
| </nav> |
| <main class="md-main"> |
| <div class="md-main__inner md-grid" data-md-component="container"> |
| |
| <div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> |
| <div class="md-sidebar__scrollwrap"> |
| <div class="md-sidebar__inner"> |
| <nav class="md-nav md-nav--primary" data-md-level="0"> |
| <label class="md-nav__title md-nav__title--site" for="__drawer"> |
| <a href="../index.html" title="Selenium 4.35.0.202506301117 documentation" class="md-nav__button md-logo"> |
| |
| <img src="../_static/" alt=" logo" width="48" height="48"> |
| |
| </a> |
| <a href="../index.html" |
| title="Selenium 4.35.0.202506301117 documentation">Selenium 4.35.0.202506301117 documentation</a> |
| </label> |
| |
| |
| </nav> |
| </div> |
| </div> |
| </div> |
| <div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> |
| <div class="md-sidebar__scrollwrap"> |
| <div class="md-sidebar__inner"> |
| |
| <nav class="md-nav md-nav--secondary"> |
| <label class="md-nav__title" for="__toc">"Contents"</label> |
| <ul class="md-nav__list" data-md-scrollfix=""> |
| <li class="md-nav__item"><a href="#webdriver-selenium-webdriver-common-utils--page-root" class="md-nav__link">selenium.webdriver.common.utils</a><nav class="md-nav"> |
| <ul class="md-nav__list"> |
| <li class="md-nav__item"><a href="#selenium.webdriver.common.utils.free_port" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">free_port()</span></code></a> |
| </li> |
| <li class="md-nav__item"><a href="#selenium.webdriver.common.utils.find_connectable_ip" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">find_connectable_ip()</span></code></a> |
| </li> |
| <li class="md-nav__item"><a href="#selenium.webdriver.common.utils.join_host_port" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">join_host_port()</span></code></a> |
| </li> |
| <li class="md-nav__item"><a href="#selenium.webdriver.common.utils.is_connectable" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">is_connectable()</span></code></a> |
| </li> |
| <li class="md-nav__item"><a href="#selenium.webdriver.common.utils.is_url_connectable" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">is_url_connectable()</span></code></a> |
| </li> |
| <li class="md-nav__item"><a href="#selenium.webdriver.common.utils.keys_to_typing" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">keys_to_typing()</span></code></a> |
| </li></ul> |
| </nav> |
| </li> |
| |
| <li class="md-nav__item"><a class="md-nav__extra_link" href="../_sources/webdriver/selenium.webdriver.common.utils.rst.txt">Show Source</a> </li> |
| |
| <li id="searchbox" class="md-nav__item"></li> |
| |
| </ul> |
| </nav> |
| </div> |
| </div> |
| </div> |
| |
| <div class="md-content"> |
| <article class="md-content__inner md-typeset" role="main"> |
| |
| <section id="module-selenium.webdriver.common.utils"> |
| <span id="selenium-webdriver-common-utils"></span><h1 id="webdriver-selenium-webdriver-common-utils--page-root">selenium.webdriver.common.utils<a class="headerlink" href="#webdriver-selenium-webdriver-common-utils--page-root" title="Link to this heading">¶</a></h1> |
| <p>The Utils methods.</p> |
| <p class="rubric">Functions</p> |
| <table class="autosummary longtable docutils align-default"> |
| <tbody> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#selenium.webdriver.common.utils.find_connectable_ip" title="selenium.webdriver.common.utils.find_connectable_ip"><code class="xref py py-obj docutils literal notranslate"><span class="pre">find_connectable_ip</span></code></a>(host[, port])</p></td> |
| <td><p>Resolve a hostname to an IP, preferring IPv4 addresses.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#selenium.webdriver.common.utils.free_port" title="selenium.webdriver.common.utils.free_port"><code class="xref py py-obj docutils literal notranslate"><span class="pre">free_port</span></code></a>()</p></td> |
| <td><p>Determines a free port using sockets.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#selenium.webdriver.common.utils.is_connectable" title="selenium.webdriver.common.utils.is_connectable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_connectable</span></code></a>(port[, host])</p></td> |
| <td><p>Tries to connect to the server at port to see if it is running.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#selenium.webdriver.common.utils.is_url_connectable" title="selenium.webdriver.common.utils.is_url_connectable"><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_url_connectable</span></code></a>(port)</p></td> |
| <td><p>Tries to connect to the HTTP server at /status path and specified port to see if it responds successfully.</p></td> |
| </tr> |
| <tr class="row-odd"><td><p><a class="reference internal" href="#selenium.webdriver.common.utils.join_host_port" title="selenium.webdriver.common.utils.join_host_port"><code class="xref py py-obj docutils literal notranslate"><span class="pre">join_host_port</span></code></a>(host, port)</p></td> |
| <td><p>Joins a hostname and port together.</p></td> |
| </tr> |
| <tr class="row-even"><td><p><a class="reference internal" href="#selenium.webdriver.common.utils.keys_to_typing" title="selenium.webdriver.common.utils.keys_to_typing"><code class="xref py py-obj docutils literal notranslate"><span class="pre">keys_to_typing</span></code></a>(value)</p></td> |
| <td><p>Processes the values that will be typed in the element.</p></td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="selenium.webdriver.common.utils.free_port"> |
| <span class="sig-prename descclassname"><span class="pre">selenium.webdriver.common.utils.</span></span><span class="sig-name descname"><span class="pre">free_port</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="../_modules/selenium/webdriver/common/utils.html#free_port"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#selenium.webdriver.common.utils.free_port" title="Link to this definition">¶</a></dt> |
| <dd><p>Determines a free port using sockets.</p> |
| </dd></dl> |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="selenium.webdriver.common.utils.find_connectable_ip"> |
| <span class="sig-prename descclassname"><span class="pre">selenium.webdriver.common.utils.</span></span><span class="sig-name descname"><span class="pre">find_connectable_ip</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bytes</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bytearray</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="../_modules/selenium/webdriver/common/utils.html#find_connectable_ip"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#selenium.webdriver.common.utils.find_connectable_ip" title="Link to this definition">¶</a></dt> |
| <dd><p>Resolve a hostname to an IP, preferring IPv4 addresses.</p> |
| <p>We prefer IPv4 so that we don’t change behavior from previous IPv4-only |
| implementations, and because some drivers (e.g., FirefoxDriver) do not |
| support IPv6 connections.</p> |
| <p>If the optional port number is provided, only IPs that listen on the given |
| port are considered.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Args<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p>host - A hostname.</p></li> |
| <li><p>port - Optional port number.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>A single IP address, as a string. If any IPv4 address is found, one is |
| returned. Otherwise, if any IPv6 address is found, one is returned. If |
| neither, then None is returned.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="selenium.webdriver.common.utils.join_host_port"> |
| <span class="sig-prename descclassname"><span class="pre">selenium.webdriver.common.utils.</span></span><span class="sig-name descname"><span class="pre">join_host_port</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../_modules/selenium/webdriver/common/utils.html#join_host_port"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#selenium.webdriver.common.utils.join_host_port" title="Link to this definition">¶</a></dt> |
| <dd><p>Joins a hostname and port together.</p> |
| <p>This is a minimal implementation intended to cope with IPv6 literals. For |
| example, _join_host_port(‘::1’, 80) == ‘[::1]:80’.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Args<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p>host - A hostname.</p></li> |
| <li><p>port - An integer port.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="selenium.webdriver.common.utils.is_connectable"> |
| <span class="sig-prename descclassname"><span class="pre">selenium.webdriver.common.utils.</span></span><span class="sig-name descname"><span class="pre">is_connectable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'localhost'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="../_modules/selenium/webdriver/common/utils.html#is_connectable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#selenium.webdriver.common.utils.is_connectable" title="Link to this definition">¶</a></dt> |
| <dd><p>Tries to connect to the server at port to see if it is running.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Args<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p>port - The port to connect.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="selenium.webdriver.common.utils.is_url_connectable"> |
| <span class="sig-prename descclassname"><span class="pre">selenium.webdriver.common.utils.</span></span><span class="sig-name descname"><span class="pre">is_url_connectable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="../_modules/selenium/webdriver/common/utils.html#is_url_connectable"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#selenium.webdriver.common.utils.is_url_connectable" title="Link to this definition">¶</a></dt> |
| <dd><p>Tries to connect to the HTTP server at /status path and specified port |
| to see if it responds successfully.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Args<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p>port - The port to connect.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="selenium.webdriver.common.utils.keys_to_typing"> |
| <span class="sig-prename descclassname"><span class="pre">selenium.webdriver.common.utils.</span></span><span class="sig-name descname"><span class="pre">keys_to_typing</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../_modules/selenium/webdriver/common/utils.html#keys_to_typing"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#selenium.webdriver.common.utils.keys_to_typing" title="Link to this definition">¶</a></dt> |
| <dd><p>Processes the values that will be typed in the element.</p> |
| </dd></dl> |
| </section> |
| |
| |
| </article> |
| </div> |
| </div> |
| </main> |
| </div> |
| <footer class="md-footer"> |
| <div class="md-footer-nav"> |
| <nav class="md-footer-nav__inner md-grid"> |
| |
| |
| </a> |
| |
| </nav> |
| </div> |
| <div class="md-footer-meta md-typeset"> |
| <div class="md-footer-meta__inner md-grid"> |
| <div class="md-footer-copyright"> |
| <div class="md-footer-copyright__highlight"> |
| © Copyright 2009-2025 Software Freedom Conservancy. |
| |
| </div> |
| </div> |
| </div> |
| </div> |
| </footer> |
| <script src="../_static/javascripts/application.js"></script> |
| <script>app.initialize({version: "1.0.4", url: {base: ".."}})</script> |
| </body> |
| </html> |
