Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
2to3.html	70.96 KB	-rw-r--r--
__future__.html	20.75 KB	-rw-r--r--
__main__.html	44.87 KB	-rw-r--r--
_thread.html	30.39 KB	-rw-r--r--
abc.html	46.87 KB	-rw-r--r--
aifc.html	35.56 KB	-rw-r--r--
allos.html	34.33 KB	-rw-r--r--
archiving.html	17 KB	-rw-r--r--
argparse.html	300.89 KB	-rw-r--r--
array.html	37.28 KB	-rw-r--r--
ast.html	293.08 KB	-rw-r--r--
asynchat.html	37.41 KB	-rw-r--r--
asyncio-api-index.html	27.68 KB	-rw-r--r--
asyncio-dev.html	36.1 KB	-rw-r--r--
asyncio-eventloop.html	204.43 KB	-rw-r--r--
asyncio-exceptions.html	17.11 KB	-rw-r--r--
asyncio-future.html	38.23 KB	-rw-r--r--
asyncio-llapi-index.html	61.97 KB	-rw-r--r--
asyncio-platforms.html	21.77 KB	-rw-r--r--
asyncio-policy.html	39.56 KB	-rw-r--r--
asyncio-protocol.html	118.33 KB	-rw-r--r--
asyncio-queue.html	31.86 KB	-rw-r--r--
asyncio-stream.html	69.98 KB	-rw-r--r--
asyncio-subprocess.html	49.25 KB	-rw-r--r--
asyncio-sync.html	42.79 KB	-rw-r--r--
asyncio-task.html	109.14 KB	-rw-r--r--
asyncio.html	17.31 KB	-rw-r--r--
asyncore.html	49.36 KB	-rw-r--r--
atexit.html	22.87 KB	-rw-r--r--
audioop.html	46 KB	-rw-r--r--
audit_events.html	72.85 KB	-rw-r--r--
base64.html	48.09 KB	-rw-r--r--
bdb.html	66 KB	-rw-r--r--
binary.html	15.97 KB	-rw-r--r--
binascii.html	36.3 KB	-rw-r--r--
binhex.html	15.97 KB	-rw-r--r--
bisect.html	43.38 KB	-rw-r--r--
builtins.html	14.87 KB	-rw-r--r--
bz2.html	50.68 KB	-rw-r--r--
calendar.html	69.35 KB	-rw-r--r--
cgi.html	59.95 KB	-rw-r--r--
cgitb.html	19.96 KB	-rw-r--r--
chunk.html	22.21 KB	-rw-r--r--
cmath.html	43.89 KB	-rw-r--r--
cmd.html	50.42 KB	-rw-r--r--
code.html	35.38 KB	-rw-r--r--
codecs.html	157.96 KB	-rw-r--r--
codeop.html	18.26 KB	-rw-r--r--
collections.abc.html	79.17 KB	-rw-r--r--
collections.html	189.43 KB	-rw-r--r--
colorsys.html	17.31 KB	-rw-r--r--
compileall.html	50.68 KB	-rw-r--r--
concurrency.html	24.15 KB	-rw-r--r--
concurrent.futures.html	79.03 KB	-rw-r--r--
concurrent.html	11.56 KB	-rw-r--r--
configparser.html	159.4 KB	-rw-r--r--
constants.html	22.41 KB	-rw-r--r--
contextlib.html	117.2 KB	-rw-r--r--
contextvars.html	38.38 KB	-rw-r--r--
copy.html	17.92 KB	-rw-r--r--
copyreg.html	18.63 KB	-rw-r--r--
crypt.html	28.29 KB	-rw-r--r--
crypto.html	13.93 KB	-rw-r--r--
csv.html	82.89 KB	-rw-r--r--
ctypes.html	295.49 KB	-rw-r--r--
curses.ascii.html	32.04 KB	-rw-r--r--
curses.html	221.24 KB	-rw-r--r--
curses.panel.html	22.16 KB	-rw-r--r--
custominterp.html	11.85 KB	-rw-r--r--
dataclasses.html	113.16 KB	-rw-r--r--
datatypes.html	31.82 KB	-rw-r--r--
datetime.html	374.92 KB	-rw-r--r--
dbm.html	51.16 KB	-rw-r--r--
debug.html	17 KB	-rw-r--r--
decimal.html	270.12 KB	-rw-r--r--
development.html	32.34 KB	-rw-r--r--
devmode.html	31.72 KB	-rw-r--r--
dialog.html	43.03 KB	-rw-r--r--
difflib.html	111.99 KB	-rw-r--r--
dis.html	136.07 KB	-rw-r--r--
distribution.html	13.67 KB	-rw-r--r--
distutils.html	14.73 KB	-rw-r--r--
doctest.html	199.32 KB	-rw-r--r--
email.charset.html	31.92 KB	-rw-r--r--
email.compat32-message.html	97.74 KB	-rw-r--r--
email.contentmanager.html	37.02 KB	-rw-r--r--
email.encoders.html	18.47 KB	-rw-r--r--
email.errors.html	24.45 KB	-rw-r--r--
email.examples.html	60.49 KB	-rw-r--r--
email.generator.html	48.79 KB	-rw-r--r--
email.header.html	37.61 KB	-rw-r--r--
email.headerregistry.html	66.26 KB	-rw-r--r--
email.html	30.75 KB	-rw-r--r--
email.iterators.html	18.23 KB	-rw-r--r--
email.message.html	99.75 KB	-rw-r--r--
email.mime.html	44.89 KB	-rw-r--r--
email.parser.html	57.39 KB	-rw-r--r--
email.policy.html	84.24 KB	-rw-r--r--
email.utils.html	42.57 KB	-rw-r--r--
ensurepip.html	23.9 KB	-rw-r--r--
enum.html	151 KB	-rw-r--r--
errno.html	60.17 KB	-rw-r--r--
exceptions.html	108.44 KB	-rw-r--r--
faulthandler.html	31.5 KB	-rw-r--r--
fcntl.html	36.67 KB	-rw-r--r--
filecmp.html	32.08 KB	-rw-r--r--
fileformats.html	13.52 KB	-rw-r--r--
fileinput.html	40.37 KB	-rw-r--r--
filesys.html	16.78 KB	-rw-r--r--
fnmatch.html	21.02 KB	-rw-r--r--
fractions.html	35.29 KB	-rw-r--r--
frameworks.html	16.15 KB	-rw-r--r--
ftplib.html	71.97 KB	-rw-r--r--
functional.html	12.19 KB	-rw-r--r--
functions.html	260.33 KB	-rw-r--r--
functools.html	92.96 KB	-rw-r--r--
gc.html	40.97 KB	-rw-r--r--
getopt.html	29.4 KB	-rw-r--r--
getpass.html	16.01 KB	-rw-r--r--
gettext.html	98.02 KB	-rw-r--r--
glob.html	27.2 KB	-rw-r--r--
graphlib.html	34.82 KB	-rw-r--r--
grp.html	16.03 KB	-rw-r--r--
gzip.html	45.65 KB	-rw-r--r--
hashlib.html	93.19 KB	-rw-r--r--
heapq.html	42.43 KB	-rw-r--r--
hmac.html	24.74 KB	-rw-r--r--
html.entities.html	14.91 KB	-rw-r--r--
html.html	14.81 KB	-rw-r--r--
html.parser.html	47.7 KB	-rw-r--r--
http.client.html	85.63 KB	-rw-r--r--
http.cookiejar.html	113.94 KB	-rw-r--r--
http.cookies.html	47.64 KB	-rw-r--r--
http.html	45.52 KB	-rw-r--r--
http.server.html	73.05 KB	-rw-r--r--
i18n.html	13.44 KB	-rw-r--r--
idle.html	77.18 KB	-rw-r--r--
imaplib.html	87.08 KB	-rw-r--r--
imghdr.html	17.94 KB	-rw-r--r--
imp.html	54.32 KB	-rw-r--r--
importlib.html	239.96 KB	-rw-r--r--
importlib.metadata.html	43.14 KB	-rw-r--r--
index.html	75.06 KB	-rw-r--r--
inspect.html	168.74 KB	-rw-r--r--
internet.html	29.89 KB	-rw-r--r--
intro.html	13.81 KB	-rw-r--r--
io.html	154.15 KB	-rw-r--r--
ipaddress.html	137.75 KB	-rw-r--r--
ipc.html	12.6 KB	-rw-r--r--
itertools.html	153.27 KB	-rw-r--r--
json.html	98.9 KB	-rw-r--r--
keyword.html	14.88 KB	-rw-r--r--
language.html	16.71 KB	-rw-r--r--
linecache.html	18.09 KB	-rw-r--r--
locale.html	77.35 KB	-rw-r--r--
logging.config.html	100.3 KB	-rw-r--r--
logging.handlers.html	146.28 KB	-rw-r--r--
logging.html	169.67 KB	-rw-r--r--
lzma.html	66.89 KB	-rw-r--r--
mailbox.html	176.34 KB	-rw-r--r--
mailcap.html	20.86 KB	-rw-r--r--
markup.html	22.31 KB	-rw-r--r--
marshal.html	24.43 KB	-rw-r--r--
math.html	85.82 KB	-rw-r--r--
mimetypes.html	40.27 KB	-rw-r--r--
mm.html	11.16 KB	-rw-r--r--
mmap.html	55.53 KB	-rw-r--r--
modulefinder.html	23.67 KB	-rw-r--r--
modules.html	15.88 KB	-rw-r--r--
msilib.html	78.38 KB	-rw-r--r--
msvcrt.html	29.22 KB	-rw-r--r--
multiprocessing.html	405.24 KB	-rw-r--r--
multiprocessing.shared_memory....	60 KB	-rw-r--r--
netdata.html	20.24 KB	-rw-r--r--
netrc.html	20.39 KB	-rw-r--r--
nis.html	16.76 KB	-rw-r--r--
nntplib.html	84.93 KB	-rw-r--r--
numbers.html	45.67 KB	-rw-r--r--
numeric.html	19.29 KB	-rw-r--r--
operator.html	107.32 KB	-rw-r--r--
optparse.html	256.96 KB	-rw-r--r--
os.html	594.39 KB	-rw-r--r--
os.path.html	65.54 KB	-rw-r--r--
ossaudiodev.html	56.35 KB	-rw-r--r--
pathlib.html	170.01 KB	-rw-r--r--
pdb.html	68.67 KB	-rw-r--r--
persistence.html	19.13 KB	-rw-r--r--
pickle.html	154.45 KB	-rw-r--r--
pickletools.html	22.92 KB	-rw-r--r--
pipes.html	21.7 KB	-rw-r--r--
pkgutil.html	42.76 KB	-rw-r--r--
platform.html	45.08 KB	-rw-r--r--
plistlib.html	30.06 KB	-rw-r--r--
poplib.html	41.42 KB	-rw-r--r--
posix.html	20.96 KB	-rw-r--r--
pprint.html	55.35 KB	-rw-r--r--
profile.html	84.63 KB	-rw-r--r--
pty.html	23.7 KB	-rw-r--r--
pwd.html	16.84 KB	-rw-r--r--
py_compile.html	29 KB	-rw-r--r--
pyclbr.html	24.06 KB	-rw-r--r--
pydoc.html	19.59 KB	-rw-r--r--
pyexpat.html	104.38 KB	-rw-r--r--
python.html	22.46 KB	-rw-r--r--
queue.html	43.39 KB	-rw-r--r--
quopri.html	18.64 KB	-rw-r--r--
random.html	86.31 KB	-rw-r--r--
re.html	214.24 KB	-rw-r--r--
readline.html	50.19 KB	-rw-r--r--
reprlib.html	30.85 KB	-rw-r--r--
resource.html	48.26 KB	-rw-r--r--
rlcompleter.html	18.06 KB	-rw-r--r--
runpy.html	30.99 KB	-rw-r--r--
sched.html	27.04 KB	-rw-r--r--
secrets.html	30.2 KB	-rw-r--r--
security_warnings.html	16.21 KB	-rw-r--r--
select.html	74.58 KB	-rw-r--r--
selectors.html	41.91 KB	-rw-r--r--
shelve.html	36.54 KB	-rw-r--r--
shlex.html	61.03 KB	-rw-r--r--
shutil.html	100.13 KB	-rw-r--r--
signal.html	95.39 KB	-rw-r--r--
site.html	38.16 KB	-rw-r--r--
smtpd.html	44.09 KB	-rw-r--r--
smtplib.html	81.4 KB	-rw-r--r--
sndhdr.html	16.4 KB	-rw-r--r--
socket.html	256.95 KB	-rw-r--r--
socketserver.html	91.95 KB	-rw-r--r--
spwd.html	16.71 KB	-rw-r--r--
sqlite3.html	225.51 KB	-rw-r--r--
ssl.html	328.83 KB	-rw-r--r--
stat.html	57.79 KB	-rw-r--r--
statistics.html	123.22 KB	-rw-r--r--
stdtypes.html	615.43 KB	-rw-r--r--
string.html	108.03 KB	-rw-r--r--
stringprep.html	24.94 KB	-rw-r--r--
struct.html	70.58 KB	-rw-r--r--
subprocess.html	199.03 KB	-rw-r--r--
sunau.html	39.84 KB	-rw-r--r--
superseded.html	26.21 KB	-rw-r--r--
symtable.html	33.26 KB	-rw-r--r--
sys.html	198.83 KB	-rw-r--r--
sysconfig.html	39.81 KB	-rw-r--r--
syslog.html	27.36 KB	-rw-r--r--
tabnanny.html	16.18 KB	-rw-r--r--
tarfile.html	161.92 KB	-rw-r--r--
telnetlib.html	38.21 KB	-rw-r--r--
tempfile.html	58.39 KB	-rw-r--r--
termios.html	22.86 KB	-rw-r--r--
test.html	222.85 KB	-rw-r--r--
text.html	16.8 KB	-rw-r--r--
textwrap.html	48.83 KB	-rw-r--r--
threading.html	128.33 KB	-rw-r--r--
time.html	107.46 KB	-rw-r--r--
timeit.html	52.63 KB	-rw-r--r--
tk.html	28.08 KB	-rw-r--r--
tkinter.colorchooser.html	14.49 KB	-rw-r--r--
tkinter.dnd.html	17.09 KB	-rw-r--r--
tkinter.font.html	22.21 KB	-rw-r--r--
tkinter.html	106.85 KB	-rw-r--r--
tkinter.messagebox.html	20.09 KB	-rw-r--r--
tkinter.scrolledtext.html	14.52 KB	-rw-r--r--
tkinter.tix.html	59.69 KB	-rw-r--r--
tkinter.ttk.html	138.37 KB	-rw-r--r--
token.html	45.73 KB	-rw-r--r--
tokenize.html	39.86 KB	-rw-r--r--
trace.html	38.85 KB	-rw-r--r--
traceback.html	75.61 KB	-rw-r--r--
tracemalloc.html	122.33 KB	-rw-r--r--
tty.html	14.46 KB	-rw-r--r--
turtle.html	271.71 KB	-rw-r--r--
types.html	64.85 KB	-rw-r--r--
typing.html	315.69 KB	-rw-r--r--
unicodedata.html	27.3 KB	-rw-r--r--
unittest.html	310.01 KB	-rw-r--r--
unittest.mock-examples.html	177.75 KB	-rw-r--r--
unittest.mock.html	363.51 KB	-rw-r--r--
unix.html	13.46 KB	-rw-r--r--
urllib.error.html	18.56 KB	-rw-r--r--
urllib.html	12.92 KB	-rw-r--r--
urllib.parse.html	104.65 KB	-rw-r--r--
urllib.request.html	208.87 KB	-rw-r--r--
urllib.robotparser.html	22.63 KB	-rw-r--r--
uu.html	18.2 KB	-rw-r--r--
uuid.html	42.88 KB	-rw-r--r--
venv.html	90.43 KB	-rw-r--r--
warnings.html	69.13 KB	-rw-r--r--
wave.html	36.12 KB	-rw-r--r--
weakref.html	73.36 KB	-rw-r--r--
webbrowser.html	33.98 KB	-rw-r--r--
windows.html	12.32 KB	-rw-r--r--
winreg.html	89.48 KB	-rw-r--r--
winsound.html	26.3 KB	-rw-r--r--
wsgiref.html	111.52 KB	-rw-r--r--
xdrlib.html	42.07 KB	-rw-r--r--
xml.dom.html	114.66 KB	-rw-r--r--
xml.dom.minidom.html	49.6 KB	-rw-r--r--
xml.dom.pulldom.html	30.06 KB	-rw-r--r--
xml.etree.elementtree.html	186.49 KB	-rw-r--r--
xml.html	22.34 KB	-rw-r--r--
xml.sax.handler.html	55.78 KB	-rw-r--r--
xml.sax.html	31.74 KB	-rw-r--r--
xml.sax.reader.html	56.23 KB	-rw-r--r--
xml.sax.utils.html	22.28 KB	-rw-r--r--
xmlrpc.client.html	79.73 KB	-rw-r--r--
xmlrpc.html	11.9 KB	-rw-r--r--
xmlrpc.server.html	63.56 KB	-rw-r--r--
zipapp.html	52.45 KB	-rw-r--r--
zipfile.html	116.59 KB	-rw-r--r--
zipimport.html	33.76 KB	-rw-r--r--
zlib.html	42.29 KB	-rw-r--r--
zoneinfo.html	57.25 KB	-rw-r--r--

