Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
Vērot 1
Pievienot zvaigznīti 0
Vikivietne 捐赠
gooderp18绿色标准版
Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.
Koks: 0f75e31513
Atzari Tagi
${ item.name }
Izveidot atzaru ${ searchTerm }
no '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/ipaddress.html

1643 rindas
134KB
Neapstrādāts Vainot Vēsture 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="ipaddress — IPv4/IPv6 manipulation library" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/library/ipaddress.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Source code: Lib/ipaddress.py ipaddress provides the capabilities to create, manipulate and operate on IPv4 and IPv6 addresses and networks. The functions and classes in this module make it straigh..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Source code: Lib/ipaddress.py ipaddress provides the capabilities to create, manipulate and operate on IPv4 and IPv6 addresses and networks. The functions and classes in this module make it straigh..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>ipaddress — IPv4/IPv6 manipulation library &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="Multimedia Services" href="mm.html" />

  39.     <link rel="prev" title="xmlrpc.server — Basic XML-RPC servers" href="xmlrpc.server.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/ipaddress.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <path fill-rule="nonzero" fill="currentColor" d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z"></path>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h3><a href="../contents.html">Table of Contents</a></h3>

  97.     <ul>

  98. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">ipaddress</span></code> — IPv4/IPv6 manipulation library</a><ul>

  99. <li><a class="reference internal" href="#convenience-factory-functions">Convenience factory functions</a></li>

  100. <li><a class="reference internal" href="#ip-addresses">IP Addresses</a><ul>

  101. <li><a class="reference internal" href="#address-objects">Address objects</a></li>

  102. <li><a class="reference internal" href="#conversion-to-strings-and-integers">Conversion to Strings and Integers</a></li>

  103. <li><a class="reference internal" href="#operators">Operators</a><ul>

  104. <li><a class="reference internal" href="#comparison-operators">Comparison operators</a></li>

  105. <li><a class="reference internal" href="#arithmetic-operators">Arithmetic operators</a></li>

  106. </ul>

  107. </li>

  108. </ul>

  109. </li>

  110. <li><a class="reference internal" href="#ip-network-definitions">IP Network definitions</a><ul>

  111. <li><a class="reference internal" href="#prefix-net-mask-and-host-mask">Prefix, net mask and host mask</a></li>

  112. <li><a class="reference internal" href="#network-objects">Network objects</a></li>

  113. <li><a class="reference internal" href="#id1">Operators</a><ul>

  114. <li><a class="reference internal" href="#logical-operators">Logical operators</a></li>

  115. <li><a class="reference internal" href="#iteration">Iteration</a></li>

  116. <li><a class="reference internal" href="#networks-as-containers-of-addresses">Networks as containers of addresses</a></li>

  117. </ul>

  118. </li>

  119. </ul>

  120. </li>

  121. <li><a class="reference internal" href="#interface-objects">Interface objects</a><ul>

  122. <li><a class="reference internal" href="#id2">Operators</a><ul>

  123. <li><a class="reference internal" href="#id3">Logical operators</a></li>

  124. </ul>

  125. </li>

  126. </ul>

  127. </li>

  128. <li><a class="reference internal" href="#other-module-level-functions">Other Module Level Functions</a></li>

  129. <li><a class="reference internal" href="#custom-exceptions">Custom Exceptions</a></li>

  130. </ul>

  131. </li>

  132. </ul>

  133. 

  134.   </div>

  135.   <div>

  136.     <h4>Previous topic</h4>

  137.     <p class="topless"><a href="xmlrpc.server.html"

  138.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">xmlrpc.server</span></code> — Basic XML-RPC servers</a></p>

  139.   </div>

  140.   <div>

  141.     <h4>Next topic</h4>

  142.     <p class="topless"><a href="mm.html"

  143.                           title="next chapter">Multimedia Services</a></p>

  144.   </div>

  145.   <div role="note" aria-label="source link">

  146.     <h3>This Page</h3>

  147.     <ul class="this-page-menu">

  148.       <li><a href="../bugs.html">Report a Bug</a></li>

  149.       <li>

  150.         <a href="https://github.com/python/cpython/blob/main/Doc/library/ipaddress.rst"

  151.             rel="nofollow">Show Source

  152.         </a>

  153.       </li>

  154.     </ul>

  155.   </div>

  156.         </nav>

  157.     </div>

  158. </div>

  159. 

  160.   

  161.     <div class="related" role="navigation" aria-label="related navigation">

  162.       <h3>Navigation</h3>

  163.       <ul>

  164.         <li class="right" style="margin-right: 10px">

  165.           <a href="../genindex.html" title="General Index"

  166.              accesskey="I">index</a></li>

  167.         <li class="right" >

  168.           <a href="../py-modindex.html" title="Python Module Index"

  169.              >modules</a> |</li>

  170.         <li class="right" >

  171.           <a href="mm.html" title="Multimedia Services"

  172.              accesskey="N">next</a> |</li>

  173.         <li class="right" >

  174.           <a href="xmlrpc.server.html" title="xmlrpc.server — Basic XML-RPC servers"

  175.              accesskey="P">previous</a> |</li>

  176. 

  177.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  178.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  179.           <li class="switchers">

  180.             <div class="language_switcher_placeholder"></div>

  181.             <div class="version_switcher_placeholder"></div>

  182.           </li>

  183.           <li>

  184.               

  185.           </li>

  186.     <li id="cpython-language-and-version">

  187.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  188.     </li>

  189. 

  190.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  191.           <li class="nav-item nav-item-2"><a href="internet.html" accesskey="U">Internet Protocols and Support</a> &#187;</li>

  192.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">ipaddress</span></code> — IPv4/IPv6 manipulation library</a></li>

  193.                 <li class="right">

  194.                     

  195. 

  196.     <div class="inline-search" role="search">

  197.         <form class="inline-search" action="../search.html" method="get">

  198.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  199.           <input type="submit" value="Go" />

  200.         </form>

  201.     </div>

  202.                      |

  203.                 </li>

  204.             <li class="right">

  205. <label class="theme-selector-label">

  206.     Theme

  207.     <select class="theme-selector" oninput="activateTheme(this.value)">

  208.         <option value="auto" selected>Auto</option>

  209.         <option value="light">Light</option>

  210.         <option value="dark">Dark</option>

  211.     </select>

  212. </label> |</li>

  213.             

  214.       </ul>

  215.     </div>    

  216. 

  217.     <div class="document">

  218.       <div class="documentwrapper">

  219.         <div class="bodywrapper">

  220.           <div class="body" role="main">

  221.             

  222.   <section id="module-ipaddress">

  223. <span id="ipaddress-ipv4-ipv6-manipulation-library"></span><h1><a class="reference internal" href="#module-ipaddress" title="ipaddress: IPv4/IPv6 manipulation library."><code class="xref py py-mod docutils literal notranslate"><span class="pre">ipaddress</span></code></a> — IPv4/IPv6 manipulation library<a class="headerlink" href="#module-ipaddress" title="Link to this heading">¶</a></h1>

  224. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/ipaddress.py">Lib/ipaddress.py</a></p>

  225. <hr class="docutils" />

  226. <p><a class="reference internal" href="#module-ipaddress" title="ipaddress: IPv4/IPv6 manipulation library."><code class="xref py py-mod docutils literal notranslate"><span class="pre">ipaddress</span></code></a> provides the capabilities to create, manipulate and

  227. operate on IPv4 and IPv6 addresses and networks.</p>

  228. <p>The functions and classes in this module make it straightforward to handle

  229. various tasks related to IP addresses, including checking whether or not two

  230. hosts are on the same subnet, iterating over all hosts in a particular

  231. subnet, checking whether or not a string represents a valid IP address or

  232. network definition, and so on.</p>

  233. <p>This is the full module API reference—for an overview and introduction, see

  234. <a class="reference internal" href="../howto/ipaddress.html#ipaddress-howto"><span class="std std-ref">An introduction to the ipaddress module</span></a>.</p>

  235. <div class="versionadded">

  236. <p><span class="versionmodified added">New in version 3.3.</span></p>

  237. </div>

  238. <section id="convenience-factory-functions">

  239. <h2>Convenience factory functions<a class="headerlink" href="#convenience-factory-functions" title="Link to this heading">¶</a></h2>

  240. <p>The <a class="reference internal" href="#module-ipaddress" title="ipaddress: IPv4/IPv6 manipulation library."><code class="xref py py-mod docutils literal notranslate"><span class="pre">ipaddress</span></code></a> module provides factory functions to conveniently create

  241. IP addresses, networks and interfaces:</p>

  242. <dl class="py function">

  243. <dt class="sig sig-object py" id="ipaddress.ip_address">

  244. <span class="sig-prename descclassname"><span class="pre">ipaddress.</span></span><span class="sig-name descname"><span class="pre">ip_address</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.ip_address" title="Link to this definition">¶</a></dt>

  245. <dd><p>Return an <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Address</span></code></a> or <a class="reference internal" href="#ipaddress.IPv6Address" title="ipaddress.IPv6Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv6Address</span></code></a> object depending on

  246. the IP address passed as argument.  Either IPv4 or IPv6 addresses may be

  247. supplied; integers less than <code class="docutils literal notranslate"><span class="pre">2**32</span></code> will be considered to be IPv4 by default.

  248. A <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> is raised if <em>address</em> does not represent a valid IPv4

  249. or IPv6 address.</p>

  250. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ipaddress</span><span class="o">.</span><span class="n">ip_address</span><span class="p">(</span><span class="s1">&#39;192.168.0.1&#39;</span><span class="p">)</span>

  251. <span class="go">IPv4Address(&#39;192.168.0.1&#39;)</span>

  252. <span class="gp">&gt;&gt;&gt; </span><span class="n">ipaddress</span><span class="o">.</span><span class="n">ip_address</span><span class="p">(</span><span class="s1">&#39;2001:db8::&#39;</span><span class="p">)</span>

  253. <span class="go">IPv6Address(&#39;2001:db8::&#39;)</span>

  254. </pre></div>

  255. </div>

  256. </dd></dl>

  257. 

  258. <dl class="py function">

  259. <dt class="sig sig-object py" id="ipaddress.ip_network">

  260. <span class="sig-prename descclassname"><span class="pre">ipaddress.</span></span><span class="sig-name descname"><span class="pre">ip_network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.ip_network" title="Link to this definition">¶</a></dt>

  261. <dd><p>Return an <a class="reference internal" href="#ipaddress.IPv4Network" title="ipaddress.IPv4Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Network</span></code></a> or <a class="reference internal" href="#ipaddress.IPv6Network" title="ipaddress.IPv6Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv6Network</span></code></a> object depending on

  262. the IP address passed as argument.  <em>address</em> is a string or integer

  263. representing the IP network.  Either IPv4 or IPv6 networks may be supplied;

  264. integers less than <code class="docutils literal notranslate"><span class="pre">2**32</span></code> will be considered to be IPv4 by default.  <em>strict</em>

  265. is passed to <a class="reference internal" href="#ipaddress.IPv4Network" title="ipaddress.IPv4Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Network</span></code></a> or <a class="reference internal" href="#ipaddress.IPv6Network" title="ipaddress.IPv6Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv6Network</span></code></a> constructor.  A

  266. <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> is raised if <em>address</em> does not represent a valid IPv4 or

  267. IPv6 address, or if the network has host bits set.</p>

  268. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ipaddress</span><span class="o">.</span><span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.168.0.0/28&#39;</span><span class="p">)</span>

  269. <span class="go">IPv4Network(&#39;192.168.0.0/28&#39;)</span>

  270. </pre></div>

  271. </div>

  272. </dd></dl>

  273. 

  274. <dl class="py function">

  275. <dt class="sig sig-object py" id="ipaddress.ip_interface">

  276. <span class="sig-prename descclassname"><span class="pre">ipaddress.</span></span><span class="sig-name descname"><span class="pre">ip_interface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.ip_interface" title="Link to this definition">¶</a></dt>

  277. <dd><p>Return an <a class="reference internal" href="#ipaddress.IPv4Interface" title="ipaddress.IPv4Interface"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Interface</span></code></a> or <a class="reference internal" href="#ipaddress.IPv6Interface" title="ipaddress.IPv6Interface"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv6Interface</span></code></a> object depending

  278. on the IP address passed as argument.  <em>address</em> is a string or integer

  279. representing the IP address.  Either IPv4 or IPv6 addresses may be supplied;

  280. integers less than <code class="docutils literal notranslate"><span class="pre">2**32</span></code> will be considered to be IPv4 by default.  A

  281. <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> is raised if <em>address</em> does not represent a valid IPv4 or

  282. IPv6 address.</p>

  283. </dd></dl>

  284. 

  285. <p>One downside of these convenience functions is that the need to handle both

  286. IPv4 and IPv6 formats means that error messages provide minimal

  287. information on the precise error, as the functions don’t know whether the

  288. IPv4 or IPv6 format was intended. More detailed error reporting can be

  289. obtained by calling the appropriate version specific class constructors

  290. directly.</p>

  291. </section>

  292. <section id="ip-addresses">

  293. <h2>IP Addresses<a class="headerlink" href="#ip-addresses" title="Link to this heading">¶</a></h2>

  294. <section id="address-objects">

  295. <h3>Address objects<a class="headerlink" href="#address-objects" title="Link to this heading">¶</a></h3>

  296. <p>The <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Address</span></code></a> and <a class="reference internal" href="#ipaddress.IPv6Address" title="ipaddress.IPv6Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv6Address</span></code></a> objects share a lot of common

  297. attributes.  Some attributes that are only meaningful for IPv6 addresses are

  298. also implemented by <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Address</span></code></a> objects, in order to make it easier to

  299. write code that handles both IP versions correctly.  Address objects are

  300. <a class="reference internal" href="../glossary.html#term-hashable"><span class="xref std std-term">hashable</span></a>, so they can be used as keys in dictionaries.</p>

  301. <dl class="py class">

  302. <dt class="sig sig-object py" id="ipaddress.IPv4Address">

  303. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ipaddress.</span></span><span class="sig-name descname"><span class="pre">IPv4Address</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv4Address" title="Link to this definition">¶</a></dt>

  304. <dd><p>Construct an IPv4 address.  An <a class="reference internal" href="#ipaddress.AddressValueError" title="ipaddress.AddressValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">AddressValueError</span></code></a> is raised if

  305. <em>address</em> is not a valid IPv4 address.</p>

  306. <p>The following constitutes a valid IPv4 address:</p>

  307. <ol class="arabic simple">

  308. <li><p>A string in decimal-dot notation, consisting of four decimal integers in

  309. the inclusive range 0–255, separated by dots (e.g. <code class="docutils literal notranslate"><span class="pre">192.168.0.1</span></code>). Each

  310. integer represents an octet (byte) in the address. Leading zeroes are

  311. not tolerated to prevent confusion with octal notation.</p></li>

  312. <li><p>An integer that fits into 32 bits.</p></li>

  313. <li><p>An integer packed into a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> object of length 4 (most

  314. significant octet first).</p></li>

  315. </ol>

  316. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ipaddress</span><span class="o">.</span><span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;192.168.0.1&#39;</span><span class="p">)</span>

  317. <span class="go">IPv4Address(&#39;192.168.0.1&#39;)</span>

  318. <span class="gp">&gt;&gt;&gt; </span><span class="n">ipaddress</span><span class="o">.</span><span class="n">IPv4Address</span><span class="p">(</span><span class="mi">3232235521</span><span class="p">)</span>

  319. <span class="go">IPv4Address(&#39;192.168.0.1&#39;)</span>

  320. <span class="gp">&gt;&gt;&gt; </span><span class="n">ipaddress</span><span class="o">.</span><span class="n">IPv4Address</span><span class="p">(</span><span class="sa">b</span><span class="s1">&#39;</span><span class="se">\xC0\xA8\x00\x01</span><span class="s1">&#39;</span><span class="p">)</span>

  321. <span class="go">IPv4Address(&#39;192.168.0.1&#39;)</span>

  322. </pre></div>

  323. </div>

  324. <div class="versionchanged">

  325. <p><span class="versionmodified changed">Changed in version 3.8: </span>Leading zeros are tolerated, even in ambiguous cases that look like

  326. octal notation.</p>

  327. </div>

  328. <div class="versionchanged">

  329. <p><span class="versionmodified changed">Changed in version 3.9.5: </span>Leading zeros are no longer tolerated and are treated as an error.

  330. IPv4 address strings are now parsed as strict as glibc

  331. <a class="reference internal" href="socket.html#socket.inet_pton" title="socket.inet_pton"><code class="xref py py-func docutils literal notranslate"><span class="pre">inet_pton()</span></code></a>.</p>

  332. </div>

  333. <dl class="py attribute">

  334. <dt class="sig sig-object py" id="ipaddress.IPv4Address.version">

  335. <span class="sig-name descname"><span class="pre">version</span></span><a class="headerlink" href="#ipaddress.IPv4Address.version" title="Link to this definition">¶</a></dt>

  336. <dd><p>The appropriate version number: <code class="docutils literal notranslate"><span class="pre">4</span></code> for IPv4, <code class="docutils literal notranslate"><span class="pre">6</span></code> for IPv6.</p>

  337. </dd></dl>

  338. 

  339. <dl class="py attribute">

  340. <dt class="sig sig-object py" id="ipaddress.IPv4Address.max_prefixlen">

  341. <span class="sig-name descname"><span class="pre">max_prefixlen</span></span><a class="headerlink" href="#ipaddress.IPv4Address.max_prefixlen" title="Link to this definition">¶</a></dt>

  342. <dd><p>The total number of bits in the address representation for this

  343. version: <code class="docutils literal notranslate"><span class="pre">32</span></code> for IPv4, <code class="docutils literal notranslate"><span class="pre">128</span></code> for IPv6.</p>

  344. <p>The prefix defines the number of leading bits in an  address that

  345. are compared to determine whether or not an address is part of a

  346. network.</p>

  347. </dd></dl>

  348. 

  349. <dl class="py attribute">

  350. <dt class="sig sig-object py" id="ipaddress.IPv4Address.compressed">

  351. <span class="sig-name descname"><span class="pre">compressed</span></span><a class="headerlink" href="#ipaddress.IPv4Address.compressed" title="Link to this definition">¶</a></dt>

  352. <dd></dd></dl>

  353. 

  354. <dl class="py attribute">

  355. <dt class="sig sig-object py" id="ipaddress.IPv4Address.exploded">

  356. <span class="sig-name descname"><span class="pre">exploded</span></span><a class="headerlink" href="#ipaddress.IPv4Address.exploded" title="Link to this definition">¶</a></dt>

  357. <dd><p>The string representation in dotted decimal notation. Leading zeroes

  358. are never included in the representation.</p>

  359. <p>As IPv4 does not define a shorthand notation for addresses with octets

  360. set to zero, these two attributes are always the same as <code class="docutils literal notranslate"><span class="pre">str(addr)</span></code>

  361. for IPv4 addresses. Exposing these attributes makes it easier to

  362. write display code that can handle both IPv4 and IPv6 addresses.</p>

  363. </dd></dl>

  364. 

  365. <dl class="py attribute">

  366. <dt class="sig sig-object py" id="ipaddress.IPv4Address.packed">

  367. <span class="sig-name descname"><span class="pre">packed</span></span><a class="headerlink" href="#ipaddress.IPv4Address.packed" title="Link to this definition">¶</a></dt>

  368. <dd><p>The binary representation of this address - a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> object of

  369. the appropriate length (most significant octet first). This is 4 bytes

  370. for IPv4 and 16 bytes for IPv6.</p>

  371. </dd></dl>

  372. 

  373. <dl class="py attribute">

  374. <dt class="sig sig-object py" id="ipaddress.IPv4Address.reverse_pointer">

  375. <span class="sig-name descname"><span class="pre">reverse_pointer</span></span><a class="headerlink" href="#ipaddress.IPv4Address.reverse_pointer" title="Link to this definition">¶</a></dt>

  376. <dd><p>The name of the reverse DNS PTR record for the IP address, e.g.:</p>

  377. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ipaddress</span><span class="o">.</span><span class="n">ip_address</span><span class="p">(</span><span class="s2">&quot;127.0.0.1&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">reverse_pointer</span>

  378. <span class="go">&#39;1.0.0.127.in-addr.arpa&#39;</span>

  379. <span class="gp">&gt;&gt;&gt; </span><span class="n">ipaddress</span><span class="o">.</span><span class="n">ip_address</span><span class="p">(</span><span class="s2">&quot;2001:db8::1&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">reverse_pointer</span>

  380. <span class="go">&#39;1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa&#39;</span>

  381. </pre></div>

  382. </div>

  383. <p>This is the name that could be used for performing a PTR lookup, not the

  384. resolved hostname itself.</p>

  385. <div class="versionadded">

  386. <p><span class="versionmodified added">New in version 3.5.</span></p>

  387. </div>

  388. </dd></dl>

  389. 

  390. <dl class="py attribute">

  391. <dt class="sig sig-object py" id="ipaddress.IPv4Address.is_multicast">

  392. <span class="sig-name descname"><span class="pre">is_multicast</span></span><a class="headerlink" href="#ipaddress.IPv4Address.is_multicast" title="Link to this definition">¶</a></dt>

  393. <dd><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if the address is reserved for multicast use.  See

  394. <span class="target" id="index-0"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3171.html"><strong>RFC 3171</strong></a> (for IPv4) or <span class="target" id="index-1"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2373.html"><strong>RFC 2373</strong></a> (for IPv6).</p>

  395. </dd></dl>

  396. 

  397. <dl class="py attribute">

  398. <dt class="sig sig-object py" id="ipaddress.IPv4Address.is_private">

  399. <span class="sig-name descname"><span class="pre">is_private</span></span><a class="headerlink" href="#ipaddress.IPv4Address.is_private" title="Link to this definition">¶</a></dt>

  400. <dd><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if the address is allocated for private networks.  See

  401. <a class="reference external" href="https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml">iana-ipv4-special-registry</a> (for IPv4) or <a class="reference external" href="https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml">iana-ipv6-special-registry</a>

  402. (for IPv6).</p>

  403. </dd></dl>

  404. 

  405. <dl class="py attribute">

  406. <dt class="sig sig-object py" id="ipaddress.IPv4Address.is_global">

  407. <span class="sig-name descname"><span class="pre">is_global</span></span><a class="headerlink" href="#ipaddress.IPv4Address.is_global" title="Link to this definition">¶</a></dt>

  408. <dd><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if the address is allocated for public networks.  See

  409. <a class="reference external" href="https://www.iana.org/assignments/iana-ipv4-special-registry/iana-ipv4-special-registry.xhtml">iana-ipv4-special-registry</a> (for IPv4) or <a class="reference external" href="https://www.iana.org/assignments/iana-ipv6-special-registry/iana-ipv6-special-registry.xhtml">iana-ipv6-special-registry</a>

  410. (for IPv6).</p>

  411. <div class="versionadded">

  412. <p><span class="versionmodified added">New in version 3.4.</span></p>

  413. </div>

  414. </dd></dl>

  415. 

  416. <dl class="py attribute">

  417. <dt class="sig sig-object py" id="ipaddress.IPv4Address.is_unspecified">

  418. <span class="sig-name descname"><span class="pre">is_unspecified</span></span><a class="headerlink" href="#ipaddress.IPv4Address.is_unspecified" title="Link to this definition">¶</a></dt>

  419. <dd><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if the address is unspecified.  See <span class="target" id="index-2"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc5735.html"><strong>RFC 5735</strong></a> (for IPv4)

  420. or <span class="target" id="index-3"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2373.html"><strong>RFC 2373</strong></a> (for IPv6).</p>

  421. </dd></dl>

  422. 

  423. <dl class="py attribute">

  424. <dt class="sig sig-object py" id="ipaddress.IPv4Address.is_reserved">

  425. <span class="sig-name descname"><span class="pre">is_reserved</span></span><a class="headerlink" href="#ipaddress.IPv4Address.is_reserved" title="Link to this definition">¶</a></dt>

  426. <dd><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if the address is otherwise IETF reserved.</p>

  427. </dd></dl>

  428. 

  429. <dl class="py attribute">

  430. <dt class="sig sig-object py" id="ipaddress.IPv4Address.is_loopback">

  431. <span class="sig-name descname"><span class="pre">is_loopback</span></span><a class="headerlink" href="#ipaddress.IPv4Address.is_loopback" title="Link to this definition">¶</a></dt>

  432. <dd><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if this is a loopback address.  See <span class="target" id="index-4"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3330.html"><strong>RFC 3330</strong></a> (for IPv4)

  433. or <span class="target" id="index-5"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2373.html"><strong>RFC 2373</strong></a> (for IPv6).</p>

  434. </dd></dl>

  435. 

  436. <dl class="py attribute">

  437. <dt class="sig sig-object py" id="ipaddress.IPv4Address.is_link_local">

  438. <span class="sig-name descname"><span class="pre">is_link_local</span></span><a class="headerlink" href="#ipaddress.IPv4Address.is_link_local" title="Link to this definition">¶</a></dt>

  439. <dd><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if the address is reserved for link-local usage.  See

  440. <span class="target" id="index-6"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3927.html"><strong>RFC 3927</strong></a>.</p>

  441. </dd></dl>

  442. 

  443. </dd></dl>

  444. 

  445. <dl class="py method">

  446. <dt class="sig sig-object py" id="ipaddress.IPv4Address.__format__">

  447. <span class="sig-prename descclassname"><span class="pre">IPv4Address.</span></span><span class="sig-name descname"><span class="pre">__format__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fmt</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv4Address.__format__" title="Link to this definition">¶</a></dt>

  448. <dd><p>Returns a string representation of the IP address, controlled by

  449. an explicit format string.

  450. <em>fmt</em> can be one of the following: <code class="docutils literal notranslate"><span class="pre">'s'</span></code>, the default option,

  451. equivalent to <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-func docutils literal notranslate"><span class="pre">str()</span></code></a>, <code class="docutils literal notranslate"><span class="pre">'b'</span></code> for a zero-padded binary string,

  452. <code class="docutils literal notranslate"><span class="pre">'X'</span></code> or <code class="docutils literal notranslate"><span class="pre">'x'</span></code> for an uppercase or lowercase hexadecimal

  453. representation, or <code class="docutils literal notranslate"><span class="pre">'n'</span></code>, which is equivalent to <code class="docutils literal notranslate"><span class="pre">'b'</span></code> for IPv4

  454. addresses and <code class="docutils literal notranslate"><span class="pre">'x'</span></code> for IPv6. For binary and hexadecimal

  455. representations, the form specifier <code class="docutils literal notranslate"><span class="pre">'#'</span></code> and the grouping option

  456. <code class="docutils literal notranslate"><span class="pre">'_'</span></code> are available. <code class="docutils literal notranslate"><span class="pre">__format__</span></code> is used by <code class="docutils literal notranslate"><span class="pre">format</span></code>, <code class="docutils literal notranslate"><span class="pre">str.format</span></code>

  457. and f-strings.</p>

  458. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">format</span><span class="p">(</span><span class="n">ipaddress</span><span class="o">.</span><span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;192.168.0.1&#39;</span><span class="p">))</span>

  459. <span class="go">&#39;192.168.0.1&#39;</span>

  460. <span class="gp">&gt;&gt;&gt; </span><span class="s1">&#39;</span><span class="si">{:#b}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">ipaddress</span><span class="o">.</span><span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;192.168.0.1&#39;</span><span class="p">))</span>

  461. <span class="go">&#39;0b11000000101010000000000000000001&#39;</span>

  462. <span class="gp">&gt;&gt;&gt; </span><span class="sa">f</span><span class="s1">&#39;</span><span class="si">{</span><span class="n">ipaddress</span><span class="o">.</span><span class="n">IPv6Address</span><span class="p">(</span><span class="s2">&quot;2001:db8::1000&quot;</span><span class="p">)</span><span class="si">:</span><span class="s1">s</span><span class="si">}</span><span class="s1">&#39;</span>

  463. <span class="go">&#39;2001:db8::1000&#39;</span>

  464. <span class="gp">&gt;&gt;&gt; </span><span class="nb">format</span><span class="p">(</span><span class="n">ipaddress</span><span class="o">.</span><span class="n">IPv6Address</span><span class="p">(</span><span class="s1">&#39;2001:db8::1000&#39;</span><span class="p">),</span> <span class="s1">&#39;_X&#39;</span><span class="p">)</span>

  465. <span class="go">&#39;2001_0DB8_0000_0000_0000_0000_0000_1000&#39;</span>

  466. <span class="gp">&gt;&gt;&gt; </span><span class="s1">&#39;{:#_n}&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">ipaddress</span><span class="o">.</span><span class="n">IPv6Address</span><span class="p">(</span><span class="s1">&#39;2001:db8::1000&#39;</span><span class="p">))</span>

  467. <span class="go">&#39;0x2001_0db8_0000_0000_0000_0000_0000_1000&#39;</span>

  468. </pre></div>

  469. </div>

  470. <div class="versionadded">

  471. <p><span class="versionmodified added">New in version 3.9.</span></p>

  472. </div>

  473. </dd></dl>

  474. 

  475. <dl class="py class">

  476. <dt class="sig sig-object py" id="ipaddress.IPv6Address">

  477. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ipaddress.</span></span><span class="sig-name descname"><span class="pre">IPv6Address</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv6Address" title="Link to this definition">¶</a></dt>

  478. <dd><p>Construct an IPv6 address.  An <a class="reference internal" href="#ipaddress.AddressValueError" title="ipaddress.AddressValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">AddressValueError</span></code></a> is raised if

  479. <em>address</em> is not a valid IPv6 address.</p>

  480. <p>The following constitutes a valid IPv6 address:</p>

  481. <ol class="arabic">

  482. <li><p>A string consisting of eight groups of four hexadecimal digits, each

  483. group representing 16 bits.  The groups are separated by colons.

  484. This describes an <em>exploded</em> (longhand) notation.  The string can

  485. also be <em>compressed</em> (shorthand notation) by various means.  See

  486. <span class="target" id="index-7"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4291.html"><strong>RFC 4291</strong></a> for details.  For example,

  487. <code class="docutils literal notranslate"><span class="pre">&quot;0000:0000:0000:0000:0000:0abc:0007:0def&quot;</span></code> can be compressed to

  488. <code class="docutils literal notranslate"><span class="pre">&quot;::abc:7:def&quot;</span></code>.</p>

  489. <p>Optionally, the string may also have a scope zone ID, expressed

  490. with a suffix <code class="docutils literal notranslate"><span class="pre">%scope_id</span></code>. If present, the scope ID must be non-empty,

  491. and may not contain <code class="docutils literal notranslate"><span class="pre">%</span></code>.

  492. See <span class="target" id="index-8"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4007.html"><strong>RFC 4007</strong></a> for details.

  493. For example, <code class="docutils literal notranslate"><span class="pre">fe80::1234%1</span></code> might identify address <code class="docutils literal notranslate"><span class="pre">fe80::1234</span></code> on the first link of the node.</p>

  494. </li>

  495. <li><p>An integer that fits into 128 bits.</p></li>

  496. <li><p>An integer packed into a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> object of length 16, big-endian.</p></li>

  497. </ol>

  498. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ipaddress</span><span class="o">.</span><span class="n">IPv6Address</span><span class="p">(</span><span class="s1">&#39;2001:db8::1000&#39;</span><span class="p">)</span>

  499. <span class="go">IPv6Address(&#39;2001:db8::1000&#39;)</span>

  500. <span class="gp">&gt;&gt;&gt; </span><span class="n">ipaddress</span><span class="o">.</span><span class="n">IPv6Address</span><span class="p">(</span><span class="s1">&#39;ff02::5678%1&#39;</span><span class="p">)</span>

  501. <span class="go">IPv6Address(&#39;ff02::5678%1&#39;)</span>

  502. </pre></div>

  503. </div>

  504. <dl class="py attribute">

  505. <dt class="sig sig-object py" id="ipaddress.IPv6Address.compressed">

  506. <span class="sig-name descname"><span class="pre">compressed</span></span><a class="headerlink" href="#ipaddress.IPv6Address.compressed" title="Link to this definition">¶</a></dt>

  507. <dd></dd></dl>

  508. 

  509. <p>The short form of the address representation, with leading zeroes in

  510. groups omitted and the longest sequence of groups consisting entirely of

  511. zeroes collapsed to a single empty group.</p>

  512. <p>This is also the value returned by <code class="docutils literal notranslate"><span class="pre">str(addr)</span></code> for IPv6 addresses.</p>

  513. <dl class="py attribute">

  514. <dt class="sig sig-object py" id="ipaddress.IPv6Address.exploded">

  515. <span class="sig-name descname"><span class="pre">exploded</span></span><a class="headerlink" href="#ipaddress.IPv6Address.exploded" title="Link to this definition">¶</a></dt>

  516. <dd></dd></dl>

  517. 

  518. <p>The long form of the address representation, with all leading zeroes and

  519. groups consisting entirely of zeroes included.</p>

  520. <p>For the following attributes and methods, see the corresponding

  521. documentation of the <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Address</span></code></a> class:</p>

  522. <dl class="py attribute">

  523. <dt class="sig sig-object py" id="ipaddress.IPv6Address.packed">

  524. <span class="sig-name descname"><span class="pre">packed</span></span><a class="headerlink" href="#ipaddress.IPv6Address.packed" title="Link to this definition">¶</a></dt>

  525. <dd></dd></dl>

  526. 

  527. <dl class="py attribute">

  528. <dt class="sig sig-object py" id="ipaddress.IPv6Address.reverse_pointer">

  529. <span class="sig-name descname"><span class="pre">reverse_pointer</span></span><a class="headerlink" href="#ipaddress.IPv6Address.reverse_pointer" title="Link to this definition">¶</a></dt>

  530. <dd></dd></dl>

  531. 

  532. <dl class="py attribute">

  533. <dt class="sig sig-object py" id="ipaddress.IPv6Address.version">

  534. <span class="sig-name descname"><span class="pre">version</span></span><a class="headerlink" href="#ipaddress.IPv6Address.version" title="Link to this definition">¶</a></dt>

  535. <dd></dd></dl>

  536. 

  537. <dl class="py attribute">

  538. <dt class="sig sig-object py" id="ipaddress.IPv6Address.max_prefixlen">

  539. <span class="sig-name descname"><span class="pre">max_prefixlen</span></span><a class="headerlink" href="#ipaddress.IPv6Address.max_prefixlen" title="Link to this definition">¶</a></dt>

  540. <dd></dd></dl>

  541. 

  542. <dl class="py attribute">

  543. <dt class="sig sig-object py" id="ipaddress.IPv6Address.is_multicast">

  544. <span class="sig-name descname"><span class="pre">is_multicast</span></span><a class="headerlink" href="#ipaddress.IPv6Address.is_multicast" title="Link to this definition">¶</a></dt>

  545. <dd></dd></dl>

  546. 

  547. <dl class="py attribute">

  548. <dt class="sig sig-object py" id="ipaddress.IPv6Address.is_private">

  549. <span class="sig-name descname"><span class="pre">is_private</span></span><a class="headerlink" href="#ipaddress.IPv6Address.is_private" title="Link to this definition">¶</a></dt>

  550. <dd></dd></dl>

  551. 

  552. <dl class="py attribute">

  553. <dt class="sig sig-object py" id="ipaddress.IPv6Address.is_global">

  554. <span class="sig-name descname"><span class="pre">is_global</span></span><a class="headerlink" href="#ipaddress.IPv6Address.is_global" title="Link to this definition">¶</a></dt>

  555. <dd></dd></dl>

  556. 

  557. <dl class="py attribute">

  558. <dt class="sig sig-object py" id="ipaddress.IPv6Address.is_unspecified">

  559. <span class="sig-name descname"><span class="pre">is_unspecified</span></span><a class="headerlink" href="#ipaddress.IPv6Address.is_unspecified" title="Link to this definition">¶</a></dt>

  560. <dd></dd></dl>

  561. 

  562. <dl class="py attribute">

  563. <dt class="sig sig-object py" id="ipaddress.IPv6Address.is_reserved">

  564. <span class="sig-name descname"><span class="pre">is_reserved</span></span><a class="headerlink" href="#ipaddress.IPv6Address.is_reserved" title="Link to this definition">¶</a></dt>

  565. <dd></dd></dl>

  566. 

  567. <dl class="py attribute">

  568. <dt class="sig sig-object py" id="ipaddress.IPv6Address.is_loopback">

  569. <span class="sig-name descname"><span class="pre">is_loopback</span></span><a class="headerlink" href="#ipaddress.IPv6Address.is_loopback" title="Link to this definition">¶</a></dt>

  570. <dd></dd></dl>

  571. 

  572. <dl class="py attribute">

  573. <dt class="sig sig-object py" id="ipaddress.IPv6Address.is_link_local">

  574. <span class="sig-name descname"><span class="pre">is_link_local</span></span><a class="headerlink" href="#ipaddress.IPv6Address.is_link_local" title="Link to this definition">¶</a></dt>

  575. <dd><div class="versionadded">

  576. <p><span class="versionmodified added">New in version 3.4: </span>is_global</p>

  577. </div>

  578. </dd></dl>

  579. 

  580. <dl class="py attribute">

  581. <dt class="sig sig-object py" id="ipaddress.IPv6Address.is_site_local">

  582. <span class="sig-name descname"><span class="pre">is_site_local</span></span><a class="headerlink" href="#ipaddress.IPv6Address.is_site_local" title="Link to this definition">¶</a></dt>

  583. <dd><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if the address is reserved for site-local usage.  Note that

  584. the site-local address space has been deprecated by <span class="target" id="index-9"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3879.html"><strong>RFC 3879</strong></a>. Use

  585. <a class="reference internal" href="#ipaddress.IPv4Address.is_private" title="ipaddress.IPv4Address.is_private"><code class="xref py py-attr docutils literal notranslate"><span class="pre">is_private</span></code></a> to test if this address is in the

  586. space of unique local addresses as defined by <span class="target" id="index-10"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4193.html"><strong>RFC 4193</strong></a>.</p>

  587. </dd></dl>

  588. 

  589. <dl class="py attribute">

  590. <dt class="sig sig-object py" id="ipaddress.IPv6Address.ipv4_mapped">

  591. <span class="sig-name descname"><span class="pre">ipv4_mapped</span></span><a class="headerlink" href="#ipaddress.IPv6Address.ipv4_mapped" title="Link to this definition">¶</a></dt>

  592. <dd><p>For addresses that appear to be IPv4 mapped addresses (starting with

  593. <code class="docutils literal notranslate"><span class="pre">::FFFF/96</span></code>), this property will report the embedded IPv4 address.

  594. For any other address, this property will be <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>

  595. </dd></dl>

  596. 

  597. <dl class="py attribute">

  598. <dt class="sig sig-object py" id="ipaddress.IPv6Address.scope_id">

  599. <span class="sig-name descname"><span class="pre">scope_id</span></span><a class="headerlink" href="#ipaddress.IPv6Address.scope_id" title="Link to this definition">¶</a></dt>

  600. <dd><p>For scoped addresses as defined by <span class="target" id="index-11"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4007.html"><strong>RFC 4007</strong></a>, this property identifies

  601. the particular zone of the address’s scope that the address belongs to,

  602. as a string. When no scope zone is specified, this property will be <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>

  603. </dd></dl>

  604. 

  605. <dl class="py attribute">

  606. <dt class="sig sig-object py" id="ipaddress.IPv6Address.sixtofour">

  607. <span class="sig-name descname"><span class="pre">sixtofour</span></span><a class="headerlink" href="#ipaddress.IPv6Address.sixtofour" title="Link to this definition">¶</a></dt>

  608. <dd><p>For addresses that appear to be 6to4 addresses  (starting with

  609. <code class="docutils literal notranslate"><span class="pre">2002::/16</span></code>) as defined by <span class="target" id="index-12"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3056.html"><strong>RFC 3056</strong></a>, this property will report

  610. the embedded IPv4 address.  For any other address, this property will

  611. be <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>

  612. </dd></dl>

  613. 

  614. <dl class="py attribute">

  615. <dt class="sig sig-object py" id="ipaddress.IPv6Address.teredo">

  616. <span class="sig-name descname"><span class="pre">teredo</span></span><a class="headerlink" href="#ipaddress.IPv6Address.teredo" title="Link to this definition">¶</a></dt>

  617. <dd><p>For addresses that appear to be Teredo addresses (starting with

  618. <code class="docutils literal notranslate"><span class="pre">2001::/32</span></code>) as defined by <span class="target" id="index-13"></span><a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4380.html"><strong>RFC 4380</strong></a>, this property will report

  619. the embedded <code class="docutils literal notranslate"><span class="pre">(server,</span> <span class="pre">client)</span></code> IP address pair.  For any other

  620. address, this property will be <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>

  621. </dd></dl>

  622. 

  623. </dd></dl>

  624. 

  625. <dl class="py method">

  626. <dt class="sig sig-object py" id="ipaddress.IPv6Address.__format__">

  627. <span class="sig-prename descclassname"><span class="pre">IPv6Address.</span></span><span class="sig-name descname"><span class="pre">__format__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fmt</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv6Address.__format__" title="Link to this definition">¶</a></dt>

  628. <dd><p>Refer to the corresponding method documentation in

  629. <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Address</span></code></a>.</p>

  630. <div class="versionadded">

  631. <p><span class="versionmodified added">New in version 3.9.</span></p>

  632. </div>

  633. </dd></dl>

  634. 

  635. </section>

  636. <section id="conversion-to-strings-and-integers">

  637. <h3>Conversion to Strings and Integers<a class="headerlink" href="#conversion-to-strings-and-integers" title="Link to this heading">¶</a></h3>

  638. <p>To interoperate with networking interfaces such as the socket module,

  639. addresses must be converted to strings or integers. This is handled using

  640. the <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-func docutils literal notranslate"><span class="pre">str()</span></code></a> and <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-func docutils literal notranslate"><span class="pre">int()</span></code></a> builtin functions:</p>

  641. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">str</span><span class="p">(</span><span class="n">ipaddress</span><span class="o">.</span><span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;192.168.0.1&#39;</span><span class="p">))</span>

  642. <span class="go">&#39;192.168.0.1&#39;</span>

  643. <span class="gp">&gt;&gt;&gt; </span><span class="nb">int</span><span class="p">(</span><span class="n">ipaddress</span><span class="o">.</span><span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;192.168.0.1&#39;</span><span class="p">))</span>

  644. <span class="go">3232235521</span>

  645. <span class="gp">&gt;&gt;&gt; </span><span class="nb">str</span><span class="p">(</span><span class="n">ipaddress</span><span class="o">.</span><span class="n">IPv6Address</span><span class="p">(</span><span class="s1">&#39;::1&#39;</span><span class="p">))</span>

  646. <span class="go">&#39;::1&#39;</span>

  647. <span class="gp">&gt;&gt;&gt; </span><span class="nb">int</span><span class="p">(</span><span class="n">ipaddress</span><span class="o">.</span><span class="n">IPv6Address</span><span class="p">(</span><span class="s1">&#39;::1&#39;</span><span class="p">))</span>

  648. <span class="go">1</span>

  649. </pre></div>

  650. </div>

  651. <p>Note that IPv6 scoped addresses are converted to integers without scope zone ID.</p>

  652. </section>

  653. <section id="operators">

  654. <h3>Operators<a class="headerlink" href="#operators" title="Link to this heading">¶</a></h3>

  655. <p>Address objects support some operators.  Unless stated otherwise, operators can

  656. only be applied between compatible objects (i.e. IPv4 with IPv4, IPv6 with

  657. IPv6).</p>

  658. <section id="comparison-operators">

  659. <h4>Comparison operators<a class="headerlink" href="#comparison-operators" title="Link to this heading">¶</a></h4>

  660. <p>Address objects can be compared with the usual set of comparison operators.

  661. Same IPv6 addresses with different scope zone IDs are not equal.

  662. Some examples:</p>

  663. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;127.0.0.2&#39;</span><span class="p">)</span> <span class="o">&gt;</span> <span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;127.0.0.1&#39;</span><span class="p">)</span>

  664. <span class="go">True</span>

  665. <span class="gp">&gt;&gt;&gt; </span><span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;127.0.0.2&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;127.0.0.1&#39;</span><span class="p">)</span>

  666. <span class="go">False</span>

  667. <span class="gp">&gt;&gt;&gt; </span><span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;127.0.0.2&#39;</span><span class="p">)</span> <span class="o">!=</span> <span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;127.0.0.1&#39;</span><span class="p">)</span>

  668. <span class="go">True</span>

  669. <span class="gp">&gt;&gt;&gt; </span><span class="n">IPv6Address</span><span class="p">(</span><span class="s1">&#39;fe80::1234&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="n">IPv6Address</span><span class="p">(</span><span class="s1">&#39;fe80::1234%1&#39;</span><span class="p">)</span>

  670. <span class="go">False</span>

  671. <span class="gp">&gt;&gt;&gt; </span><span class="n">IPv6Address</span><span class="p">(</span><span class="s1">&#39;fe80::1234%1&#39;</span><span class="p">)</span> <span class="o">!=</span> <span class="n">IPv6Address</span><span class="p">(</span><span class="s1">&#39;fe80::1234%2&#39;</span><span class="p">)</span>

  672. <span class="go">True</span>

  673. </pre></div>

  674. </div>

  675. </section>

  676. <section id="arithmetic-operators">

  677. <h4>Arithmetic operators<a class="headerlink" href="#arithmetic-operators" title="Link to this heading">¶</a></h4>

  678. <p>Integers can be added to or subtracted from address objects.  Some examples:</p>

  679. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;127.0.0.2&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="mi">3</span>

  680. <span class="go">IPv4Address(&#39;127.0.0.5&#39;)</span>

  681. <span class="gp">&gt;&gt;&gt; </span><span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;127.0.0.2&#39;</span><span class="p">)</span> <span class="o">-</span> <span class="mi">3</span>

  682. <span class="go">IPv4Address(&#39;126.255.255.255&#39;)</span>

  683. <span class="gp">&gt;&gt;&gt; </span><span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;255.255.255.255&#39;</span><span class="p">)</span> <span class="o">+</span> <span class="mi">1</span>

  684. <span class="gt">Traceback (most recent call last):</span>

  685.   File <span class="nb">&quot;&lt;stdin&gt;&quot;</span>, line <span class="m">1</span>, in <span class="n">&lt;module&gt;</span>

  686. <span class="gr">ipaddress.AddressValueError</span>: <span class="n">4294967296 (&gt;= 2**32) is not permitted as an IPv4 address</span>

  687. </pre></div>

  688. </div>

  689. </section>

  690. </section>

  691. </section>

  692. <section id="ip-network-definitions">

  693. <h2>IP Network definitions<a class="headerlink" href="#ip-network-definitions" title="Link to this heading">¶</a></h2>

  694. <p>The <a class="reference internal" href="#ipaddress.IPv4Network" title="ipaddress.IPv4Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Network</span></code></a> and <a class="reference internal" href="#ipaddress.IPv6Network" title="ipaddress.IPv6Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv6Network</span></code></a> objects provide a mechanism

  695. for defining and inspecting IP network definitions.  A network definition

  696. consists of a <em>mask</em> and a <em>network address</em>, and as such defines a range of

  697. IP addresses that equal the network address when masked (binary AND) with the

  698. mask.  For example, a network definition with the mask <code class="docutils literal notranslate"><span class="pre">255.255.255.0</span></code> and

  699. the network address <code class="docutils literal notranslate"><span class="pre">192.168.1.0</span></code> consists of IP addresses in the inclusive

  700. range <code class="docutils literal notranslate"><span class="pre">192.168.1.0</span></code> to <code class="docutils literal notranslate"><span class="pre">192.168.1.255</span></code>.</p>

  701. <section id="prefix-net-mask-and-host-mask">

  702. <h3>Prefix, net mask and host mask<a class="headerlink" href="#prefix-net-mask-and-host-mask" title="Link to this heading">¶</a></h3>

  703. <p>There are several equivalent ways to specify IP network masks.  A <em>prefix</em>

  704. <code class="docutils literal notranslate"><span class="pre">/&lt;nbits&gt;</span></code> is a notation that denotes how many high-order bits are set in

  705. the network mask.  A <em>net mask</em> is an IP address with some number of

  706. high-order bits set.  Thus the prefix <code class="docutils literal notranslate"><span class="pre">/24</span></code> is equivalent to the net mask

  707. <code class="docutils literal notranslate"><span class="pre">255.255.255.0</span></code> in IPv4, or <code class="docutils literal notranslate"><span class="pre">ffff:ff00::</span></code> in IPv6.  In addition, a

  708. <em>host mask</em> is the logical inverse of a <em>net mask</em>, and is sometimes used

  709. (for example in Cisco access control lists) to denote a network mask.  The

  710. host mask equivalent to <code class="docutils literal notranslate"><span class="pre">/24</span></code> in IPv4 is <code class="docutils literal notranslate"><span class="pre">0.0.0.255</span></code>.</p>

  711. </section>

  712. <section id="network-objects">

  713. <h3>Network objects<a class="headerlink" href="#network-objects" title="Link to this heading">¶</a></h3>

  714. <p>All attributes implemented by address objects are implemented by network

  715. objects as well.  In addition, network objects implement additional attributes.

  716. All of these are common between <a class="reference internal" href="#ipaddress.IPv4Network" title="ipaddress.IPv4Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Network</span></code></a> and <a class="reference internal" href="#ipaddress.IPv6Network" title="ipaddress.IPv6Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv6Network</span></code></a>,

  717. so to avoid duplication they are only documented for <a class="reference internal" href="#ipaddress.IPv4Network" title="ipaddress.IPv4Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Network</span></code></a>.

  718. Network objects are <a class="reference internal" href="../glossary.html#term-hashable"><span class="xref std std-term">hashable</span></a>, so they can be used as keys in

  719. dictionaries.</p>

  720. <dl class="py class">

  721. <dt class="sig sig-object py" id="ipaddress.IPv4Network">

  722. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ipaddress.</span></span><span class="sig-name descname"><span class="pre">IPv4Network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv4Network" title="Link to this definition">¶</a></dt>

  723. <dd><p>Construct an IPv4 network definition.  <em>address</em> can be one of the following:</p>

  724. <ol class="arabic">

  725. <li><p>A string consisting of an IP address and an optional mask, separated by

  726. a slash (<code class="docutils literal notranslate"><span class="pre">/</span></code>).  The IP address is the network address, and the mask

  727. can be either a single number, which means it’s a <em>prefix</em>, or a string

  728. representation of an IPv4 address.  If it’s the latter, the mask is

  729. interpreted as a <em>net mask</em> if it starts with a non-zero field, or as a

  730. <em>host mask</em> if it starts with a zero field, with the single exception of

  731. an all-zero mask which is treated as a <em>net mask</em>.  If no mask is provided,

  732. it’s considered to be <code class="docutils literal notranslate"><span class="pre">/32</span></code>.</p>

  733. <p>For example, the following <em>address</em> specifications are equivalent:

  734. <code class="docutils literal notranslate"><span class="pre">192.168.1.0/24</span></code>, <code class="docutils literal notranslate"><span class="pre">192.168.1.0/255.255.255.0</span></code> and

  735. <code class="docutils literal notranslate"><span class="pre">192.168.1.0/0.0.0.255</span></code>.</p>

  736. </li>

  737. <li><p>An integer that fits into 32 bits.  This is equivalent to a

  738. single-address network, with the network address being <em>address</em> and

  739. the mask being <code class="docutils literal notranslate"><span class="pre">/32</span></code>.</p></li>

  740. <li><p>An integer packed into a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> object of length 4, big-endian.

  741. The interpretation is similar to an integer <em>address</em>.</p></li>

  742. <li><p>A two-tuple of an address description and a netmask, where the address

  743. description is either a string, a 32-bits integer, a 4-bytes packed

  744. integer, or an existing IPv4Address object; and the netmask is either

  745. an integer representing the prefix length (e.g. <code class="docutils literal notranslate"><span class="pre">24</span></code>) or a string

  746. representing the prefix mask (e.g. <code class="docutils literal notranslate"><span class="pre">255.255.255.0</span></code>).</p></li>

  747. </ol>

  748. <p>An <a class="reference internal" href="#ipaddress.AddressValueError" title="ipaddress.AddressValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">AddressValueError</span></code></a> is raised if <em>address</em> is not a valid IPv4

  749. address.  A <a class="reference internal" href="#ipaddress.NetmaskValueError" title="ipaddress.NetmaskValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">NetmaskValueError</span></code></a> is raised if the mask is not valid for

  750. an IPv4 address.</p>

  751. <p>If <em>strict</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code> and host bits are set in the supplied address,

  752. then <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> is raised.  Otherwise, the host bits are masked out

  753. to determine the appropriate network address.</p>

  754. <p>Unless stated otherwise, all network methods accepting other network/address

  755. objects will raise <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a> if the argument’s IP version is

  756. incompatible to <code class="docutils literal notranslate"><span class="pre">self</span></code>.</p>

  757. <div class="versionchanged">

  758. <p><span class="versionmodified changed">Changed in version 3.5: </span>Added the two-tuple form for the <em>address</em> constructor parameter.</p>

  759. </div>

  760. <dl class="py attribute">

  761. <dt class="sig sig-object py" id="ipaddress.IPv4Network.version">

  762. <span class="sig-name descname"><span class="pre">version</span></span><a class="headerlink" href="#ipaddress.IPv4Network.version" title="Link to this definition">¶</a></dt>

  763. <dd></dd></dl>

  764. 

  765. <dl class="py attribute">

  766. <dt class="sig sig-object py" id="ipaddress.IPv4Network.max_prefixlen">

  767. <span class="sig-name descname"><span class="pre">max_prefixlen</span></span><a class="headerlink" href="#ipaddress.IPv4Network.max_prefixlen" title="Link to this definition">¶</a></dt>

  768. <dd><p>Refer to the corresponding attribute documentation in

  769. <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Address</span></code></a>.</p>

  770. </dd></dl>

  771. 

  772. <dl class="py attribute">

  773. <dt class="sig sig-object py" id="ipaddress.IPv4Network.is_multicast">

  774. <span class="sig-name descname"><span class="pre">is_multicast</span></span><a class="headerlink" href="#ipaddress.IPv4Network.is_multicast" title="Link to this definition">¶</a></dt>

  775. <dd></dd></dl>

  776. 

  777. <dl class="py attribute">

  778. <dt class="sig sig-object py" id="ipaddress.IPv4Network.is_private">

  779. <span class="sig-name descname"><span class="pre">is_private</span></span><a class="headerlink" href="#ipaddress.IPv4Network.is_private" title="Link to this definition">¶</a></dt>

  780. <dd></dd></dl>

  781. 

  782. <dl class="py attribute">

  783. <dt class="sig sig-object py" id="ipaddress.IPv4Network.is_unspecified">

  784. <span class="sig-name descname"><span class="pre">is_unspecified</span></span><a class="headerlink" href="#ipaddress.IPv4Network.is_unspecified" title="Link to this definition">¶</a></dt>

  785. <dd></dd></dl>

  786. 

  787. <dl class="py attribute">

  788. <dt class="sig sig-object py" id="ipaddress.IPv4Network.is_reserved">

  789. <span class="sig-name descname"><span class="pre">is_reserved</span></span><a class="headerlink" href="#ipaddress.IPv4Network.is_reserved" title="Link to this definition">¶</a></dt>

  790. <dd></dd></dl>

  791. 

  792. <dl class="py attribute">

  793. <dt class="sig sig-object py" id="ipaddress.IPv4Network.is_loopback">

  794. <span class="sig-name descname"><span class="pre">is_loopback</span></span><a class="headerlink" href="#ipaddress.IPv4Network.is_loopback" title="Link to this definition">¶</a></dt>

  795. <dd></dd></dl>

  796. 

  797. <dl class="py attribute">

  798. <dt class="sig sig-object py" id="ipaddress.IPv4Network.is_link_local">

  799. <span class="sig-name descname"><span class="pre">is_link_local</span></span><a class="headerlink" href="#ipaddress.IPv4Network.is_link_local" title="Link to this definition">¶</a></dt>

  800. <dd><p>These attributes are true for the network as a whole if they are true

  801. for both the network address and the broadcast address.</p>

  802. </dd></dl>

  803. 

  804. <dl class="py attribute">

  805. <dt class="sig sig-object py" id="ipaddress.IPv4Network.network_address">

  806. <span class="sig-name descname"><span class="pre">network_address</span></span><a class="headerlink" href="#ipaddress.IPv4Network.network_address" title="Link to this definition">¶</a></dt>

  807. <dd><p>The network address for the network. The network address and the

  808. prefix length together uniquely define a network.</p>

  809. </dd></dl>

  810. 

  811. <dl class="py attribute">

  812. <dt class="sig sig-object py" id="ipaddress.IPv4Network.broadcast_address">

  813. <span class="sig-name descname"><span class="pre">broadcast_address</span></span><a class="headerlink" href="#ipaddress.IPv4Network.broadcast_address" title="Link to this definition">¶</a></dt>

  814. <dd><p>The broadcast address for the network. Packets sent to the broadcast

  815. address should be received by every host on the network.</p>

  816. </dd></dl>

  817. 

  818. <dl class="py attribute">

  819. <dt class="sig sig-object py" id="ipaddress.IPv4Network.hostmask">

  820. <span class="sig-name descname"><span class="pre">hostmask</span></span><a class="headerlink" href="#ipaddress.IPv4Network.hostmask" title="Link to this definition">¶</a></dt>

  821. <dd><p>The host mask, as an <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Address</span></code></a> object.</p>

  822. </dd></dl>

  823. 

  824. <dl class="py attribute">

  825. <dt class="sig sig-object py" id="ipaddress.IPv4Network.netmask">

  826. <span class="sig-name descname"><span class="pre">netmask</span></span><a class="headerlink" href="#ipaddress.IPv4Network.netmask" title="Link to this definition">¶</a></dt>

  827. <dd><p>The net mask, as an <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Address</span></code></a> object.</p>

  828. </dd></dl>

  829. 

  830. <dl class="py attribute">

  831. <dt class="sig sig-object py" id="ipaddress.IPv4Network.with_prefixlen">

  832. <span class="sig-name descname"><span class="pre">with_prefixlen</span></span><a class="headerlink" href="#ipaddress.IPv4Network.with_prefixlen" title="Link to this definition">¶</a></dt>

  833. <dd></dd></dl>

  834. 

  835. <dl class="py attribute">

  836. <dt class="sig sig-object py" id="ipaddress.IPv4Network.compressed">

  837. <span class="sig-name descname"><span class="pre">compressed</span></span><a class="headerlink" href="#ipaddress.IPv4Network.compressed" title="Link to this definition">¶</a></dt>

  838. <dd></dd></dl>

  839. 

  840. <dl class="py attribute">

  841. <dt class="sig sig-object py" id="ipaddress.IPv4Network.exploded">

  842. <span class="sig-name descname"><span class="pre">exploded</span></span><a class="headerlink" href="#ipaddress.IPv4Network.exploded" title="Link to this definition">¶</a></dt>

  843. <dd><p>A string representation of the network, with the mask in prefix

  844. notation.</p>

  845. <p><code class="docutils literal notranslate"><span class="pre">with_prefixlen</span></code> and <code class="docutils literal notranslate"><span class="pre">compressed</span></code> are always the same as

  846. <code class="docutils literal notranslate"><span class="pre">str(network)</span></code>.

  847. <code class="docutils literal notranslate"><span class="pre">exploded</span></code> uses the exploded form the network address.</p>

  848. </dd></dl>

  849. 

  850. <dl class="py attribute">

  851. <dt class="sig sig-object py" id="ipaddress.IPv4Network.with_netmask">

  852. <span class="sig-name descname"><span class="pre">with_netmask</span></span><a class="headerlink" href="#ipaddress.IPv4Network.with_netmask" title="Link to this definition">¶</a></dt>

  853. <dd><p>A string representation of the network, with the mask in net mask

  854. notation.</p>

  855. </dd></dl>

  856. 

  857. <dl class="py attribute">

  858. <dt class="sig sig-object py" id="ipaddress.IPv4Network.with_hostmask">

  859. <span class="sig-name descname"><span class="pre">with_hostmask</span></span><a class="headerlink" href="#ipaddress.IPv4Network.with_hostmask" title="Link to this definition">¶</a></dt>

  860. <dd><p>A string representation of the network, with the mask in host mask

  861. notation.</p>

  862. </dd></dl>

  863. 

  864. <dl class="py attribute">

  865. <dt class="sig sig-object py" id="ipaddress.IPv4Network.num_addresses">

  866. <span class="sig-name descname"><span class="pre">num_addresses</span></span><a class="headerlink" href="#ipaddress.IPv4Network.num_addresses" title="Link to this definition">¶</a></dt>

  867. <dd><p>The total number of addresses in the network.</p>

  868. </dd></dl>

  869. 

  870. <dl class="py attribute">

  871. <dt class="sig sig-object py" id="ipaddress.IPv4Network.prefixlen">

  872. <span class="sig-name descname"><span class="pre">prefixlen</span></span><a class="headerlink" href="#ipaddress.IPv4Network.prefixlen" title="Link to this definition">¶</a></dt>

  873. <dd><p>Length of the network prefix, in bits.</p>

  874. </dd></dl>

  875. 

  876. <dl class="py method">

  877. <dt class="sig sig-object py" id="ipaddress.IPv4Network.hosts">

  878. <span class="sig-name descname"><span class="pre">hosts</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv4Network.hosts" title="Link to this definition">¶</a></dt>

  879. <dd><p>Returns an iterator over the usable hosts in the network.  The usable

  880. hosts are all the IP addresses that belong to the network, except the

  881. network address itself and the network broadcast address.  For networks

  882. with a mask length of 31, the network address and network broadcast

  883. address are also included in the result. Networks with a mask of 32

  884. will return a list containing the single host address.</p>

  885. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/29&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">hosts</span><span class="p">())</span>  

  886. <span class="go">[IPv4Address(&#39;192.0.2.1&#39;), IPv4Address(&#39;192.0.2.2&#39;),</span>

  887. <span class="go"> IPv4Address(&#39;192.0.2.3&#39;), IPv4Address(&#39;192.0.2.4&#39;),</span>

  888. <span class="go"> IPv4Address(&#39;192.0.2.5&#39;), IPv4Address(&#39;192.0.2.6&#39;)]</span>

  889. <span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/31&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">hosts</span><span class="p">())</span>

  890. <span class="go">[IPv4Address(&#39;192.0.2.0&#39;), IPv4Address(&#39;192.0.2.1&#39;)]</span>

  891. <span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.1/32&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">hosts</span><span class="p">())</span>

  892. <span class="go">[IPv4Address(&#39;192.0.2.1&#39;)]</span>

  893. </pre></div>

  894. </div>

  895. </dd></dl>

  896. 

  897. <dl class="py method">

  898. <dt class="sig sig-object py" id="ipaddress.IPv4Network.overlaps">

  899. <span class="sig-name descname"><span class="pre">overlaps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv4Network.overlaps" title="Link to this definition">¶</a></dt>

  900. <dd><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if this network is partly or wholly contained in <em>other</em> or

  901. <em>other</em> is wholly contained in this network.</p>

  902. </dd></dl>

  903. 

  904. <dl class="py method">

  905. <dt class="sig sig-object py" id="ipaddress.IPv4Network.address_exclude">

  906. <span class="sig-name descname"><span class="pre">address_exclude</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">network</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv4Network.address_exclude" title="Link to this definition">¶</a></dt>

  907. <dd><p>Computes the network definitions resulting from removing the given

  908. <em>network</em> from this one.  Returns an iterator of network objects.

  909. Raises <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> if <em>network</em> is not completely contained in

  910. this network.</p>

  911. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">n1</span> <span class="o">=</span> <span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/28&#39;</span><span class="p">)</span>

  912. <span class="gp">&gt;&gt;&gt; </span><span class="n">n2</span> <span class="o">=</span> <span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.1/32&#39;</span><span class="p">)</span>

  913. <span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">n1</span><span class="o">.</span><span class="n">address_exclude</span><span class="p">(</span><span class="n">n2</span><span class="p">))</span>  

  914. <span class="go">[IPv4Network(&#39;192.0.2.8/29&#39;), IPv4Network(&#39;192.0.2.4/30&#39;),</span>

  915. <span class="go"> IPv4Network(&#39;192.0.2.2/31&#39;), IPv4Network(&#39;192.0.2.0/32&#39;)]</span>

  916. </pre></div>

  917. </div>

  918. </dd></dl>

  919. 

  920. <dl class="py method">

  921. <dt class="sig sig-object py" id="ipaddress.IPv4Network.subnets">

  922. <span class="sig-name descname"><span class="pre">subnets</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefixlen_diff</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv4Network.subnets" title="Link to this definition">¶</a></dt>

  923. <dd><p>The subnets that join to make the current network definition, depending

  924. on the argument values.  <em>prefixlen_diff</em> is the amount our prefix

  925. length should be increased by.  <em>new_prefix</em> is the desired new

  926. prefix of the subnets; it must be larger than our prefix.  One and

  927. only one of <em>prefixlen_diff</em> and <em>new_prefix</em> must be set.  Returns an

  928. iterator of network objects.</p>

  929. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/24&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">subnets</span><span class="p">())</span>

  930. <span class="go">[IPv4Network(&#39;192.0.2.0/25&#39;), IPv4Network(&#39;192.0.2.128/25&#39;)]</span>

  931. <span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/24&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">subnets</span><span class="p">(</span><span class="n">prefixlen_diff</span><span class="o">=</span><span class="mi">2</span><span class="p">))</span>  

  932. <span class="go">[IPv4Network(&#39;192.0.2.0/26&#39;), IPv4Network(&#39;192.0.2.64/26&#39;),</span>

  933. <span class="go"> IPv4Network(&#39;192.0.2.128/26&#39;), IPv4Network(&#39;192.0.2.192/26&#39;)]</span>

  934. <span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/24&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">subnets</span><span class="p">(</span><span class="n">new_prefix</span><span class="o">=</span><span class="mi">26</span><span class="p">))</span>  

  935. <span class="go">[IPv4Network(&#39;192.0.2.0/26&#39;), IPv4Network(&#39;192.0.2.64/26&#39;),</span>

  936. <span class="go"> IPv4Network(&#39;192.0.2.128/26&#39;), IPv4Network(&#39;192.0.2.192/26&#39;)]</span>

  937. <span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/24&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">subnets</span><span class="p">(</span><span class="n">new_prefix</span><span class="o">=</span><span class="mi">23</span><span class="p">))</span>

  938. <span class="gt">Traceback (most recent call last):</span>

  939.   File <span class="nb">&quot;&lt;stdin&gt;&quot;</span>, line <span class="m">1</span>, in <span class="n">&lt;module&gt;</span>

  940. <span class="w">    </span><span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;new prefix must be longer&#39;</span><span class="p">)</span>

  941. <span class="gr">ValueError</span>: <span class="n">new prefix must be longer</span>

  942. <span class="gp">&gt;&gt;&gt; </span><span class="nb">list</span><span class="p">(</span><span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/24&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">subnets</span><span class="p">(</span><span class="n">new_prefix</span><span class="o">=</span><span class="mi">25</span><span class="p">))</span>

  943. <span class="go">[IPv4Network(&#39;192.0.2.0/25&#39;), IPv4Network(&#39;192.0.2.128/25&#39;)]</span>

  944. </pre></div>

  945. </div>

  946. </dd></dl>

  947. 

  948. <dl class="py method">

  949. <dt class="sig sig-object py" id="ipaddress.IPv4Network.supernet">

  950. <span class="sig-name descname"><span class="pre">supernet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefixlen_diff</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv4Network.supernet" title="Link to this definition">¶</a></dt>

  951. <dd><p>The supernet containing this network definition, depending on the

  952. argument values.  <em>prefixlen_diff</em> is the amount our prefix length

  953. should be decreased by.  <em>new_prefix</em> is the desired new prefix of

  954. the supernet; it must be smaller than our prefix.  One and only one

  955. of <em>prefixlen_diff</em> and <em>new_prefix</em> must be set.  Returns a single

  956. network object.</p>

  957. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/24&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">supernet</span><span class="p">()</span>

  958. <span class="go">IPv4Network(&#39;192.0.2.0/23&#39;)</span>

  959. <span class="gp">&gt;&gt;&gt; </span><span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/24&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">supernet</span><span class="p">(</span><span class="n">prefixlen_diff</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>

  960. <span class="go">IPv4Network(&#39;192.0.0.0/22&#39;)</span>

  961. <span class="gp">&gt;&gt;&gt; </span><span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/24&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">supernet</span><span class="p">(</span><span class="n">new_prefix</span><span class="o">=</span><span class="mi">20</span><span class="p">)</span>

  962. <span class="go">IPv4Network(&#39;192.0.0.0/20&#39;)</span>

  963. </pre></div>

  964. </div>

  965. </dd></dl>

  966. 

  967. <dl class="py method">

  968. <dt class="sig sig-object py" id="ipaddress.IPv4Network.subnet_of">

  969. <span class="sig-name descname"><span class="pre">subnet_of</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv4Network.subnet_of" title="Link to this definition">¶</a></dt>

  970. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if this network is a subnet of <em>other</em>.</p>

  971. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">a</span> <span class="o">=</span> <span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.168.1.0/24&#39;</span><span class="p">)</span>

  972. <span class="gp">&gt;&gt;&gt; </span><span class="n">b</span> <span class="o">=</span> <span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.168.1.128/30&#39;</span><span class="p">)</span>

  973. <span class="gp">&gt;&gt;&gt; </span><span class="n">b</span><span class="o">.</span><span class="n">subnet_of</span><span class="p">(</span><span class="n">a</span><span class="p">)</span>

  974. <span class="go">True</span>

  975. </pre></div>

  976. </div>

  977. <div class="versionadded">

  978. <p><span class="versionmodified added">New in version 3.7.</span></p>

  979. </div>

  980. </dd></dl>

  981. 

  982. <dl class="py method">

  983. <dt class="sig sig-object py" id="ipaddress.IPv4Network.supernet_of">

  984. <span class="sig-name descname"><span class="pre">supernet_of</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv4Network.supernet_of" title="Link to this definition">¶</a></dt>

  985. <dd><p>Return <code class="docutils literal notranslate"><span class="pre">True</span></code> if this network is a supernet of <em>other</em>.</p>

  986. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">a</span> <span class="o">=</span> <span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.168.1.0/24&#39;</span><span class="p">)</span>

  987. <span class="gp">&gt;&gt;&gt; </span><span class="n">b</span> <span class="o">=</span> <span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.168.1.128/30&#39;</span><span class="p">)</span>

  988. <span class="gp">&gt;&gt;&gt; </span><span class="n">a</span><span class="o">.</span><span class="n">supernet_of</span><span class="p">(</span><span class="n">b</span><span class="p">)</span>

  989. <span class="go">True</span>

  990. </pre></div>

  991. </div>

  992. <div class="versionadded">

  993. <p><span class="versionmodified added">New in version 3.7.</span></p>

  994. </div>

  995. </dd></dl>

  996. 

  997. <dl class="py method">

  998. <dt class="sig sig-object py" id="ipaddress.IPv4Network.compare_networks">

  999. <span class="sig-name descname"><span class="pre">compare_networks</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv4Network.compare_networks" title="Link to this definition">¶</a></dt>

  1000. <dd><p>Compare this network to <em>other</em>.  In this comparison only the network

  1001. addresses are considered; host bits aren’t.  Returns either <code class="docutils literal notranslate"><span class="pre">-1</span></code>,

  1002. <code class="docutils literal notranslate"><span class="pre">0</span></code> or <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p>

  1003. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.1/32&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">compare_networks</span><span class="p">(</span><span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.2/32&#39;</span><span class="p">))</span>

  1004. <span class="go">-1</span>

  1005. <span class="gp">&gt;&gt;&gt; </span><span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.1/32&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">compare_networks</span><span class="p">(</span><span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/32&#39;</span><span class="p">))</span>

  1006. <span class="go">1</span>

  1007. <span class="gp">&gt;&gt;&gt; </span><span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.1/32&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">compare_networks</span><span class="p">(</span><span class="n">ip_network</span><span class="p">(</span><span class="s1">&#39;192.0.2.1/32&#39;</span><span class="p">))</span>

  1008. <span class="go">0</span>

  1009. </pre></div>

  1010. </div>

  1011. <div class="deprecated">

  1012. <p><span class="versionmodified deprecated">Deprecated since version 3.7: </span>It uses the same ordering and comparison algorithm as “&lt;”, “==”, and “&gt;”</p>

  1013. </div>

  1014. </dd></dl>

  1015. 

  1016. </dd></dl>

  1017. 

  1018. <dl class="py class">

  1019. <dt class="sig sig-object py" id="ipaddress.IPv6Network">

  1020. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ipaddress.</span></span><span class="sig-name descname"><span class="pre">IPv6Network</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv6Network" title="Link to this definition">¶</a></dt>

  1021. <dd><p>Construct an IPv6 network definition.  <em>address</em> can be one of the following:</p>

  1022. <ol class="arabic">

  1023. <li><p>A string consisting of an IP address and an optional prefix length,

  1024. separated by a slash (<code class="docutils literal notranslate"><span class="pre">/</span></code>).  The IP address is the network address,

  1025. and the prefix length must be a single number, the <em>prefix</em>.  If no

  1026. prefix length is provided, it’s considered to be <code class="docutils literal notranslate"><span class="pre">/128</span></code>.</p>

  1027. <p>Note that currently expanded netmasks are not supported.  That means

  1028. <code class="docutils literal notranslate"><span class="pre">2001:db00::0/24</span></code> is a valid argument while <code class="docutils literal notranslate"><span class="pre">2001:db00::0/ffff:ff00::</span></code>

  1029. is not.</p>

  1030. </li>

  1031. <li><p>An integer that fits into 128 bits.  This is equivalent to a

  1032. single-address network, with the network address being <em>address</em> and

  1033. the mask being <code class="docutils literal notranslate"><span class="pre">/128</span></code>.</p></li>

  1034. <li><p>An integer packed into a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></a> object of length 16, big-endian.

  1035. The interpretation is similar to an integer <em>address</em>.</p></li>

  1036. <li><p>A two-tuple of an address description and a netmask, where the address

  1037. description is either a string, a 128-bits integer, a 16-bytes packed

  1038. integer, or an existing IPv6Address object; and the netmask is an

  1039. integer representing the prefix length.</p></li>

  1040. </ol>

  1041. <p>An <a class="reference internal" href="#ipaddress.AddressValueError" title="ipaddress.AddressValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">AddressValueError</span></code></a> is raised if <em>address</em> is not a valid IPv6

  1042. address.  A <a class="reference internal" href="#ipaddress.NetmaskValueError" title="ipaddress.NetmaskValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">NetmaskValueError</span></code></a> is raised if the mask is not valid for

  1043. an IPv6 address.</p>

  1044. <p>If <em>strict</em> is <code class="docutils literal notranslate"><span class="pre">True</span></code> and host bits are set in the supplied address,

  1045. then <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> is raised.  Otherwise, the host bits are masked out

  1046. to determine the appropriate network address.</p>

  1047. <div class="versionchanged">

  1048. <p><span class="versionmodified changed">Changed in version 3.5: </span>Added the two-tuple form for the <em>address</em> constructor parameter.</p>

  1049. </div>

  1050. <dl class="py attribute">

  1051. <dt class="sig sig-object py" id="ipaddress.IPv6Network.version">

  1052. <span class="sig-name descname"><span class="pre">version</span></span><a class="headerlink" href="#ipaddress.IPv6Network.version" title="Link to this definition">¶</a></dt>

  1053. <dd></dd></dl>

  1054. 

  1055. <dl class="py attribute">

  1056. <dt class="sig sig-object py" id="ipaddress.IPv6Network.max_prefixlen">

  1057. <span class="sig-name descname"><span class="pre">max_prefixlen</span></span><a class="headerlink" href="#ipaddress.IPv6Network.max_prefixlen" title="Link to this definition">¶</a></dt>

  1058. <dd></dd></dl>

  1059. 

  1060. <dl class="py attribute">

  1061. <dt class="sig sig-object py" id="ipaddress.IPv6Network.is_multicast">

  1062. <span class="sig-name descname"><span class="pre">is_multicast</span></span><a class="headerlink" href="#ipaddress.IPv6Network.is_multicast" title="Link to this definition">¶</a></dt>

  1063. <dd></dd></dl>

  1064. 

  1065. <dl class="py attribute">

  1066. <dt class="sig sig-object py" id="ipaddress.IPv6Network.is_private">

  1067. <span class="sig-name descname"><span class="pre">is_private</span></span><a class="headerlink" href="#ipaddress.IPv6Network.is_private" title="Link to this definition">¶</a></dt>

  1068. <dd></dd></dl>

  1069. 

  1070. <dl class="py attribute">

  1071. <dt class="sig sig-object py" id="ipaddress.IPv6Network.is_unspecified">

  1072. <span class="sig-name descname"><span class="pre">is_unspecified</span></span><a class="headerlink" href="#ipaddress.IPv6Network.is_unspecified" title="Link to this definition">¶</a></dt>

  1073. <dd></dd></dl>

  1074. 

  1075. <dl class="py attribute">

  1076. <dt class="sig sig-object py" id="ipaddress.IPv6Network.is_reserved">

  1077. <span class="sig-name descname"><span class="pre">is_reserved</span></span><a class="headerlink" href="#ipaddress.IPv6Network.is_reserved" title="Link to this definition">¶</a></dt>

  1078. <dd></dd></dl>

  1079. 

  1080. <dl class="py attribute">

  1081. <dt class="sig sig-object py" id="ipaddress.IPv6Network.is_loopback">

  1082. <span class="sig-name descname"><span class="pre">is_loopback</span></span><a class="headerlink" href="#ipaddress.IPv6Network.is_loopback" title="Link to this definition">¶</a></dt>

  1083. <dd></dd></dl>

  1084. 

  1085. <dl class="py attribute">

  1086. <dt class="sig sig-object py" id="ipaddress.IPv6Network.is_link_local">

  1087. <span class="sig-name descname"><span class="pre">is_link_local</span></span><a class="headerlink" href="#ipaddress.IPv6Network.is_link_local" title="Link to this definition">¶</a></dt>

  1088. <dd></dd></dl>

  1089. 

  1090. <dl class="py attribute">

  1091. <dt class="sig sig-object py" id="ipaddress.IPv6Network.network_address">

  1092. <span class="sig-name descname"><span class="pre">network_address</span></span><a class="headerlink" href="#ipaddress.IPv6Network.network_address" title="Link to this definition">¶</a></dt>

  1093. <dd></dd></dl>

  1094. 

  1095. <dl class="py attribute">

  1096. <dt class="sig sig-object py" id="ipaddress.IPv6Network.broadcast_address">

  1097. <span class="sig-name descname"><span class="pre">broadcast_address</span></span><a class="headerlink" href="#ipaddress.IPv6Network.broadcast_address" title="Link to this definition">¶</a></dt>

  1098. <dd></dd></dl>

  1099. 

  1100. <dl class="py attribute">

  1101. <dt class="sig sig-object py" id="ipaddress.IPv6Network.hostmask">

  1102. <span class="sig-name descname"><span class="pre">hostmask</span></span><a class="headerlink" href="#ipaddress.IPv6Network.hostmask" title="Link to this definition">¶</a></dt>

  1103. <dd></dd></dl>

  1104. 

  1105. <dl class="py attribute">

  1106. <dt class="sig sig-object py" id="ipaddress.IPv6Network.netmask">

  1107. <span class="sig-name descname"><span class="pre">netmask</span></span><a class="headerlink" href="#ipaddress.IPv6Network.netmask" title="Link to this definition">¶</a></dt>

  1108. <dd></dd></dl>

  1109. 

  1110. <dl class="py attribute">

  1111. <dt class="sig sig-object py" id="ipaddress.IPv6Network.with_prefixlen">

  1112. <span class="sig-name descname"><span class="pre">with_prefixlen</span></span><a class="headerlink" href="#ipaddress.IPv6Network.with_prefixlen" title="Link to this definition">¶</a></dt>

  1113. <dd></dd></dl>

  1114. 

  1115. <dl class="py attribute">

  1116. <dt class="sig sig-object py" id="ipaddress.IPv6Network.compressed">

  1117. <span class="sig-name descname"><span class="pre">compressed</span></span><a class="headerlink" href="#ipaddress.IPv6Network.compressed" title="Link to this definition">¶</a></dt>

  1118. <dd></dd></dl>

  1119. 

  1120. <dl class="py attribute">

  1121. <dt class="sig sig-object py" id="ipaddress.IPv6Network.exploded">

  1122. <span class="sig-name descname"><span class="pre">exploded</span></span><a class="headerlink" href="#ipaddress.IPv6Network.exploded" title="Link to this definition">¶</a></dt>

  1123. <dd></dd></dl>

  1124. 

  1125. <dl class="py attribute">

  1126. <dt class="sig sig-object py" id="ipaddress.IPv6Network.with_netmask">

  1127. <span class="sig-name descname"><span class="pre">with_netmask</span></span><a class="headerlink" href="#ipaddress.IPv6Network.with_netmask" title="Link to this definition">¶</a></dt>

  1128. <dd></dd></dl>

  1129. 

  1130. <dl class="py attribute">

  1131. <dt class="sig sig-object py" id="ipaddress.IPv6Network.with_hostmask">

  1132. <span class="sig-name descname"><span class="pre">with_hostmask</span></span><a class="headerlink" href="#ipaddress.IPv6Network.with_hostmask" title="Link to this definition">¶</a></dt>

  1133. <dd></dd></dl>

  1134. 

  1135. <dl class="py attribute">

  1136. <dt class="sig sig-object py" id="ipaddress.IPv6Network.num_addresses">

  1137. <span class="sig-name descname"><span class="pre">num_addresses</span></span><a class="headerlink" href="#ipaddress.IPv6Network.num_addresses" title="Link to this definition">¶</a></dt>

  1138. <dd></dd></dl>

  1139. 

  1140. <dl class="py attribute">

  1141. <dt class="sig sig-object py" id="ipaddress.IPv6Network.prefixlen">

  1142. <span class="sig-name descname"><span class="pre">prefixlen</span></span><a class="headerlink" href="#ipaddress.IPv6Network.prefixlen" title="Link to this definition">¶</a></dt>

  1143. <dd></dd></dl>

  1144. 

  1145. <dl class="py method">

  1146. <dt class="sig sig-object py" id="ipaddress.IPv6Network.hosts">

  1147. <span class="sig-name descname"><span class="pre">hosts</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv6Network.hosts" title="Link to this definition">¶</a></dt>

  1148. <dd><p>Returns an iterator over the usable hosts in the network.  The usable

  1149. hosts are all the IP addresses that belong to the network, except the

  1150. Subnet-Router anycast address.  For networks with a mask length of 127,

  1151. the Subnet-Router anycast address is also included in the result.

  1152. Networks with a mask of 128 will return a list containing the

  1153. single host address.</p>

  1154. </dd></dl>

  1155. 

  1156. <dl class="py method">

  1157. <dt class="sig sig-object py" id="ipaddress.IPv6Network.overlaps">

  1158. <span class="sig-name descname"><span class="pre">overlaps</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv6Network.overlaps" title="Link to this definition">¶</a></dt>

  1159. <dd></dd></dl>

  1160. 

  1161. <dl class="py method">

  1162. <dt class="sig sig-object py" id="ipaddress.IPv6Network.address_exclude">

  1163. <span class="sig-name descname"><span class="pre">address_exclude</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">network</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv6Network.address_exclude" title="Link to this definition">¶</a></dt>

  1164. <dd></dd></dl>

  1165. 

  1166. <dl class="py method">

  1167. <dt class="sig sig-object py" id="ipaddress.IPv6Network.subnets">

  1168. <span class="sig-name descname"><span class="pre">subnets</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefixlen_diff</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv6Network.subnets" title="Link to this definition">¶</a></dt>

  1169. <dd></dd></dl>

  1170. 

  1171. <dl class="py method">

  1172. <dt class="sig sig-object py" id="ipaddress.IPv6Network.supernet">

  1173. <span class="sig-name descname"><span class="pre">supernet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefixlen_diff</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_prefix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv6Network.supernet" title="Link to this definition">¶</a></dt>

  1174. <dd></dd></dl>

  1175. 

  1176. <dl class="py method">

  1177. <dt class="sig sig-object py" id="ipaddress.IPv6Network.subnet_of">

  1178. <span class="sig-name descname"><span class="pre">subnet_of</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv6Network.subnet_of" title="Link to this definition">¶</a></dt>

  1179. <dd></dd></dl>

  1180. 

  1181. <dl class="py method">

  1182. <dt class="sig sig-object py" id="ipaddress.IPv6Network.supernet_of">

  1183. <span class="sig-name descname"><span class="pre">supernet_of</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv6Network.supernet_of" title="Link to this definition">¶</a></dt>

  1184. <dd></dd></dl>

  1185. 

  1186. <dl class="py method">

  1187. <dt class="sig sig-object py" id="ipaddress.IPv6Network.compare_networks">

  1188. <span class="sig-name descname"><span class="pre">compare_networks</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv6Network.compare_networks" title="Link to this definition">¶</a></dt>

  1189. <dd><p>Refer to the corresponding attribute documentation in

  1190. <a class="reference internal" href="#ipaddress.IPv4Network" title="ipaddress.IPv4Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Network</span></code></a>.</p>

  1191. </dd></dl>

  1192. 

  1193. <dl class="py attribute">

  1194. <dt class="sig sig-object py" id="ipaddress.IPv6Network.is_site_local">

  1195. <span class="sig-name descname"><span class="pre">is_site_local</span></span><a class="headerlink" href="#ipaddress.IPv6Network.is_site_local" title="Link to this definition">¶</a></dt>

  1196. <dd><p>These attribute is true for the network as a whole if it is true

  1197. for both the network address and the broadcast address.</p>

  1198. </dd></dl>

  1199. 

  1200. </dd></dl>

  1201. 

  1202. </section>

  1203. <section id="id1">

  1204. <h3>Operators<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h3>

  1205. <p>Network objects support some operators.  Unless stated otherwise, operators can

  1206. only be applied between compatible objects (i.e. IPv4 with IPv4, IPv6 with

  1207. IPv6).</p>

  1208. <section id="logical-operators">

  1209. <h4>Logical operators<a class="headerlink" href="#logical-operators" title="Link to this heading">¶</a></h4>

  1210. <p>Network objects can be compared with the usual set of logical operators.

  1211. Network objects are ordered first by network address, then by net mask.</p>

  1212. </section>

  1213. <section id="iteration">

  1214. <h4>Iteration<a class="headerlink" href="#iteration" title="Link to this heading">¶</a></h4>

  1215. <p>Network objects can be iterated to list all the addresses belonging to the

  1216. network.  For iteration, <em>all</em> hosts are returned, including unusable hosts

  1217. (for usable hosts, use the <a class="reference internal" href="#ipaddress.IPv4Network.hosts" title="ipaddress.IPv4Network.hosts"><code class="xref py py-meth docutils literal notranslate"><span class="pre">hosts()</span></code></a> method).  An

  1218. example:</p>

  1219. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">addr</span> <span class="ow">in</span> <span class="n">IPv4Network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/28&#39;</span><span class="p">):</span>

  1220. <span class="gp">... </span>    <span class="n">addr</span>

  1221. <span class="gp">...</span>

  1222. <span class="go">IPv4Address(&#39;192.0.2.0&#39;)</span>

  1223. <span class="go">IPv4Address(&#39;192.0.2.1&#39;)</span>

  1224. <span class="go">IPv4Address(&#39;192.0.2.2&#39;)</span>

  1225. <span class="go">IPv4Address(&#39;192.0.2.3&#39;)</span>

  1226. <span class="go">IPv4Address(&#39;192.0.2.4&#39;)</span>

  1227. <span class="go">IPv4Address(&#39;192.0.2.5&#39;)</span>

  1228. <span class="go">IPv4Address(&#39;192.0.2.6&#39;)</span>

  1229. <span class="go">IPv4Address(&#39;192.0.2.7&#39;)</span>

  1230. <span class="go">IPv4Address(&#39;192.0.2.8&#39;)</span>

  1231. <span class="go">IPv4Address(&#39;192.0.2.9&#39;)</span>

  1232. <span class="go">IPv4Address(&#39;192.0.2.10&#39;)</span>

  1233. <span class="go">IPv4Address(&#39;192.0.2.11&#39;)</span>

  1234. <span class="go">IPv4Address(&#39;192.0.2.12&#39;)</span>

  1235. <span class="go">IPv4Address(&#39;192.0.2.13&#39;)</span>

  1236. <span class="go">IPv4Address(&#39;192.0.2.14&#39;)</span>

  1237. <span class="go">IPv4Address(&#39;192.0.2.15&#39;)</span>

  1238. </pre></div>

  1239. </div>

  1240. </section>

  1241. <section id="networks-as-containers-of-addresses">

  1242. <h4>Networks as containers of addresses<a class="headerlink" href="#networks-as-containers-of-addresses" title="Link to this heading">¶</a></h4>

  1243. <p>Network objects can act as containers of addresses.  Some examples:</p>

  1244. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">IPv4Network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/28&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>

  1245. <span class="go">IPv4Address(&#39;192.0.2.0&#39;)</span>

  1246. <span class="gp">&gt;&gt;&gt; </span><span class="n">IPv4Network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/28&#39;</span><span class="p">)[</span><span class="mi">15</span><span class="p">]</span>

  1247. <span class="go">IPv4Address(&#39;192.0.2.15&#39;)</span>

  1248. <span class="gp">&gt;&gt;&gt; </span><span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;192.0.2.6&#39;</span><span class="p">)</span> <span class="ow">in</span> <span class="n">IPv4Network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/28&#39;</span><span class="p">)</span>

  1249. <span class="go">True</span>

  1250. <span class="gp">&gt;&gt;&gt; </span><span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;192.0.3.6&#39;</span><span class="p">)</span> <span class="ow">in</span> <span class="n">IPv4Network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/28&#39;</span><span class="p">)</span>

  1251. <span class="go">False</span>

  1252. </pre></div>

  1253. </div>

  1254. </section>

  1255. </section>

  1256. </section>

  1257. <section id="interface-objects">

  1258. <h2>Interface objects<a class="headerlink" href="#interface-objects" title="Link to this heading">¶</a></h2>

  1259. <p>Interface objects are <a class="reference internal" href="../glossary.html#term-hashable"><span class="xref std std-term">hashable</span></a>, so they can be used as keys in

  1260. dictionaries.</p>

  1261. <dl class="py class">

  1262. <dt class="sig sig-object py" id="ipaddress.IPv4Interface">

  1263. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ipaddress.</span></span><span class="sig-name descname"><span class="pre">IPv4Interface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv4Interface" title="Link to this definition">¶</a></dt>

  1264. <dd><p>Construct an IPv4 interface.  The meaning of <em>address</em> is as in the

  1265. constructor of <a class="reference internal" href="#ipaddress.IPv4Network" title="ipaddress.IPv4Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Network</span></code></a>, except that arbitrary host addresses

  1266. are always accepted.</p>

  1267. <p><a class="reference internal" href="#ipaddress.IPv4Interface" title="ipaddress.IPv4Interface"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Interface</span></code></a> is a subclass of <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Address</span></code></a>, so it inherits

  1268. all the attributes from that class.  In addition, the following attributes

  1269. are available:</p>

  1270. <dl class="py attribute">

  1271. <dt class="sig sig-object py" id="ipaddress.IPv4Interface.ip">

  1272. <span class="sig-name descname"><span class="pre">ip</span></span><a class="headerlink" href="#ipaddress.IPv4Interface.ip" title="Link to this definition">¶</a></dt>

  1273. <dd><p>The address (<a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Address</span></code></a>) without network information.</p>

  1274. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">interface</span> <span class="o">=</span> <span class="n">IPv4Interface</span><span class="p">(</span><span class="s1">&#39;192.0.2.5/24&#39;</span><span class="p">)</span>

  1275. <span class="gp">&gt;&gt;&gt; </span><span class="n">interface</span><span class="o">.</span><span class="n">ip</span>

  1276. <span class="go">IPv4Address(&#39;192.0.2.5&#39;)</span>

  1277. </pre></div>

  1278. </div>

  1279. </dd></dl>

  1280. 

  1281. <dl class="py attribute">

  1282. <dt class="sig sig-object py" id="ipaddress.IPv4Interface.network">

  1283. <span class="sig-name descname"><span class="pre">network</span></span><a class="headerlink" href="#ipaddress.IPv4Interface.network" title="Link to this definition">¶</a></dt>

  1284. <dd><p>The network (<a class="reference internal" href="#ipaddress.IPv4Network" title="ipaddress.IPv4Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Network</span></code></a>) this interface belongs to.</p>

  1285. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">interface</span> <span class="o">=</span> <span class="n">IPv4Interface</span><span class="p">(</span><span class="s1">&#39;192.0.2.5/24&#39;</span><span class="p">)</span>

  1286. <span class="gp">&gt;&gt;&gt; </span><span class="n">interface</span><span class="o">.</span><span class="n">network</span>

  1287. <span class="go">IPv4Network(&#39;192.0.2.0/24&#39;)</span>

  1288. </pre></div>

  1289. </div>

  1290. </dd></dl>

  1291. 

  1292. <dl class="py attribute">

  1293. <dt class="sig sig-object py" id="ipaddress.IPv4Interface.with_prefixlen">

  1294. <span class="sig-name descname"><span class="pre">with_prefixlen</span></span><a class="headerlink" href="#ipaddress.IPv4Interface.with_prefixlen" title="Link to this definition">¶</a></dt>

  1295. <dd><p>A string representation of the interface with the mask in prefix notation.</p>

  1296. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">interface</span> <span class="o">=</span> <span class="n">IPv4Interface</span><span class="p">(</span><span class="s1">&#39;192.0.2.5/24&#39;</span><span class="p">)</span>

  1297. <span class="gp">&gt;&gt;&gt; </span><span class="n">interface</span><span class="o">.</span><span class="n">with_prefixlen</span>

  1298. <span class="go">&#39;192.0.2.5/24&#39;</span>

  1299. </pre></div>

  1300. </div>

  1301. </dd></dl>

  1302. 

  1303. <dl class="py attribute">

  1304. <dt class="sig sig-object py" id="ipaddress.IPv4Interface.with_netmask">

  1305. <span class="sig-name descname"><span class="pre">with_netmask</span></span><a class="headerlink" href="#ipaddress.IPv4Interface.with_netmask" title="Link to this definition">¶</a></dt>

  1306. <dd><p>A string representation of the interface with the network as a net mask.</p>

  1307. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">interface</span> <span class="o">=</span> <span class="n">IPv4Interface</span><span class="p">(</span><span class="s1">&#39;192.0.2.5/24&#39;</span><span class="p">)</span>

  1308. <span class="gp">&gt;&gt;&gt; </span><span class="n">interface</span><span class="o">.</span><span class="n">with_netmask</span>

  1309. <span class="go">&#39;192.0.2.5/255.255.255.0&#39;</span>

  1310. </pre></div>

  1311. </div>

  1312. </dd></dl>

  1313. 

  1314. <dl class="py attribute">

  1315. <dt class="sig sig-object py" id="ipaddress.IPv4Interface.with_hostmask">

  1316. <span class="sig-name descname"><span class="pre">with_hostmask</span></span><a class="headerlink" href="#ipaddress.IPv4Interface.with_hostmask" title="Link to this definition">¶</a></dt>

  1317. <dd><p>A string representation of the interface with the network as a host mask.</p>

  1318. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">interface</span> <span class="o">=</span> <span class="n">IPv4Interface</span><span class="p">(</span><span class="s1">&#39;192.0.2.5/24&#39;</span><span class="p">)</span>

  1319. <span class="gp">&gt;&gt;&gt; </span><span class="n">interface</span><span class="o">.</span><span class="n">with_hostmask</span>

  1320. <span class="go">&#39;192.0.2.5/0.0.0.255&#39;</span>

  1321. </pre></div>

  1322. </div>

  1323. </dd></dl>

  1324. 

  1325. </dd></dl>

  1326. 

  1327. <dl class="py class">

  1328. <dt class="sig sig-object py" id="ipaddress.IPv6Interface">

  1329. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ipaddress.</span></span><span class="sig-name descname"><span class="pre">IPv6Interface</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.IPv6Interface" title="Link to this definition">¶</a></dt>

  1330. <dd><p>Construct an IPv6 interface.  The meaning of <em>address</em> is as in the

  1331. constructor of <a class="reference internal" href="#ipaddress.IPv6Network" title="ipaddress.IPv6Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv6Network</span></code></a>, except that arbitrary host addresses

  1332. are always accepted.</p>

  1333. <p><a class="reference internal" href="#ipaddress.IPv6Interface" title="ipaddress.IPv6Interface"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv6Interface</span></code></a> is a subclass of <a class="reference internal" href="#ipaddress.IPv6Address" title="ipaddress.IPv6Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv6Address</span></code></a>, so it inherits

  1334. all the attributes from that class.  In addition, the following attributes

  1335. are available:</p>

  1336. <dl class="py attribute">

  1337. <dt class="sig sig-object py" id="ipaddress.IPv6Interface.ip">

  1338. <span class="sig-name descname"><span class="pre">ip</span></span><a class="headerlink" href="#ipaddress.IPv6Interface.ip" title="Link to this definition">¶</a></dt>

  1339. <dd></dd></dl>

  1340. 

  1341. <dl class="py attribute">

  1342. <dt class="sig sig-object py" id="ipaddress.IPv6Interface.network">

  1343. <span class="sig-name descname"><span class="pre">network</span></span><a class="headerlink" href="#ipaddress.IPv6Interface.network" title="Link to this definition">¶</a></dt>

  1344. <dd></dd></dl>

  1345. 

  1346. <dl class="py attribute">

  1347. <dt class="sig sig-object py" id="ipaddress.IPv6Interface.with_prefixlen">

  1348. <span class="sig-name descname"><span class="pre">with_prefixlen</span></span><a class="headerlink" href="#ipaddress.IPv6Interface.with_prefixlen" title="Link to this definition">¶</a></dt>

  1349. <dd></dd></dl>

  1350. 

  1351. <dl class="py attribute">

  1352. <dt class="sig sig-object py" id="ipaddress.IPv6Interface.with_netmask">

  1353. <span class="sig-name descname"><span class="pre">with_netmask</span></span><a class="headerlink" href="#ipaddress.IPv6Interface.with_netmask" title="Link to this definition">¶</a></dt>

  1354. <dd></dd></dl>

  1355. 

  1356. <dl class="py attribute">

  1357. <dt class="sig sig-object py" id="ipaddress.IPv6Interface.with_hostmask">

  1358. <span class="sig-name descname"><span class="pre">with_hostmask</span></span><a class="headerlink" href="#ipaddress.IPv6Interface.with_hostmask" title="Link to this definition">¶</a></dt>

  1359. <dd><p>Refer to the corresponding attribute documentation in

  1360. <a class="reference internal" href="#ipaddress.IPv4Interface" title="ipaddress.IPv4Interface"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Interface</span></code></a>.</p>

  1361. </dd></dl>

  1362. 

  1363. </dd></dl>

  1364. 

  1365. <section id="id2">

  1366. <h3>Operators<a class="headerlink" href="#id2" title="Link to this heading">¶</a></h3>

  1367. <p>Interface objects support some operators.  Unless stated otherwise, operators

  1368. can only be applied between compatible objects (i.e. IPv4 with IPv4, IPv6 with

  1369. IPv6).</p>

  1370. <section id="id3">

  1371. <h4>Logical operators<a class="headerlink" href="#id3" title="Link to this heading">¶</a></h4>

  1372. <p>Interface objects can be compared with the usual set of logical operators.</p>

  1373. <p>For equality comparison (<code class="docutils literal notranslate"><span class="pre">==</span></code> and <code class="docutils literal notranslate"><span class="pre">!=</span></code>), both the IP address and network

  1374. must be the same for the objects to be equal.  An interface will not compare

  1375. equal to any address or network object.</p>

  1376. <p>For ordering (<code class="docutils literal notranslate"><span class="pre">&lt;</span></code>, <code class="docutils literal notranslate"><span class="pre">&gt;</span></code>, etc) the rules are different.  Interface and

  1377. address objects with the same IP version can be compared, and the address

  1378. objects will always sort before the interface objects.  Two interface objects

  1379. are first compared by their networks and, if those are the same, then by their

  1380. IP addresses.</p>

  1381. </section>

  1382. </section>

  1383. </section>

  1384. <section id="other-module-level-functions">

  1385. <h2>Other Module Level Functions<a class="headerlink" href="#other-module-level-functions" title="Link to this heading">¶</a></h2>

  1386. <p>The module also provides the following module level functions:</p>

  1387. <dl class="py function">

  1388. <dt class="sig sig-object py" id="ipaddress.v4_int_to_packed">

  1389. <span class="sig-prename descclassname"><span class="pre">ipaddress.</span></span><span class="sig-name descname"><span class="pre">v4_int_to_packed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.v4_int_to_packed" title="Link to this definition">¶</a></dt>

  1390. <dd><p>Represent an address as 4 packed bytes in network (big-endian) order.

  1391. <em>address</em> is an integer representation of an IPv4 IP address.  A

  1392. <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> is raised if the integer is negative or too large to be an

  1393. IPv4 IP address.</p>

  1394. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ipaddress</span><span class="o">.</span><span class="n">ip_address</span><span class="p">(</span><span class="mi">3221225985</span><span class="p">)</span>

  1395. <span class="go">IPv4Address(&#39;192.0.2.1&#39;)</span>

  1396. <span class="gp">&gt;&gt;&gt; </span><span class="n">ipaddress</span><span class="o">.</span><span class="n">v4_int_to_packed</span><span class="p">(</span><span class="mi">3221225985</span><span class="p">)</span>

  1397. <span class="go">b&#39;\xc0\x00\x02\x01&#39;</span>

  1398. </pre></div>

  1399. </div>

  1400. </dd></dl>

  1401. 

  1402. <dl class="py function">

  1403. <dt class="sig sig-object py" id="ipaddress.v6_int_to_packed">

  1404. <span class="sig-prename descclassname"><span class="pre">ipaddress.</span></span><span class="sig-name descname"><span class="pre">v6_int_to_packed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.v6_int_to_packed" title="Link to this definition">¶</a></dt>

  1405. <dd><p>Represent an address as 16 packed bytes in network (big-endian) order.

  1406. <em>address</em> is an integer representation of an IPv6 IP address.  A

  1407. <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> is raised if the integer is negative or too large to be an

  1408. IPv6 IP address.</p>

  1409. </dd></dl>

  1410. 

  1411. <dl class="py function">

  1412. <dt class="sig sig-object py" id="ipaddress.summarize_address_range">

  1413. <span class="sig-prename descclassname"><span class="pre">ipaddress.</span></span><span class="sig-name descname"><span class="pre">summarize_address_range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">first</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">last</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.summarize_address_range" title="Link to this definition">¶</a></dt>

  1414. <dd><p>Return an iterator of the summarized network range given the first and last

  1415. IP addresses.  <em>first</em> is the first <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Address</span></code></a> or

  1416. <a class="reference internal" href="#ipaddress.IPv6Address" title="ipaddress.IPv6Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv6Address</span></code></a> in the range and <em>last</em> is the last <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Address</span></code></a>

  1417. or <a class="reference internal" href="#ipaddress.IPv6Address" title="ipaddress.IPv6Address"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv6Address</span></code></a> in the range.  A <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a> is raised if

  1418. <em>first</em> or <em>last</em> are not IP addresses or are not of the same version.  A

  1419. <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> is raised if <em>last</em> is not greater than <em>first</em> or if

  1420. <em>first</em> address version is not 4 or 6.</p>

  1421. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="p">[</span><span class="n">ipaddr</span> <span class="k">for</span> <span class="n">ipaddr</span> <span class="ow">in</span> <span class="n">ipaddress</span><span class="o">.</span><span class="n">summarize_address_range</span><span class="p">(</span>

  1422. <span class="gp">... </span>   <span class="n">ipaddress</span><span class="o">.</span><span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;192.0.2.0&#39;</span><span class="p">),</span>

  1423. <span class="gp">... </span>   <span class="n">ipaddress</span><span class="o">.</span><span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;192.0.2.130&#39;</span><span class="p">))]</span>

  1424. <span class="go">[IPv4Network(&#39;192.0.2.0/25&#39;), IPv4Network(&#39;192.0.2.128/31&#39;), IPv4Network(&#39;192.0.2.130/32&#39;)]</span>

  1425. </pre></div>

  1426. </div>

  1427. </dd></dl>

  1428. 

  1429. <dl class="py function">

  1430. <dt class="sig sig-object py" id="ipaddress.collapse_addresses">

  1431. <span class="sig-prename descclassname"><span class="pre">ipaddress.</span></span><span class="sig-name descname"><span class="pre">collapse_addresses</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">addresses</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.collapse_addresses" title="Link to this definition">¶</a></dt>

  1432. <dd><p>Return an iterator of the collapsed <a class="reference internal" href="#ipaddress.IPv4Network" title="ipaddress.IPv4Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Network</span></code></a> or

  1433. <a class="reference internal" href="#ipaddress.IPv6Network" title="ipaddress.IPv6Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv6Network</span></code></a> objects.  <em>addresses</em> is an iterator of

  1434. <a class="reference internal" href="#ipaddress.IPv4Network" title="ipaddress.IPv4Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv4Network</span></code></a> or <a class="reference internal" href="#ipaddress.IPv6Network" title="ipaddress.IPv6Network"><code class="xref py py-class docutils literal notranslate"><span class="pre">IPv6Network</span></code></a> objects.  A <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code></a> is

  1435. raised if <em>addresses</em> contains mixed version objects.</p>

  1436. <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="p">[</span><span class="n">ipaddr</span> <span class="k">for</span> <span class="n">ipaddr</span> <span class="ow">in</span>

  1437. <span class="gp">... </span><span class="n">ipaddress</span><span class="o">.</span><span class="n">collapse_addresses</span><span class="p">([</span><span class="n">ipaddress</span><span class="o">.</span><span class="n">IPv4Network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/25&#39;</span><span class="p">),</span>

  1438. <span class="gp">... </span><span class="n">ipaddress</span><span class="o">.</span><span class="n">IPv4Network</span><span class="p">(</span><span class="s1">&#39;192.0.2.128/25&#39;</span><span class="p">)])]</span>

  1439. <span class="go">[IPv4Network(&#39;192.0.2.0/24&#39;)]</span>

  1440. </pre></div>

  1441. </div>

  1442. </dd></dl>

  1443. 

  1444. <dl class="py function">

  1445. <dt class="sig sig-object py" id="ipaddress.get_mixed_type_key">

  1446. <span class="sig-prename descclassname"><span class="pre">ipaddress.</span></span><span class="sig-name descname"><span class="pre">get_mixed_type_key</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">obj</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.get_mixed_type_key" title="Link to this definition">¶</a></dt>

  1447. <dd><p>Return a key suitable for sorting between networks and addresses.  Address

  1448. and Network objects are not sortable by default; they’re fundamentally

  1449. different, so the expression:</p>

  1450. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">IPv4Address</span><span class="p">(</span><span class="s1">&#39;192.0.2.0&#39;</span><span class="p">)</span> <span class="o">&lt;=</span> <span class="n">IPv4Network</span><span class="p">(</span><span class="s1">&#39;192.0.2.0/24&#39;</span><span class="p">)</span>

  1451. </pre></div>

  1452. </div>

  1453. <p>doesn’t make sense.  There are some times however, where you may wish to

  1454. have <a class="reference internal" href="#module-ipaddress" title="ipaddress: IPv4/IPv6 manipulation library."><code class="xref py py-mod docutils literal notranslate"><span class="pre">ipaddress</span></code></a> sort these anyway.  If you need to do this, you can use

  1455. this function as the <em>key</em> argument to <a class="reference internal" href="functions.html#sorted" title="sorted"><code class="xref py py-func docutils literal notranslate"><span class="pre">sorted()</span></code></a>.</p>

  1456. <p><em>obj</em> is either a network or address object.</p>

  1457. </dd></dl>

  1458. 

  1459. </section>

  1460. <section id="custom-exceptions">

  1461. <h2>Custom Exceptions<a class="headerlink" href="#custom-exceptions" title="Link to this heading">¶</a></h2>

  1462. <p>To support more specific error reporting from class constructors, the

  1463. module defines the following exceptions:</p>

  1464. <dl class="py exception">

  1465. <dt class="sig sig-object py" id="ipaddress.AddressValueError">

  1466. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ipaddress.</span></span><span class="sig-name descname"><span class="pre">AddressValueError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ValueError</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.AddressValueError" title="Link to this definition">¶</a></dt>

  1467. <dd><p>Any value error related to the address.</p>

  1468. </dd></dl>

  1469. 

  1470. <dl class="py exception">

  1471. <dt class="sig sig-object py" id="ipaddress.NetmaskValueError">

  1472. <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ipaddress.</span></span><span class="sig-name descname"><span class="pre">NetmaskValueError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ValueError</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ipaddress.NetmaskValueError" title="Link to this definition">¶</a></dt>

  1473. <dd><p>Any value error related to the net mask.</p>

  1474. </dd></dl>

  1475. 

  1476. </section>

  1477. </section>

  1478. 

  1479. 

  1480.             <div class="clearer"></div>

  1481.           </div>

  1482.         </div>

  1483.       </div>

  1484.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  1485.         <div class="sphinxsidebarwrapper">

  1486.   <div>

  1487.     <h3><a href="../contents.html">Table of Contents</a></h3>

  1488.     <ul>

  1489. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">ipaddress</span></code> — IPv4/IPv6 manipulation library</a><ul>

  1490. <li><a class="reference internal" href="#convenience-factory-functions">Convenience factory functions</a></li>

  1491. <li><a class="reference internal" href="#ip-addresses">IP Addresses</a><ul>

  1492. <li><a class="reference internal" href="#address-objects">Address objects</a></li>

  1493. <li><a class="reference internal" href="#conversion-to-strings-and-integers">Conversion to Strings and Integers</a></li>

  1494. <li><a class="reference internal" href="#operators">Operators</a><ul>

  1495. <li><a class="reference internal" href="#comparison-operators">Comparison operators</a></li>

  1496. <li><a class="reference internal" href="#arithmetic-operators">Arithmetic operators</a></li>

  1497. </ul>

  1498. </li>

  1499. </ul>

  1500. </li>

  1501. <li><a class="reference internal" href="#ip-network-definitions">IP Network definitions</a><ul>

  1502. <li><a class="reference internal" href="#prefix-net-mask-and-host-mask">Prefix, net mask and host mask</a></li>

  1503. <li><a class="reference internal" href="#network-objects">Network objects</a></li>

  1504. <li><a class="reference internal" href="#id1">Operators</a><ul>

  1505. <li><a class="reference internal" href="#logical-operators">Logical operators</a></li>

  1506. <li><a class="reference internal" href="#iteration">Iteration</a></li>

  1507. <li><a class="reference internal" href="#networks-as-containers-of-addresses">Networks as containers of addresses</a></li>

  1508. </ul>

  1509. </li>

  1510. </ul>

  1511. </li>

  1512. <li><a class="reference internal" href="#interface-objects">Interface objects</a><ul>

  1513. <li><a class="reference internal" href="#id2">Operators</a><ul>

  1514. <li><a class="reference internal" href="#id3">Logical operators</a></li>

  1515. </ul>

  1516. </li>

  1517. </ul>

  1518. </li>

  1519. <li><a class="reference internal" href="#other-module-level-functions">Other Module Level Functions</a></li>

  1520. <li><a class="reference internal" href="#custom-exceptions">Custom Exceptions</a></li>

  1521. </ul>

  1522. </li>

  1523. </ul>

  1524. 

  1525.   </div>

  1526.   <div>

  1527.     <h4>Previous topic</h4>

  1528.     <p class="topless"><a href="xmlrpc.server.html"

  1529.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">xmlrpc.server</span></code> — Basic XML-RPC servers</a></p>

  1530.   </div>

  1531.   <div>

  1532.     <h4>Next topic</h4>

  1533.     <p class="topless"><a href="mm.html"

  1534.                           title="next chapter">Multimedia Services</a></p>

  1535.   </div>

  1536.   <div role="note" aria-label="source link">

  1537.     <h3>This Page</h3>

  1538.     <ul class="this-page-menu">

  1539.       <li><a href="../bugs.html">Report a Bug</a></li>

  1540.       <li>

  1541.         <a href="https://github.com/python/cpython/blob/main/Doc/library/ipaddress.rst"

  1542.             rel="nofollow">Show Source

  1543.         </a>

  1544.       </li>

  1545.     </ul>

  1546.   </div>

  1547.         </div>

  1548. <div id="sidebarbutton" title="Collapse sidebar">

  1549. <span>«</span>

  1550. </div>

  1551. 

  1552.       </div>

  1553.       <div class="clearer"></div>

  1554.     </div>  

  1555.     <div class="related" role="navigation" aria-label="related navigation">

  1556.       <h3>Navigation</h3>

  1557.       <ul>

  1558.         <li class="right" style="margin-right: 10px">

  1559.           <a href="../genindex.html" title="General Index"

  1560.              >index</a></li>

  1561.         <li class="right" >

  1562.           <a href="../py-modindex.html" title="Python Module Index"

  1563.              >modules</a> |</li>

  1564.         <li class="right" >

  1565.           <a href="mm.html" title="Multimedia Services"

  1566.              >next</a> |</li>

  1567.         <li class="right" >

  1568.           <a href="xmlrpc.server.html" title="xmlrpc.server — Basic XML-RPC servers"

  1569.              >previous</a> |</li>

  1570. 

  1571.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  1572.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  1573.           <li class="switchers">

  1574.             <div class="language_switcher_placeholder"></div>

  1575.             <div class="version_switcher_placeholder"></div>

  1576.           </li>

  1577.           <li>

  1578.               

  1579.           </li>

  1580.     <li id="cpython-language-and-version">

  1581.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  1582.     </li>

  1583. 

  1584.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  1585.           <li class="nav-item nav-item-2"><a href="internet.html" >Internet Protocols and Support</a> &#187;</li>

  1586.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">ipaddress</span></code> — IPv4/IPv6 manipulation library</a></li>

  1587.                 <li class="right">

  1588.                     

  1589. 

  1590.     <div class="inline-search" role="search">

  1591.         <form class="inline-search" action="../search.html" method="get">

  1592.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  1593.           <input type="submit" value="Go" />

  1594.         </form>

  1595.     </div>

  1596.                      |

  1597.                 </li>

  1598.             <li class="right">

  1599. <label class="theme-selector-label">

  1600.     Theme

  1601.     <select class="theme-selector" oninput="activateTheme(this.value)">

  1602.         <option value="auto" selected>Auto</option>

  1603.         <option value="light">Light</option>

  1604.         <option value="dark">Dark</option>

  1605.     </select>

  1606. </label> |</li>

  1607.             

  1608.       </ul>

  1609.     </div>  

  1610.     <div class="footer">

  1611.     &copy; 

  1612.       <a href="../copyright.html">

  1613.     

  1614.     Copyright

  1615.     

  1616.       </a>

  1617.      2001-2024, Python Software Foundation.

  1618.     <br />

  1619.     This page is licensed under the Python Software Foundation License Version 2.

  1620.     <br />

  1621.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  1622.     <br />

  1623.     

  1624.       See <a href="/license.html">History and License</a> for more information.<br />

  1625.     

  1626.     

  1627.     <br />

  1628. 

  1629.     The Python Software Foundation is a non-profit corporation.

  1630. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  1631. <br />

  1632.     <br />

  1633.       Last updated on Apr 09, 2024 (13:47 UTC).

  1634.     

  1635.       <a href="/bugs.html">Found a bug</a>?

  1636.     

  1637.     <br />

  1638. 

  1639.     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

  1640.     </div>

  1641. 

  1642.   </body>

  1643. </html>
上海开阖软件有限公司 沪ICP备12045867号-1