Code Editor : ipaddress.html

<!DOCTYPE html>

<title>ipaddress — IPv4/IPv6 manipulation library &#8212; Python 3.10.12 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?2022.1" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 3.10.12 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="Multimedia Services" href="mm.html" />
 <link rel="prev" title="xmlrpc.server — Basic XML-RPC servers" href="xmlrpc.server.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/library/ipaddress.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <label for="menuToggler" class="toggler__label">
 
 </label>
 <nav class="nav-content" role="navigation">
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Logo"/>
 </a>
 <div class="version_switcher_placeholder"></div>
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero"
 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" fill="#444"></path>
 </svg>
 <input type="text" name="q" aria-label="Quick search"/>
 <input type="submit" value="Go"/>
 </form>
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">ipaddress</code> — IPv4/IPv6 manipulation library</a><ul>
<li><a class="reference internal" href="#convenience-factory-functions">Convenience factory functions</a></li>
<li><a class="reference internal" href="#ip-addresses">IP Addresses</a><ul>
<li><a class="reference internal" href="#address-objects">Address objects</a></li>
<li><a class="reference internal" href="#conversion-to-strings-and-integers">Conversion to Strings and Integers</a></li>
<li><a class="reference internal" href="#operators">Operators</a><ul>
<li><a class="reference internal" href="#comparison-operators">Comparison operators</a></li>
<li><a class="reference internal" href="#arithmetic-operators">Arithmetic operators</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#ip-network-definitions">IP Network definitions</a><ul>
<li><a class="reference internal" href="#prefix-net-mask-and-host-mask">Prefix, net mask and host mask</a></li>
<li><a class="reference internal" href="#network-objects">Network objects</a></li>
<li><a class="reference internal" href="#id1">Operators</a><ul>
<li><a class="reference internal" href="#logical-operators">Logical operators</a></li>
<li><a class="reference internal" href="#iteration">Iteration</a></li>
<li><a class="reference internal" href="#networks-as-containers-of-addresses">Networks as containers of addresses</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#interface-objects">Interface objects</a><ul>
<li><a class="reference internal" href="#id2">Operators</a><ul>
<li><a class="reference internal" href="#id3">Logical operators</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#other-module-level-functions">Other Module Level Functions</a></li>
<li><a class="reference internal" href="#custom-exceptions">Custom Exceptions</a></li>
</ul>
</li>
</ul>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="mm.html" title="Multimedia Services"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="xmlrpc.server.html" title="xmlrpc.server — Basic XML-RPC servers"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.10.12 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="internet.html" accesskey="U">Internet Protocols and Support</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">ipaddress</code> — IPv4/IPv6 manipulation library</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-ipaddress">
<h1><a class="reference internal" href="#module-ipaddress" title="ipaddress: IPv4/IPv6 manipulation library."><code class="xref py py-mod docutils literal notranslate">ipaddress</code></a> — IPv4/IPv6 manipulation library<a class="headerlink" href="#module-ipaddress" title="Permalink to this headline">¶</a></h1>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.10/Lib/ipaddress.py">Lib/ipaddress.py</a>
<hr class="docutils" />
<a class="reference internal" href="#module-ipaddress" title="ipaddress: IPv4/IPv6 manipulation library."><code class="xref py py-mod docutils literal notranslate">ipaddress</code></a> provides the capabilities to create, manipulate and
operate on IPv4 and IPv6 addresses and networks.
The functions and classes in this module make it straightforward to handle
various tasks related to IP addresses, including checking whether or not two
hosts are on the same subnet, iterating over all hosts in a particular
subnet, checking whether or not a string represents a valid IP address or
network definition, and so on.
This is the full module API reference—for an overview and introduction, see
<a class="reference internal" href="../howto/ipaddress.html#ipaddress-howto">An introduction to the ipaddress module</a>.
<div class="versionadded">
New in version 3.3.
</div>
<section id="convenience-factory-functions">
<h2>Convenience factory functions<a class="headerlink" href="#convenience-factory-functions" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#module-ipaddress" title="ipaddress: IPv4/IPv6 manipulation library."><code class="xref py py-mod docutils literal notranslate">ipaddress</code></a> module provides factory functions to conveniently create
IP addresses, networks and interfaces:
<dl class="py function">
<dt class="sig sig-object py" id="ipaddress.ip_address">
ipaddress.ip_address(address)<a class="headerlink" href="#ipaddress.ip_address" title="Permalink to this definition">¶</a></dt>
<dd>Return an <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate">IPv4Address</code></a> or <a class="reference internal" href="#ipaddress.IPv6Address" title="ipaddress.IPv6Address"><code class="xref py py-class docutils literal notranslate">IPv6Address</code></a> object depending on
the IP address passed as argument. Either IPv4 or IPv6 addresses may be
supplied; integers less than <code class="docutils literal notranslate">2**32</code> will be considered to be IPv4 by default.
A <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> is raised if address does not represent a valid IPv4
or IPv6 address.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; ipaddress.ip_address(&#39;192.168.0.1&#39;)
IPv4Address(&#39;192.168.0.1&#39;)
&gt;&gt;&gt; ipaddress.ip_address(&#39;2001:db8::&#39;)
IPv6Address(&#39;2001:db8::&#39;)
</pre></div>
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="ipaddress.ip_network">
ipaddress.ip_network(address, strict=True)<a class="headerlink" href="#ipaddress.ip_network" title="Permalink to this definition">¶</a></dt>
<dd>Return an <a class="reference internal" href="#ipaddress.IPv4Network" title="ipaddress.IPv4Network"><code class="xref py py-class docutils literal notranslate">IPv4Network</code></a> or <a class="reference internal" href="#ipaddress.IPv6Network" title="ipaddress.IPv6Network"><code class="xref py py-class docutils literal notranslate">IPv6Network</code></a> object depending on
the IP address passed as argument. address is a string or integer
representing the IP network. Either IPv4 or IPv6 networks may be supplied;
integers less than <code class="docutils literal notranslate">2**32</code> will be considered to be IPv4 by default. strict
is passed to <a class="reference internal" href="#ipaddress.IPv4Network" title="ipaddress.IPv4Network"><code class="xref py py-class docutils literal notranslate">IPv4Network</code></a> or <a class="reference internal" href="#ipaddress.IPv6Network" title="ipaddress.IPv6Network"><code class="xref py py-class docutils literal notranslate">IPv6Network</code></a> constructor. A
<a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> is raised if address does not represent a valid IPv4 or
IPv6 address, or if the network has host bits set.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; ipaddress.ip_network(&#39;192.168.0.0/28&#39;)
IPv4Network(&#39;192.168.0.0/28&#39;)
</pre></div>
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="ipaddress.ip_interface">
ipaddress.ip_interface(address)<a class="headerlink" href="#ipaddress.ip_interface" title="Permalink to this definition">¶</a></dt>
<dd>Return an <a class="reference internal" href="#ipaddress.IPv4Interface" title="ipaddress.IPv4Interface"><code class="xref py py-class docutils literal notranslate">IPv4Interface</code></a> or <a class="reference internal" href="#ipaddress.IPv6Interface" title="ipaddress.IPv6Interface"><code class="xref py py-class docutils literal notranslate">IPv6Interface</code></a> object depending
on the IP address passed as argument. address is a string or integer
representing the IP address. Either IPv4 or IPv6 addresses may be supplied;
integers less than <code class="docutils literal notranslate">2**32</code> will be considered to be IPv4 by default. A
<a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> is raised if address does not represent a valid IPv4 or
IPv6 address.
</dd></dl>

One downside of these convenience functions is that the need to handle both
IPv4 and IPv6 formats means that error messages provide minimal
information on the precise error, as the functions don’t know whether the
IPv4 or IPv6 format was intended. More detailed error reporting can be
obtained by calling the appropriate version specific class constructors
directly.
</section>
<section id="ip-addresses">
<h2>IP Addresses<a class="headerlink" href="#ip-addresses" title="Permalink to this headline">¶</a></h2>
<section id="address-objects">
<h3>Address objects<a class="headerlink" href="#address-objects" title="Permalink to this headline">¶</a></h3>
The <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate">IPv4Address</code></a> and <a class="reference internal" href="#ipaddress.IPv6Address" title="ipaddress.IPv6Address"><code class="xref py py-class docutils literal notranslate">IPv6Address</code></a> objects share a lot of common
attributes. Some attributes that are only meaningful for IPv6 addresses are
also implemented by <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate">IPv4Address</code></a> objects, in order to make it easier to
write code that handles both IP versions correctly. Address objects are
<a class="reference internal" href="../glossary.html#term-hashable">hashable</a>, so they can be used as keys in dictionaries.
<dl class="py class">
<dt class="sig sig-object py" id="ipaddress.IPv4Address">
class ipaddress.IPv4Address(address)<a class="headerlink" href="#ipaddress.IPv4Address" title="Permalink to this definition">¶</a></dt>
<dd>Construct an IPv4 address. An <a class="reference internal" href="#ipaddress.AddressValueError" title="ipaddress.AddressValueError"><code class="xref py py-exc docutils literal notranslate">AddressValueError</code></a> is raised if
address is not a valid IPv4 address.
The following constitutes a valid IPv4 address:
<ol class="arabic simple">
<li>A string in decimal-dot notation, consisting of four decimal integers in
the inclusive range 0–255, separated by dots (e.g. <code class="docutils literal notranslate">192.168.0.1</code>). Each
integer represents an octet (byte) in the address. Leading zeroes are
not tolerated to prevent confusion with octal notation.</li>
<li>An integer that fits into 32 bits.</li>
<li>An integer packed into a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> object of length 4 (most
significant octet first).</li>
</ol>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; ipaddress.IPv4Address(&#39;192.168.0.1&#39;)
IPv4Address(&#39;192.168.0.1&#39;)
&gt;&gt;&gt; ipaddress.IPv4Address(3232235521)
IPv4Address(&#39;192.168.0.1&#39;)
&gt;&gt;&gt; ipaddress.IPv4Address(b&#39;\xC0\xA8\x00\x01&#39;)
IPv4Address(&#39;192.168.0.1&#39;)
</pre></div>
</div>
<div class="versionchanged">
Changed in version 3.8: Leading zeros are tolerated, even in ambiguous cases that look like
octal notation.
</div>
<div class="versionchanged">
Changed in version 3.10: Leading zeros are no longer tolerated and are treated as an error.
IPv4 address strings are now parsed as strict as glibc
<a class="reference internal" href="socket.html#socket.inet_pton" title="socket.inet_pton"><code class="xref py py-func docutils literal notranslate">inet_pton()</code></a>.
</div>
<div class="versionchanged">
Changed in version 3.9.5: The above change was also included in Python 3.9 starting with
version 3.9.5.
</div>
<div class="versionchanged">
Changed in version 3.8.12: The above change was also included in Python 3.8 starting with
version 3.8.12.
</div>
<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Address.version">
version<a class="headerlink" href="#ipaddress.IPv4Address.version" title="Permalink to this definition">¶</a></dt>
<dd>The appropriate version number: <code class="docutils literal notranslate">4</code> for IPv4, <code class="docutils literal notranslate">6</code> for IPv6.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Address.max_prefixlen">
max_prefixlen<a class="headerlink" href="#ipaddress.IPv4Address.max_prefixlen" title="Permalink to this definition">¶</a></dt>
<dd>The total number of bits in the address representation for this
version: <code class="docutils literal notranslate">32</code> for IPv4, <code class="docutils literal notranslate">128</code> for IPv6.
The prefix defines the number of leading bits in an address that
are compared to determine whether or not an address is part of a
network.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Address.compressed">
compressed<a class="headerlink" href="#ipaddress.IPv4Address.compressed" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Address.exploded">
exploded<a class="headerlink" href="#ipaddress.IPv4Address.exploded" title="Permalink to this definition">¶</a></dt>
<dd>The string representation in dotted decimal notation. Leading zeroes
are never included in the representation.
As IPv4 does not define a shorthand notation for addresses with octets
set to zero, these two attributes are always the same as <code class="docutils literal notranslate">str(addr)</code>
for IPv4 addresses. Exposing these attributes makes it easier to
write display code that can handle both IPv4 and IPv6 addresses.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Address.packed">
packed<a class="headerlink" href="#ipaddress.IPv4Address.packed" title="Permalink to this definition">¶</a></dt>
<dd>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">bytes</code></a> object of
the appropriate length (most significant octet first). This is 4 bytes
for IPv4 and 16 bytes for IPv6.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Address.reverse_pointer">
reverse_pointer<a class="headerlink" href="#ipaddress.IPv4Address.reverse_pointer" title="Permalink to this definition">¶</a></dt>
<dd>The name of the reverse DNS PTR record for the IP address, e.g.:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; ipaddress.ip_address(&quot;127.0.0.1&quot;).reverse_pointer
&#39;1.0.0.127.in-addr.arpa&#39;
&gt;&gt;&gt; ipaddress.ip_address(&quot;2001:db8::1&quot;).reverse_pointer
&#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;
</pre></div>
</div>
This is the name that could be used for performing a PTR lookup, not the
resolved hostname itself.
<div class="versionadded">
New in version 3.5.
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Address.is_multicast">
is_multicast<a class="headerlink" href="#ipaddress.IPv4Address.is_multicast" title="Permalink to this definition">¶</a></dt>
<dd><code class="docutils literal notranslate">True</code> if the address is reserved for multicast use. See
<a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3171.html">RFC 3171</a> (for IPv4) or <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2373.html">RFC 2373</a> (for IPv6).
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Address.is_private">
is_private<a class="headerlink" href="#ipaddress.IPv4Address.is_private" title="Permalink to this definition">¶</a></dt>
<dd><code class="docutils literal notranslate">True</code> if the address is defined as not globally reachable by
<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>
(for IPv6) with the following exceptions:
<ul>
<li><code class="docutils literal notranslate">is_private</code> is <code class="docutils literal notranslate">False</code> for the shared address space (<code class="docutils literal notranslate">100.64.0.0/10</code>)</li>
<li>For IPv4-mapped IPv6-addresses the <code class="docutils literal notranslate">is_private</code> value is determined by the
semantics of the underlying IPv4 addresses and the following condition holds
(see <a class="reference internal" href="#ipaddress.IPv6Address.ipv4_mapped" title="ipaddress.IPv6Address.ipv4_mapped"><code class="xref py py-attr docutils literal notranslate">IPv6Address.ipv4_mapped</code></a>):
<div class="highlight-python3 notranslate"><div class="highlight"><pre>address.is_private == address.ipv4_mapped.is_private
</pre></div>
</div>
</li>
</ul>
<code class="docutils literal notranslate">is_private</code> has value opposite to <a class="reference internal" href="#ipaddress.IPv4Address.is_global" title="ipaddress.IPv4Address.is_global"><code class="xref py py-attr docutils literal notranslate">is_global</code></a>, except for the shared address space
(<code class="docutils literal notranslate">100.64.0.0/10</code> range) where they are both <code class="docutils literal notranslate">False</code>.
<div class="versionchanged">
Changed in version 3.10.15: Fixed some false positives and false negatives.
<ul class="simple">
<li><code class="docutils literal notranslate">192.0.0.0/24</code> is considered private with the exception of <code class="docutils literal notranslate">192.0.0.9/32</code> and
<code class="docutils literal notranslate">192.0.0.10/32</code> (previously: only the <code class="docutils literal notranslate">192.0.0.0/29</code> sub-range was considered private).</li>
<li><code class="docutils literal notranslate">64:ff9b:1::/48</code> is considered private.</li>
<li><code class="docutils literal notranslate">2002::/16</code> is considered private.</li>
<li>There are exceptions within <code class="docutils literal notranslate">2001::/23</code> (otherwise considered private): <code class="docutils literal notranslate">2001:1::1/128</code>,
<code class="docutils literal notranslate">2001:1::2/128</code>, <code class="docutils literal notranslate">2001:3::/32</code>, <code class="docutils literal notranslate">2001:4:112::/48</code>, <code class="docutils literal notranslate">2001:20::/28</code>, <code class="docutils literal notranslate">2001:30::/28</code>.
The exceptions are not considered private.</li>
</ul>
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Address.is_global">
is_global<a class="headerlink" href="#ipaddress.IPv4Address.is_global" title="Permalink to this definition">¶</a></dt>
<dd><code class="docutils literal notranslate">True</code> if the address is defined as globally reachable by
<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>
(for IPv6) with the following exception:
For IPv4-mapped IPv6-addresses the <code class="docutils literal notranslate">is_private</code> value is determined by the
semantics of the underlying IPv4 addresses and the following condition holds
(see <a class="reference internal" href="#ipaddress.IPv6Address.ipv4_mapped" title="ipaddress.IPv6Address.ipv4_mapped"><code class="xref py py-attr docutils literal notranslate">IPv6Address.ipv4_mapped</code></a>):
<div class="highlight-python3 notranslate"><div class="highlight"><pre>address.is_global == address.ipv4_mapped.is_global
</pre></div>
</div>
<code class="docutils literal notranslate">is_global</code> has value opposite to <a class="reference internal" href="#ipaddress.IPv4Address.is_private" title="ipaddress.IPv4Address.is_private"><code class="xref py py-attr docutils literal notranslate">is_private</code></a>, except for the shared address space
(<code class="docutils literal notranslate">100.64.0.0/10</code> range) where they are both <code class="docutils literal notranslate">False</code>.
<div class="versionadded">
New in version 3.4.
</div>
<div class="versionchanged">
Changed in version 3.10.15: Fixed some false positives and false negatives, see <a class="reference internal" href="#ipaddress.IPv4Address.is_private" title="ipaddress.IPv4Address.is_private"><code class="xref py py-attr docutils literal notranslate">is_private</code></a> for details.
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Address.is_unspecified">
is_unspecified<a class="headerlink" href="#ipaddress.IPv4Address.is_unspecified" title="Permalink to this definition">¶</a></dt>
<dd><code class="docutils literal notranslate">True</code> if the address is unspecified. See <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc5735.html">RFC 5735</a> (for IPv4)
or <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2373.html">RFC 2373</a> (for IPv6).
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Address.is_reserved">
is_reserved<a class="headerlink" href="#ipaddress.IPv4Address.is_reserved" title="Permalink to this definition">¶</a></dt>
<dd><code class="docutils literal notranslate">True</code> if the address is otherwise IETF reserved.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Address.is_loopback">
is_loopback<a class="headerlink" href="#ipaddress.IPv4Address.is_loopback" title="Permalink to this definition">¶</a></dt>
<dd><code class="docutils literal notranslate">True</code> if this is a loopback address. See <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3330.html">RFC 3330</a> (for IPv4)
or <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2373.html">RFC 2373</a> (for IPv6).
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Address.is_link_local">
is_link_local<a class="headerlink" href="#ipaddress.IPv4Address.is_link_local" title="Permalink to this definition">¶</a></dt>
<dd><code class="docutils literal notranslate">True</code> if the address is reserved for link-local usage. See
<a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3927.html">RFC 3927</a>.
</dd></dl>

</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ipaddress.IPv4Address.__format__">
IPv4Address.__format__(fmt)<a class="headerlink" href="#ipaddress.IPv4Address.__format__" title="Permalink to this definition">¶</a></dt>
<dd>Returns a string representation of the IP address, controlled by
an explicit format string.
fmt can be one of the following: <code class="docutils literal notranslate">'s'</code>, the default option,
equivalent to <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-func docutils literal notranslate">str()</code></a>, <code class="docutils literal notranslate">'b'</code> for a zero-padded binary string,
<code class="docutils literal notranslate">'X'</code> or <code class="docutils literal notranslate">'x'</code> for an uppercase or lowercase hexadecimal
representation, or <code class="docutils literal notranslate">'n'</code>, which is equivalent to <code class="docutils literal notranslate">'b'</code> for IPv4
addresses and <code class="docutils literal notranslate">'x'</code> for IPv6. For binary and hexadecimal
representations, the form specifier <code class="docutils literal notranslate">'#'</code> and the grouping option
<code class="docutils literal notranslate">'_'</code> are available. <code class="docutils literal notranslate">__format__</code> is used by <code class="docutils literal notranslate">format</code>, <code class="docutils literal notranslate">str.format</code>
and f-strings.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; format(ipaddress.IPv4Address(&#39;192.168.0.1&#39;))
&#39;192.168.0.1&#39;
&gt;&gt;&gt; &#39;{:#b}&#39;.format(ipaddress.IPv4Address(&#39;192.168.0.1&#39;))
&#39;0b11000000101010000000000000000001&#39;
&gt;&gt;&gt; f&#39;{ipaddress.IPv6Address(&quot;2001:db8::1000&quot;):s}&#39;
&#39;2001:db8::1000&#39;
&gt;&gt;&gt; format(ipaddress.IPv6Address(&#39;2001:db8::1000&#39;), &#39;_X&#39;)
&#39;2001_0DB8_0000_0000_0000_0000_0000_1000&#39;
&gt;&gt;&gt; &#39;{:#_n}&#39;.format(ipaddress.IPv6Address(&#39;2001:db8::1000&#39;))
&#39;0x2001_0db8_0000_0000_0000_0000_0000_1000&#39;
</pre></div>
</div>
<div class="versionadded">
New in version 3.9.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="ipaddress.IPv6Address">
class ipaddress.IPv6Address(address)<a class="headerlink" href="#ipaddress.IPv6Address" title="Permalink to this definition">¶</a></dt>
<dd>Construct an IPv6 address. An <a class="reference internal" href="#ipaddress.AddressValueError" title="ipaddress.AddressValueError"><code class="xref py py-exc docutils literal notranslate">AddressValueError</code></a> is raised if
address is not a valid IPv6 address.
The following constitutes a valid IPv6 address:
<ol class="arabic">
<li>A string consisting of eight groups of four hexadecimal digits, each
group representing 16 bits. The groups are separated by colons.
This describes an exploded (longhand) notation. The string can
also be compressed (shorthand notation) by various means. See
<a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4291.html">RFC 4291</a> for details. For example,
<code class="docutils literal notranslate">&quot;0000:0000:0000:0000:0000:0abc:0007:0def&quot;</code> can be compressed to
<code class="docutils literal notranslate">&quot;::abc:7:def&quot;</code>.
Optionally, the string may also have a scope zone ID, expressed
with a suffix <code class="docutils literal notranslate">%scope_id</code>. If present, the scope ID must be non-empty,
and may not contain <code class="docutils literal notranslate">%</code>.
See <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4007.html">RFC 4007</a> for details.
For example, <code class="docutils literal notranslate">fe80::1234%1</code> might identify address <code class="docutils literal notranslate">fe80::1234</code> on the first link of the node.
</li>
<li>An integer that fits into 128 bits.</li>
<li>An integer packed into a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> object of length 16, big-endian.</li>
</ol>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; ipaddress.IPv6Address(&#39;2001:db8::1000&#39;)
IPv6Address(&#39;2001:db8::1000&#39;)
&gt;&gt;&gt; ipaddress.IPv6Address(&#39;ff02::5678%1&#39;)
IPv6Address(&#39;ff02::5678%1&#39;)
</pre></div>
</div>
<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.compressed">
compressed<a class="headerlink" href="#ipaddress.IPv6Address.compressed" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

The short form of the address representation, with leading zeroes in
groups omitted and the longest sequence of groups consisting entirely of
zeroes collapsed to a single empty group.
This is also the value returned by <code class="docutils literal notranslate">str(addr)</code> for IPv6 addresses.
<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.exploded">
exploded<a class="headerlink" href="#ipaddress.IPv6Address.exploded" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

The long form of the address representation, with all leading zeroes and
groups consisting entirely of zeroes included.
For the following attributes and methods, see the corresponding
documentation of the <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate">IPv4Address</code></a> class:
<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.packed">
packed<a class="headerlink" href="#ipaddress.IPv6Address.packed" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.reverse_pointer">
reverse_pointer<a class="headerlink" href="#ipaddress.IPv6Address.reverse_pointer" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.version">
version<a class="headerlink" href="#ipaddress.IPv6Address.version" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.max_prefixlen">
max_prefixlen<a class="headerlink" href="#ipaddress.IPv6Address.max_prefixlen" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.is_multicast">
is_multicast<a class="headerlink" href="#ipaddress.IPv6Address.is_multicast" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.is_private">
is_private<a class="headerlink" href="#ipaddress.IPv6Address.is_private" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.is_global">
is_global<a class="headerlink" href="#ipaddress.IPv6Address.is_global" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.is_unspecified">
is_unspecified<a class="headerlink" href="#ipaddress.IPv6Address.is_unspecified" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.is_reserved">
is_reserved<a class="headerlink" href="#ipaddress.IPv6Address.is_reserved" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.is_loopback">
is_loopback<a class="headerlink" href="#ipaddress.IPv6Address.is_loopback" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.is_link_local">
is_link_local<a class="headerlink" href="#ipaddress.IPv6Address.is_link_local" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.4: is_global
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.is_site_local">
is_site_local<a class="headerlink" href="#ipaddress.IPv6Address.is_site_local" title="Permalink to this definition">¶</a></dt>
<dd><code class="docutils literal notranslate">True</code> if the address is reserved for site-local usage. Note that
the site-local address space has been deprecated by <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3879.html">RFC 3879</a>. Use
<a class="reference internal" href="#ipaddress.IPv4Address.is_private" title="ipaddress.IPv4Address.is_private"><code class="xref py py-attr docutils literal notranslate">is_private</code></a> to test if this address is in the
space of unique local addresses as defined by <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4193.html">RFC 4193</a>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.ipv4_mapped">
ipv4_mapped<a class="headerlink" href="#ipaddress.IPv6Address.ipv4_mapped" title="Permalink to this definition">¶</a></dt>
<dd>For addresses that appear to be IPv4 mapped addresses (starting with
<code class="docutils literal notranslate">::FFFF/96</code>), this property will report the embedded IPv4 address.
For any other address, this property will be <code class="docutils literal notranslate">None</code>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.scope_id">
scope_id<a class="headerlink" href="#ipaddress.IPv6Address.scope_id" title="Permalink to this definition">¶</a></dt>
<dd>For scoped addresses as defined by <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4007.html">RFC 4007</a>, this property identifies
the particular zone of the address’s scope that the address belongs to,
as a string. When no scope zone is specified, this property will be <code class="docutils literal notranslate">None</code>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.sixtofour">
sixtofour<a class="headerlink" href="#ipaddress.IPv6Address.sixtofour" title="Permalink to this definition">¶</a></dt>
<dd>For addresses that appear to be 6to4 addresses (starting with
<code class="docutils literal notranslate">2002::/16</code>) as defined by <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc3056.html">RFC 3056</a>, this property will report
the embedded IPv4 address. For any other address, this property will
be <code class="docutils literal notranslate">None</code>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.teredo">
teredo<a class="headerlink" href="#ipaddress.IPv6Address.teredo" title="Permalink to this definition">¶</a></dt>
<dd>For addresses that appear to be Teredo addresses (starting with
<code class="docutils literal notranslate">2001::/32</code>) as defined by <a class="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc4380.html">RFC 4380</a>, this property will report
the embedded <code class="docutils literal notranslate">(server, client)</code> IP address pair. For any other
address, this property will be <code class="docutils literal notranslate">None</code>.
</dd></dl>

</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ipaddress.IPv6Address.__format__">
IPv6Address.__format__(fmt)<a class="headerlink" href="#ipaddress.IPv6Address.__format__" title="Permalink to this definition">¶</a></dt>
<dd>Refer to the corresponding method documentation in
<a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate">IPv4Address</code></a>.
<div class="versionadded">
New in version 3.9.
</div>
</dd></dl>

</section>
<section id="conversion-to-strings-and-integers">
<h3>Conversion to Strings and Integers<a class="headerlink" href="#conversion-to-strings-and-integers" title="Permalink to this headline">¶</a></h3>
To interoperate with networking interfaces such as the socket module,
addresses must be converted to strings or integers. This is handled using
the <a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-func docutils literal notranslate">str()</code></a> and <a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-func docutils literal notranslate">int()</code></a> builtin functions:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; str(ipaddress.IPv4Address(&#39;192.168.0.1&#39;))
&#39;192.168.0.1&#39;
&gt;&gt;&gt; int(ipaddress.IPv4Address(&#39;192.168.0.1&#39;))
3232235521
&gt;&gt;&gt; str(ipaddress.IPv6Address(&#39;::1&#39;))
&#39;::1&#39;
&gt;&gt;&gt; int(ipaddress.IPv6Address(&#39;::1&#39;))
1
</pre></div>
</div>
Note that IPv6 scoped addresses are converted to integers without scope zone ID.
</section>
<section id="operators">
<h3>Operators<a class="headerlink" href="#operators" title="Permalink to this headline">¶</a></h3>
Address objects support some operators. Unless stated otherwise, operators can
only be applied between compatible objects (i.e. IPv4 with IPv4, IPv6 with
IPv6).
<section id="comparison-operators">
<h4>Comparison operators<a class="headerlink" href="#comparison-operators" title="Permalink to this headline">¶</a></h4>
Address objects can be compared with the usual set of comparison operators.
Same IPv6 addresses with different scope zone IDs are not equal.
Some examples:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; IPv4Address(&#39;127.0.0.2&#39;) &gt; IPv4Address(&#39;127.0.0.1&#39;)
True
&gt;&gt;&gt; IPv4Address(&#39;127.0.0.2&#39;) == IPv4Address(&#39;127.0.0.1&#39;)
False
&gt;&gt;&gt; IPv4Address(&#39;127.0.0.2&#39;) != IPv4Address(&#39;127.0.0.1&#39;)
True
&gt;&gt;&gt; IPv6Address(&#39;fe80::1234&#39;) == IPv6Address(&#39;fe80::1234%1&#39;)
False
&gt;&gt;&gt; IPv6Address(&#39;fe80::1234%1&#39;) != IPv6Address(&#39;fe80::1234%2&#39;)
True
</pre></div>
</div>
</section>
<section id="arithmetic-operators">
<h4>Arithmetic operators<a class="headerlink" href="#arithmetic-operators" title="Permalink to this headline">¶</a></h4>
Integers can be added to or subtracted from address objects. Some examples:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; IPv4Address(&#39;127.0.0.2&#39;) + 3
IPv4Address(&#39;127.0.0.5&#39;)
&gt;&gt;&gt; IPv4Address(&#39;127.0.0.2&#39;) - 3
IPv4Address(&#39;126.255.255.255&#39;)
&gt;&gt;&gt; IPv4Address(&#39;255.255.255.255&#39;) + 1
Traceback (most recent call last):
 File &quot;&lt;stdin&gt;&quot;, line 1, in &lt;module&gt;
ipaddress.AddressValueError: 4294967296 (&gt;= 2**32) is not permitted as an IPv4 address
</pre></div>
</div>
</section>
</section>
</section>
<section id="ip-network-definitions">
<h2>IP Network definitions<a class="headerlink" href="#ip-network-definitions" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#ipaddress.IPv4Network" title="ipaddress.IPv4Network"><code class="xref py py-class docutils literal notranslate">IPv4Network</code></a> and <a class="reference internal" href="#ipaddress.IPv6Network" title="ipaddress.IPv6Network"><code class="xref py py-class docutils literal notranslate">IPv6Network</code></a> objects provide a mechanism
for defining and inspecting IP network definitions. A network definition
consists of a mask and a network address, and as such defines a range of
IP addresses that equal the network address when masked (binary AND) with the
mask. For example, a network definition with the mask <code class="docutils literal notranslate">255.255.255.0</code> and
the network address <code class="docutils literal notranslate">192.168.1.0</code> consists of IP addresses in the inclusive
range <code class="docutils literal notranslate">192.168.1.0</code> to <code class="docutils literal notranslate">192.168.1.255</code>.
<section id="prefix-net-mask-and-host-mask">
<h3>Prefix, net mask and host mask<a class="headerlink" href="#prefix-net-mask-and-host-mask" title="Permalink to this headline">¶</a></h3>
There are several equivalent ways to specify IP network masks. A prefix
<code class="docutils literal notranslate">/&lt;nbits&gt;</code> is a notation that denotes how many high-order bits are set in
the network mask. A net mask is an IP address with some number of
high-order bits set. Thus the prefix <code class="docutils literal notranslate">/24</code> is equivalent to the net mask
<code class="docutils literal notranslate">255.255.255.0</code> in IPv4, or <code class="docutils literal notranslate">ffff:ff00::</code> in IPv6. In addition, a
host mask is the logical inverse of a net mask, and is sometimes used
(for example in Cisco access control lists) to denote a network mask. The
host mask equivalent to <code class="docutils literal notranslate">/24</code> in IPv4 is <code class="docutils literal notranslate">0.0.0.255</code>.
</section>
<section id="network-objects">
<h3>Network objects<a class="headerlink" href="#network-objects" title="Permalink to this headline">¶</a></h3>
All attributes implemented by address objects are implemented by network
objects as well. In addition, network objects implement additional attributes.
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">IPv4Network</code></a> and <a class="reference internal" href="#ipaddress.IPv6Network" title="ipaddress.IPv6Network"><code class="xref py py-class docutils literal notranslate">IPv6Network</code></a>,
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">IPv4Network</code></a>.
Network objects are <a class="reference internal" href="../glossary.html#term-hashable">hashable</a>, so they can be used as keys in
dictionaries.
<dl class="py class">
<dt class="sig sig-object py" id="ipaddress.IPv4Network">
class ipaddress.IPv4Network(address, strict=True)<a class="headerlink" href="#ipaddress.IPv4Network" title="Permalink to this definition">¶</a></dt>
<dd>Construct an IPv4 network definition. address can be one of the following:
<ol class="arabic">
<li>A string consisting of an IP address and an optional mask, separated by
a slash (<code class="docutils literal notranslate">/</code>). The IP address is the network address, and the mask
can be either a single number, which means it’s a prefix, or a string
representation of an IPv4 address. If it’s the latter, the mask is
interpreted as a net mask if it starts with a non-zero field, or as a
host mask if it starts with a zero field, with the single exception of
an all-zero mask which is treated as a net mask. If no mask is provided,
it’s considered to be <code class="docutils literal notranslate">/32</code>.
For example, the following address specifications are equivalent:
<code class="docutils literal notranslate">192.168.1.0/24</code>, <code class="docutils literal notranslate">192.168.1.0/255.255.255.0</code> and
<code class="docutils literal notranslate">192.168.1.0/0.0.0.255</code>.
</li>
<li>An integer that fits into 32 bits. This is equivalent to a
single-address network, with the network address being address and
the mask being <code class="docutils literal notranslate">/32</code>.</li>
<li>An integer packed into a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> object of length 4, big-endian.
The interpretation is similar to an integer address.</li>
<li>A two-tuple of an address description and a netmask, where the address
description is either a string, a 32-bits integer, a 4-bytes packed
integer, or an existing IPv4Address object; and the netmask is either
an integer representing the prefix length (e.g. <code class="docutils literal notranslate">24</code>) or a string
representing the prefix mask (e.g. <code class="docutils literal notranslate">255.255.255.0</code>).</li>
</ol>
An <a class="reference internal" href="#ipaddress.AddressValueError" title="ipaddress.AddressValueError"><code class="xref py py-exc docutils literal notranslate">AddressValueError</code></a> is raised if address is not a valid IPv4
address. A <a class="reference internal" href="#ipaddress.NetmaskValueError" title="ipaddress.NetmaskValueError"><code class="xref py py-exc docutils literal notranslate">NetmaskValueError</code></a> is raised if the mask is not valid for
an IPv4 address.
If strict is <code class="docutils literal notranslate">True</code> and host bits are set in the supplied address,
then <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> is raised. Otherwise, the host bits are masked out
to determine the appropriate network address.
Unless stated otherwise, all network methods accepting other network/address
objects will raise <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a> if the argument’s IP version is
incompatible to <code class="docutils literal notranslate">self</code>.
<div class="versionchanged">
Changed in version 3.5: Added the two-tuple form for the address constructor parameter.
</div>
<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.version">
version<a class="headerlink" href="#ipaddress.IPv4Network.version" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.max_prefixlen">
max_prefixlen<a class="headerlink" href="#ipaddress.IPv4Network.max_prefixlen" title="Permalink to this definition">¶</a></dt>
<dd>Refer to the corresponding attribute documentation in
<a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate">IPv4Address</code></a>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.is_multicast">
is_multicast<a class="headerlink" href="#ipaddress.IPv4Network.is_multicast" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.is_private">
is_private<a class="headerlink" href="#ipaddress.IPv4Network.is_private" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.is_unspecified">
is_unspecified<a class="headerlink" href="#ipaddress.IPv4Network.is_unspecified" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.is_reserved">
is_reserved<a class="headerlink" href="#ipaddress.IPv4Network.is_reserved" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.is_loopback">
is_loopback<a class="headerlink" href="#ipaddress.IPv4Network.is_loopback" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.is_link_local">
is_link_local<a class="headerlink" href="#ipaddress.IPv4Network.is_link_local" title="Permalink to this definition">¶</a></dt>
<dd>These attributes are true for the network as a whole if they are true
for both the network address and the broadcast address.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.network_address">
network_address<a class="headerlink" href="#ipaddress.IPv4Network.network_address" title="Permalink to this definition">¶</a></dt>
<dd>The network address for the network. The network address and the
prefix length together uniquely define a network.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.broadcast_address">
broadcast_address<a class="headerlink" href="#ipaddress.IPv4Network.broadcast_address" title="Permalink to this definition">¶</a></dt>
<dd>The broadcast address for the network. Packets sent to the broadcast
address should be received by every host on the network.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.hostmask">
hostmask<a class="headerlink" href="#ipaddress.IPv4Network.hostmask" title="Permalink to this definition">¶</a></dt>
<dd>The host mask, as an <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate">IPv4Address</code></a> object.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.netmask">
netmask<a class="headerlink" href="#ipaddress.IPv4Network.netmask" title="Permalink to this definition">¶</a></dt>
<dd>The net mask, as an <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate">IPv4Address</code></a> object.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.with_prefixlen">
with_prefixlen<a class="headerlink" href="#ipaddress.IPv4Network.with_prefixlen" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.compressed">
compressed<a class="headerlink" href="#ipaddress.IPv4Network.compressed" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.exploded">
exploded<a class="headerlink" href="#ipaddress.IPv4Network.exploded" title="Permalink to this definition">¶</a></dt>
<dd>A string representation of the network, with the mask in prefix
notation.
<code class="docutils literal notranslate">with_prefixlen</code> and <code class="docutils literal notranslate">compressed</code> are always the same as
<code class="docutils literal notranslate">str(network)</code>.
<code class="docutils literal notranslate">exploded</code> uses the exploded form the network address.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.with_netmask">
with_netmask<a class="headerlink" href="#ipaddress.IPv4Network.with_netmask" title="Permalink to this definition">¶</a></dt>
<dd>A string representation of the network, with the mask in net mask
notation.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.with_hostmask">
with_hostmask<a class="headerlink" href="#ipaddress.IPv4Network.with_hostmask" title="Permalink to this definition">¶</a></dt>
<dd>A string representation of the network, with the mask in host mask
notation.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.num_addresses">
num_addresses<a class="headerlink" href="#ipaddress.IPv4Network.num_addresses" title="Permalink to this definition">¶</a></dt>
<dd>The total number of addresses in the network.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.prefixlen">
prefixlen<a class="headerlink" href="#ipaddress.IPv4Network.prefixlen" title="Permalink to this definition">¶</a></dt>
<dd>Length of the network prefix, in bits.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.hosts">
hosts()<a class="headerlink" href="#ipaddress.IPv4Network.hosts" title="Permalink to this definition">¶</a></dt>
<dd>Returns an iterator over the usable hosts in the network. The usable
hosts are all the IP addresses that belong to the network, except the
network address itself and the network broadcast address. For networks
with a mask length of 31, the network address and network broadcast
address are also included in the result. Networks with a mask of 32
will return a list containing the single host address.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; list(ip_network(&#39;192.0.2.0/29&#39;).hosts()) 
[IPv4Address(&#39;192.0.2.1&#39;), IPv4Address(&#39;192.0.2.2&#39;),
 IPv4Address(&#39;192.0.2.3&#39;), IPv4Address(&#39;192.0.2.4&#39;),
 IPv4Address(&#39;192.0.2.5&#39;), IPv4Address(&#39;192.0.2.6&#39;)]
&gt;&gt;&gt; list(ip_network(&#39;192.0.2.0/31&#39;).hosts())
[IPv4Address(&#39;192.0.2.0&#39;), IPv4Address(&#39;192.0.2.1&#39;)]
&gt;&gt;&gt; list(ip_network(&#39;192.0.2.1/32&#39;).hosts())
[IPv4Address(&#39;192.0.2.1&#39;)]
</pre></div>
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.overlaps">
overlaps(other)<a class="headerlink" href="#ipaddress.IPv4Network.overlaps" title="Permalink to this definition">¶</a></dt>
<dd><code class="docutils literal notranslate">True</code> if this network is partly or wholly contained in other or
other is wholly contained in this network.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.address_exclude">
address_exclude(network)<a class="headerlink" href="#ipaddress.IPv4Network.address_exclude" title="Permalink to this definition">¶</a></dt>
<dd>Computes the network definitions resulting from removing the given
network from this one. Returns an iterator of network objects.
Raises <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> if network is not completely contained in
this network.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; n1 = ip_network(&#39;192.0.2.0/28&#39;)
&gt;&gt;&gt; n2 = ip_network(&#39;192.0.2.1/32&#39;)
&gt;&gt;&gt; list(n1.address_exclude(n2)) 
[IPv4Network(&#39;192.0.2.8/29&#39;), IPv4Network(&#39;192.0.2.4/30&#39;),
 IPv4Network(&#39;192.0.2.2/31&#39;), IPv4Network(&#39;192.0.2.0/32&#39;)]
</pre></div>
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.subnets">
subnets(prefixlen_diff=1, new_prefix=None)<a class="headerlink" href="#ipaddress.IPv4Network.subnets" title="Permalink to this definition">¶</a></dt>
<dd>The subnets that join to make the current network definition, depending
on the argument values. prefixlen_diff is the amount our prefix
length should be increased by. new_prefix is the desired new
prefix of the subnets; it must be larger than our prefix. One and
only one of prefixlen_diff and new_prefix must be set. Returns an
iterator of network objects.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; list(ip_network(&#39;192.0.2.0/24&#39;).subnets())
[IPv4Network(&#39;192.0.2.0/25&#39;), IPv4Network(&#39;192.0.2.128/25&#39;)]
&gt;&gt;&gt; list(ip_network(&#39;192.0.2.0/24&#39;).subnets(prefixlen_diff=2)) 
[IPv4Network(&#39;192.0.2.0/26&#39;), IPv4Network(&#39;192.0.2.64/26&#39;),
 IPv4Network(&#39;192.0.2.128/26&#39;), IPv4Network(&#39;192.0.2.192/26&#39;)]
&gt;&gt;&gt; list(ip_network(&#39;192.0.2.0/24&#39;).subnets(new_prefix=26)) 
[IPv4Network(&#39;192.0.2.0/26&#39;), IPv4Network(&#39;192.0.2.64/26&#39;),
 IPv4Network(&#39;192.0.2.128/26&#39;), IPv4Network(&#39;192.0.2.192/26&#39;)]
&gt;&gt;&gt; list(ip_network(&#39;192.0.2.0/24&#39;).subnets(new_prefix=23))
Traceback (most recent call last):
 File &quot;&lt;stdin&gt;&quot;, line 1, in &lt;module&gt;
 raise ValueError(&#39;new prefix must be longer&#39;)
ValueError: new prefix must be longer
&gt;&gt;&gt; list(ip_network(&#39;192.0.2.0/24&#39;).subnets(new_prefix=25))
[IPv4Network(&#39;192.0.2.0/25&#39;), IPv4Network(&#39;192.0.2.128/25&#39;)]
</pre></div>
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.supernet">
supernet(prefixlen_diff=1, new_prefix=None)<a class="headerlink" href="#ipaddress.IPv4Network.supernet" title="Permalink to this definition">¶</a></dt>
<dd>The supernet containing this network definition, depending on the
argument values. prefixlen_diff is the amount our prefix length
should be decreased by. new_prefix is the desired new prefix of
the supernet; it must be smaller than our prefix. One and only one
of prefixlen_diff and new_prefix must be set. Returns a single
network object.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; ip_network(&#39;192.0.2.0/24&#39;).supernet()
IPv4Network(&#39;192.0.2.0/23&#39;)
&gt;&gt;&gt; ip_network(&#39;192.0.2.0/24&#39;).supernet(prefixlen_diff=2)
IPv4Network(&#39;192.0.0.0/22&#39;)
&gt;&gt;&gt; ip_network(&#39;192.0.2.0/24&#39;).supernet(new_prefix=20)
IPv4Network(&#39;192.0.0.0/20&#39;)
</pre></div>
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.subnet_of">
subnet_of(other)<a class="headerlink" href="#ipaddress.IPv4Network.subnet_of" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if this network is a subnet of other.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; a = ip_network(&#39;192.168.1.0/24&#39;)
&gt;&gt;&gt; b = ip_network(&#39;192.168.1.128/30&#39;)
&gt;&gt;&gt; b.subnet_of(a)
True
</pre></div>
</div>
<div class="versionadded">
New in version 3.7.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.supernet_of">
supernet_of(other)<a class="headerlink" href="#ipaddress.IPv4Network.supernet_of" title="Permalink to this definition">¶</a></dt>
<dd>Return <code class="docutils literal notranslate">True</code> if this network is a supernet of other.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; a = ip_network(&#39;192.168.1.0/24&#39;)
&gt;&gt;&gt; b = ip_network(&#39;192.168.1.128/30&#39;)
&gt;&gt;&gt; a.supernet_of(b)
True
</pre></div>
</div>
<div class="versionadded">
New in version 3.7.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ipaddress.IPv4Network.compare_networks">
compare_networks(other)<a class="headerlink" href="#ipaddress.IPv4Network.compare_networks" title="Permalink to this definition">¶</a></dt>
<dd>Compare this network to other. In this comparison only the network
addresses are considered; host bits aren’t. Returns either <code class="docutils literal notranslate">-1</code>,
<code class="docutils literal notranslate">0</code> or <code class="docutils literal notranslate">1</code>.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; ip_network(&#39;192.0.2.1/32&#39;).compare_networks(ip_network(&#39;192.0.2.2/32&#39;))
-1
&gt;&gt;&gt; ip_network(&#39;192.0.2.1/32&#39;).compare_networks(ip_network(&#39;192.0.2.0/32&#39;))
1
&gt;&gt;&gt; ip_network(&#39;192.0.2.1/32&#39;).compare_networks(ip_network(&#39;192.0.2.1/32&#39;))
0
</pre></div>
</div>
<div class="deprecated">
Deprecated since version 3.7: It uses the same ordering and comparison algorithm as “&lt;”, “==”, and “&gt;”
</div>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="ipaddress.IPv6Network">
class ipaddress.IPv6Network(address, strict=True)<a class="headerlink" href="#ipaddress.IPv6Network" title="Permalink to this definition">¶</a></dt>
<dd>Construct an IPv6 network definition. address can be one of the following:
<ol class="arabic">
<li>A string consisting of an IP address and an optional prefix length,
separated by a slash (<code class="docutils literal notranslate">/</code>). The IP address is the network address,
and the prefix length must be a single number, the prefix. If no
prefix length is provided, it’s considered to be <code class="docutils literal notranslate">/128</code>.
Note that currently expanded netmasks are not supported. That means
<code class="docutils literal notranslate">2001:db00::0/24</code> is a valid argument while <code class="docutils literal notranslate">2001:db00::0/ffff:ff00::</code>
is not.
</li>
<li>An integer that fits into 128 bits. This is equivalent to a
single-address network, with the network address being address and
the mask being <code class="docutils literal notranslate">/128</code>.</li>
<li>An integer packed into a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> object of length 16, big-endian.
The interpretation is similar to an integer address.</li>
<li>A two-tuple of an address description and a netmask, where the address
description is either a string, a 128-bits integer, a 16-bytes packed
integer, or an existing IPv6Address object; and the netmask is an
integer representing the prefix length.</li>
</ol>
An <a class="reference internal" href="#ipaddress.AddressValueError" title="ipaddress.AddressValueError"><code class="xref py py-exc docutils literal notranslate">AddressValueError</code></a> is raised if address is not a valid IPv6
address. A <a class="reference internal" href="#ipaddress.NetmaskValueError" title="ipaddress.NetmaskValueError"><code class="xref py py-exc docutils literal notranslate">NetmaskValueError</code></a> is raised if the mask is not valid for
an IPv6 address.
If strict is <code class="docutils literal notranslate">True</code> and host bits are set in the supplied address,
then <a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> is raised. Otherwise, the host bits are masked out
to determine the appropriate network address.
<div class="versionchanged">
Changed in version 3.5: Added the two-tuple form for the address constructor parameter.
</div>
<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.version">
version<a class="headerlink" href="#ipaddress.IPv6Network.version" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.max_prefixlen">
max_prefixlen<a class="headerlink" href="#ipaddress.IPv6Network.max_prefixlen" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.is_multicast">
is_multicast<a class="headerlink" href="#ipaddress.IPv6Network.is_multicast" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.is_private">
is_private<a class="headerlink" href="#ipaddress.IPv6Network.is_private" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.is_unspecified">
is_unspecified<a class="headerlink" href="#ipaddress.IPv6Network.is_unspecified" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.is_reserved">
is_reserved<a class="headerlink" href="#ipaddress.IPv6Network.is_reserved" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.is_loopback">
is_loopback<a class="headerlink" href="#ipaddress.IPv6Network.is_loopback" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.is_link_local">
is_link_local<a class="headerlink" href="#ipaddress.IPv6Network.is_link_local" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.network_address">
network_address<a class="headerlink" href="#ipaddress.IPv6Network.network_address" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.broadcast_address">
broadcast_address<a class="headerlink" href="#ipaddress.IPv6Network.broadcast_address" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.hostmask">
hostmask<a class="headerlink" href="#ipaddress.IPv6Network.hostmask" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.netmask">
netmask<a class="headerlink" href="#ipaddress.IPv6Network.netmask" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.with_prefixlen">
with_prefixlen<a class="headerlink" href="#ipaddress.IPv6Network.with_prefixlen" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.compressed">
compressed<a class="headerlink" href="#ipaddress.IPv6Network.compressed" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.exploded">
exploded<a class="headerlink" href="#ipaddress.IPv6Network.exploded" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.with_netmask">
with_netmask<a class="headerlink" href="#ipaddress.IPv6Network.with_netmask" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.with_hostmask">
with_hostmask<a class="headerlink" href="#ipaddress.IPv6Network.with_hostmask" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.num_addresses">
num_addresses<a class="headerlink" href="#ipaddress.IPv6Network.num_addresses" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.prefixlen">
prefixlen<a class="headerlink" href="#ipaddress.IPv6Network.prefixlen" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.hosts">
hosts()<a class="headerlink" href="#ipaddress.IPv6Network.hosts" title="Permalink to this definition">¶</a></dt>
<dd>Returns an iterator over the usable hosts in the network. The usable
hosts are all the IP addresses that belong to the network, except the
Subnet-Router anycast address. For networks with a mask length of 127,
the Subnet-Router anycast address is also included in the result.
Networks with a mask of 128 will return a list containing the
single host address.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.overlaps">
overlaps(other)<a class="headerlink" href="#ipaddress.IPv6Network.overlaps" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.address_exclude">
address_exclude(network)<a class="headerlink" href="#ipaddress.IPv6Network.address_exclude" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.subnets">
subnets(prefixlen_diff=1, new_prefix=None)<a class="headerlink" href="#ipaddress.IPv6Network.subnets" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.supernet">
supernet(prefixlen_diff=1, new_prefix=None)<a class="headerlink" href="#ipaddress.IPv6Network.supernet" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.subnet_of">
subnet_of(other)<a class="headerlink" href="#ipaddress.IPv6Network.subnet_of" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.supernet_of">
supernet_of(other)<a class="headerlink" href="#ipaddress.IPv6Network.supernet_of" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.compare_networks">
compare_networks(other)<a class="headerlink" href="#ipaddress.IPv6Network.compare_networks" title="Permalink to this definition">¶</a></dt>
<dd>Refer to the corresponding attribute documentation in
<a class="reference internal" href="#ipaddress.IPv4Network" title="ipaddress.IPv4Network"><code class="xref py py-class docutils literal notranslate">IPv4Network</code></a>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Network.is_site_local">
is_site_local<a class="headerlink" href="#ipaddress.IPv6Network.is_site_local" title="Permalink to this definition">¶</a></dt>
<dd>These attribute is true for the network as a whole if it is true
for both the network address and the broadcast address.
</dd></dl>

</dd></dl>

</section>
<section id="id1">
<h3>Operators<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
Network objects support some operators. Unless stated otherwise, operators can
only be applied between compatible objects (i.e. IPv4 with IPv4, IPv6 with
IPv6).
<section id="logical-operators">
<h4>Logical operators<a class="headerlink" href="#logical-operators" title="Permalink to this headline">¶</a></h4>
Network objects can be compared with the usual set of logical operators.
Network objects are ordered first by network address, then by net mask.
</section>
<section id="iteration">
<h4>Iteration<a class="headerlink" href="#iteration" title="Permalink to this headline">¶</a></h4>
Network objects can be iterated to list all the addresses belonging to the
network. For iteration, all hosts are returned, including unusable hosts
(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">hosts()</code></a> method). An
example:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; for addr in IPv4Network(&#39;192.0.2.0/28&#39;):
... addr
...
IPv4Address(&#39;192.0.2.0&#39;)
IPv4Address(&#39;192.0.2.1&#39;)
IPv4Address(&#39;192.0.2.2&#39;)
IPv4Address(&#39;192.0.2.3&#39;)
IPv4Address(&#39;192.0.2.4&#39;)
IPv4Address(&#39;192.0.2.5&#39;)
IPv4Address(&#39;192.0.2.6&#39;)
IPv4Address(&#39;192.0.2.7&#39;)
IPv4Address(&#39;192.0.2.8&#39;)
IPv4Address(&#39;192.0.2.9&#39;)
IPv4Address(&#39;192.0.2.10&#39;)
IPv4Address(&#39;192.0.2.11&#39;)
IPv4Address(&#39;192.0.2.12&#39;)
IPv4Address(&#39;192.0.2.13&#39;)
IPv4Address(&#39;192.0.2.14&#39;)
IPv4Address(&#39;192.0.2.15&#39;)
</pre></div>
</div>
</section>
<section id="networks-as-containers-of-addresses">
<h4>Networks as containers of addresses<a class="headerlink" href="#networks-as-containers-of-addresses" title="Permalink to this headline">¶</a></h4>
Network objects can act as containers of addresses. Some examples:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>&gt;&gt;&gt; IPv4Network(&#39;192.0.2.0/28&#39;)[0]
IPv4Address(&#39;192.0.2.0&#39;)
&gt;&gt;&gt; IPv4Network(&#39;192.0.2.0/28&#39;)[15]
IPv4Address(&#39;192.0.2.15&#39;)
&gt;&gt;&gt; IPv4Address(&#39;192.0.2.6&#39;) in IPv4Network(&#39;192.0.2.0/28&#39;)
True
&gt;&gt;&gt; IPv4Address(&#39;192.0.3.6&#39;) in IPv4Network(&#39;192.0.2.0/28&#39;)
False
</pre></div>
</div>
</section>
</section>
</section>
<section id="interface-objects">
<h2>Interface objects<a class="headerlink" href="#interface-objects" title="Permalink to this headline">¶</a></h2>
Interface objects are <a class="reference internal" href="../glossary.html#term-hashable">hashable</a>, so they can be used as keys in
dictionaries.
<dl class="py class">
<dt class="sig sig-object py" id="ipaddress.IPv4Interface">
class ipaddress.IPv4Interface(address)<a class="headerlink" href="#ipaddress.IPv4Interface" title="Permalink to this definition">¶</a></dt>
<dd>Construct an IPv4 interface. The meaning of address is as in the
constructor of <a class="reference internal" href="#ipaddress.IPv4Network" title="ipaddress.IPv4Network"><code class="xref py py-class docutils literal notranslate">IPv4Network</code></a>, except that arbitrary host addresses
are always accepted.
<a class="reference internal" href="#ipaddress.IPv4Interface" title="ipaddress.IPv4Interface"><code class="xref py py-class docutils literal notranslate">IPv4Interface</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">IPv4Address</code></a>, so it inherits
all the attributes from that class. In addition, the following attributes
are available:
<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Interface.ip">
ip<a class="headerlink" href="#ipaddress.IPv4Interface.ip" title="Permalink to this definition">¶</a></dt>
<dd>The address (<a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate">IPv4Address</code></a>) without network information.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; interface = IPv4Interface(&#39;192.0.2.5/24&#39;)
&gt;&gt;&gt; interface.ip
IPv4Address(&#39;192.0.2.5&#39;)
</pre></div>
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Interface.network">
network<a class="headerlink" href="#ipaddress.IPv4Interface.network" title="Permalink to this definition">¶</a></dt>
<dd>The network (<a class="reference internal" href="#ipaddress.IPv4Network" title="ipaddress.IPv4Network"><code class="xref py py-class docutils literal notranslate">IPv4Network</code></a>) this interface belongs to.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; interface = IPv4Interface(&#39;192.0.2.5/24&#39;)
&gt;&gt;&gt; interface.network
IPv4Network(&#39;192.0.2.0/24&#39;)
</pre></div>
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Interface.with_prefixlen">
with_prefixlen<a class="headerlink" href="#ipaddress.IPv4Interface.with_prefixlen" title="Permalink to this definition">¶</a></dt>
<dd>A string representation of the interface with the mask in prefix notation.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; interface = IPv4Interface(&#39;192.0.2.5/24&#39;)
&gt;&gt;&gt; interface.with_prefixlen
&#39;192.0.2.5/24&#39;
</pre></div>
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Interface.with_netmask">
with_netmask<a class="headerlink" href="#ipaddress.IPv4Interface.with_netmask" title="Permalink to this definition">¶</a></dt>
<dd>A string representation of the interface with the network as a net mask.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; interface = IPv4Interface(&#39;192.0.2.5/24&#39;)
&gt;&gt;&gt; interface.with_netmask
&#39;192.0.2.5/255.255.255.0&#39;
</pre></div>
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv4Interface.with_hostmask">
with_hostmask<a class="headerlink" href="#ipaddress.IPv4Interface.with_hostmask" title="Permalink to this definition">¶</a></dt>
<dd>A string representation of the interface with the network as a host mask.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; interface = IPv4Interface(&#39;192.0.2.5/24&#39;)
&gt;&gt;&gt; interface.with_hostmask
&#39;192.0.2.5/0.0.0.255&#39;
</pre></div>
</div>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="ipaddress.IPv6Interface">
class ipaddress.IPv6Interface(address)<a class="headerlink" href="#ipaddress.IPv6Interface" title="Permalink to this definition">¶</a></dt>
<dd>Construct an IPv6 interface. The meaning of address is as in the
constructor of <a class="reference internal" href="#ipaddress.IPv6Network" title="ipaddress.IPv6Network"><code class="xref py py-class docutils literal notranslate">IPv6Network</code></a>, except that arbitrary host addresses
are always accepted.
<a class="reference internal" href="#ipaddress.IPv6Interface" title="ipaddress.IPv6Interface"><code class="xref py py-class docutils literal notranslate">IPv6Interface</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">IPv6Address</code></a>, so it inherits
all the attributes from that class. In addition, the following attributes
are available:
<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Interface.ip">
ip<a class="headerlink" href="#ipaddress.IPv6Interface.ip" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Interface.network">
network<a class="headerlink" href="#ipaddress.IPv6Interface.network" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Interface.with_prefixlen">
with_prefixlen<a class="headerlink" href="#ipaddress.IPv6Interface.with_prefixlen" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Interface.with_netmask">
with_netmask<a class="headerlink" href="#ipaddress.IPv6Interface.with_netmask" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="ipaddress.IPv6Interface.with_hostmask">
with_hostmask<a class="headerlink" href="#ipaddress.IPv6Interface.with_hostmask" title="Permalink to this definition">¶</a></dt>
<dd>Refer to the corresponding attribute documentation in
<a class="reference internal" href="#ipaddress.IPv4Interface" title="ipaddress.IPv4Interface"><code class="xref py py-class docutils literal notranslate">IPv4Interface</code></a>.
</dd></dl>

</dd></dl>

<section id="id2">
<h3>Operators<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>
Interface objects support some operators. Unless stated otherwise, operators
can only be applied between compatible objects (i.e. IPv4 with IPv4, IPv6 with
IPv6).
<section id="id3">
<h4>Logical operators<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h4>
Interface objects can be compared with the usual set of logical operators.
For equality comparison (<code class="docutils literal notranslate">==</code> and <code class="docutils literal notranslate">!=</code>), both the IP address and network
must be the same for the objects to be equal. An interface will not compare
equal to any address or network object.
For ordering (<code class="docutils literal notranslate">&lt;</code>, <code class="docutils literal notranslate">&gt;</code>, etc) the rules are different. Interface and
address objects with the same IP version can be compared, and the address
objects will always sort before the interface objects. Two interface objects
are first compared by their networks and, if those are the same, then by their
IP addresses.
</section>
</section>
</section>
<section id="other-module-level-functions">
<h2>Other Module Level Functions<a class="headerlink" href="#other-module-level-functions" title="Permalink to this headline">¶</a></h2>
The module also provides the following module level functions:
<dl class="py function">
<dt class="sig sig-object py" id="ipaddress.v4_int_to_packed">
ipaddress.v4_int_to_packed(address)<a class="headerlink" href="#ipaddress.v4_int_to_packed" title="Permalink to this definition">¶</a></dt>
<dd>Represent an address as 4 packed bytes in network (big-endian) order.
address is an integer representation of an IPv4 IP address. A
<a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> is raised if the integer is negative or too large to be an
IPv4 IP address.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; ipaddress.ip_address(3221225985)
IPv4Address(&#39;192.0.2.1&#39;)
&gt;&gt;&gt; ipaddress.v4_int_to_packed(3221225985)
b&#39;\xc0\x00\x02\x01&#39;
</pre></div>
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="ipaddress.v6_int_to_packed">
ipaddress.v6_int_to_packed(address)<a class="headerlink" href="#ipaddress.v6_int_to_packed" title="Permalink to this definition">¶</a></dt>
<dd>Represent an address as 16 packed bytes in network (big-endian) order.
address is an integer representation of an IPv6 IP address. A
<a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> is raised if the integer is negative or too large to be an
IPv6 IP address.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="ipaddress.summarize_address_range">
ipaddress.summarize_address_range(first, last)<a class="headerlink" href="#ipaddress.summarize_address_range" title="Permalink to this definition">¶</a></dt>
<dd>Return an iterator of the summarized network range given the first and last
IP addresses. first is the first <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate">IPv4Address</code></a> or
<a class="reference internal" href="#ipaddress.IPv6Address" title="ipaddress.IPv6Address"><code class="xref py py-class docutils literal notranslate">IPv6Address</code></a> in the range and last is the last <a class="reference internal" href="#ipaddress.IPv4Address" title="ipaddress.IPv4Address"><code class="xref py py-class docutils literal notranslate">IPv4Address</code></a>
or <a class="reference internal" href="#ipaddress.IPv6Address" title="ipaddress.IPv6Address"><code class="xref py py-class docutils literal notranslate">IPv6Address</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">TypeError</code></a> is raised if
first or last are not IP addresses or are not of the same version. A
<a class="reference internal" href="exceptions.html#ValueError" title="ValueError"><code class="xref py py-exc docutils literal notranslate">ValueError</code></a> is raised if last is not greater than first or if
first address version is not 4 or 6.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; [ipaddr for ipaddr in ipaddress.summarize_address_range(
... ipaddress.IPv4Address(&#39;192.0.2.0&#39;),
... ipaddress.IPv4Address(&#39;192.0.2.130&#39;))]
[IPv4Network(&#39;192.0.2.0/25&#39;), IPv4Network(&#39;192.0.2.128/31&#39;), IPv4Network(&#39;192.0.2.130/32&#39;)]
</pre></div>
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="ipaddress.collapse_addresses">
ipaddress.collapse_addresses(addresses)<a class="headerlink" href="#ipaddress.collapse_addresses" title="Permalink to this definition">¶</a></dt>
<dd>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">IPv4Network</code></a> or
<a class="reference internal" href="#ipaddress.IPv6Network" title="ipaddress.IPv6Network"><code class="xref py py-class docutils literal notranslate">IPv6Network</code></a> objects. addresses is an iterator of
<a class="reference internal" href="#ipaddress.IPv4Network" title="ipaddress.IPv4Network"><code class="xref py py-class docutils literal notranslate">IPv4Network</code></a> or <a class="reference internal" href="#ipaddress.IPv6Network" title="ipaddress.IPv6Network"><code class="xref py py-class docutils literal notranslate">IPv6Network</code></a> objects. A <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a> is
raised if addresses contains mixed version objects.
<div class="doctest highlight-default notranslate"><div class="highlight"><pre>&gt;&gt;&gt; [ipaddr for ipaddr in
... ipaddress.collapse_addresses([ipaddress.IPv4Network(&#39;192.0.2.0/25&#39;),
... ipaddress.IPv4Network(&#39;192.0.2.128/25&#39;)])]
[IPv4Network(&#39;192.0.2.0/24&#39;)]
</pre></div>
</div>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="ipaddress.get_mixed_type_key">
ipaddress.get_mixed_type_key(obj)<a class="headerlink" href="#ipaddress.get_mixed_type_key" title="Permalink to this definition">¶</a></dt>
<dd>Return a key suitable for sorting between networks and addresses. Address
and Network objects are not sortable by default; they’re fundamentally
different, so the expression:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>IPv4Address(&#39;192.0.2.0&#39;) &lt;= IPv4Network(&#39;192.0.2.0/24&#39;)
</pre></div>
</div>
doesn’t make sense. There are some times however, where you may wish to
have <a class="reference internal" href="#module-ipaddress" title="ipaddress: IPv4/IPv6 manipulation library."><code class="xref py py-mod docutils literal notranslate">ipaddress</code></a> sort these anyway. If you need to do this, you can use
this function as the key argument to <a class="reference internal" href="functions.html#sorted" title="sorted"><code class="xref py py-func docutils literal notranslate">sorted()</code></a>.
obj is either a network or address object.
</dd></dl>

</section>
<section id="custom-exceptions">
<h2>Custom Exceptions<a class="headerlink" href="#custom-exceptions" title="Permalink to this headline">¶</a></h2>
To support more specific error reporting from class constructors, the
module defines the following exceptions:
<dl class="py exception">
<dt class="sig sig-object py" id="ipaddress.AddressValueError">
exception ipaddress.AddressValueError(ValueError)<a class="headerlink" href="#ipaddress.AddressValueError" title="Permalink to this definition">¶</a></dt>
<dd>Any value error related to the address.
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="ipaddress.NetmaskValueError">
exception ipaddress.NetmaskValueError(ValueError)<a class="headerlink" href="#ipaddress.NetmaskValueError" title="Permalink to this definition">¶</a></dt>
<dd>Any value error related to the net mask.
</dd></dl>

</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">ipaddress</code> — IPv4/IPv6 manipulation library</a><ul>
<li><a class="reference internal" href="#convenience-factory-functions">Convenience factory functions</a></li>
<li><a class="reference internal" href="#ip-addresses">IP Addresses</a><ul>
<li><a class="reference internal" href="#address-objects">Address objects</a></li>
<li><a class="reference internal" href="#conversion-to-strings-and-integers">Conversion to Strings and Integers</a></li>
<li><a class="reference internal" href="#operators">Operators</a><ul>
<li><a class="reference internal" href="#comparison-operators">Comparison operators</a></li>
<li><a class="reference internal" href="#arithmetic-operators">Arithmetic operators</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#ip-network-definitions">IP Network definitions</a><ul>
<li><a class="reference internal" href="#prefix-net-mask-and-host-mask">Prefix, net mask and host mask</a></li>
<li><a class="reference internal" href="#network-objects">Network objects</a></li>
<li><a class="reference internal" href="#id1">Operators</a><ul>
<li><a class="reference internal" href="#logical-operators">Logical operators</a></li>
<li><a class="reference internal" href="#iteration">Iteration</a></li>
<li><a class="reference internal" href="#networks-as-containers-of-addresses">Networks as containers of addresses</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#interface-objects">Interface objects</a><ul>
<li><a class="reference internal" href="#id2">Operators</a><ul>
<li><a class="reference internal" href="#id3">Logical operators</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference internal" href="#other-module-level-functions">Other Module Level Functions</a></li>
<li><a class="reference internal" href="#custom-exceptions">Custom Exceptions</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="xmlrpc.server.html"
 title="previous chapter"><code class="xref py py-mod docutils literal notranslate">xmlrpc.server</code> — Basic XML-RPC servers</a>
 <h4>Next topic</h4>
 <a href="mm.html"
 title="next chapter">Multimedia Services</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/library/ipaddress.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="mm.html" title="Multimedia Services"
 >next</a> |</li>
 <li class="right" >
 <a href="xmlrpc.server.html" title="xmlrpc.server — Basic XML-RPC servers"
 >previous</a> |</li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="internet.html" >Internet Protocols and Support</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">ipaddress</code> — IPv4/IPv6 manipulation library</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" type="text" name="q" />
 <input type="submit" value="Go" />
 <input type="hidden" name="check_keywords" value="yes" />
 <input type="hidden" name="area" value="default" />
 </form>
 </div>
 |
 </li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 2001-2026, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>

Last updated on January 26, 2026.
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : ipaddress.html