/usr/share/doc/python-ipy/IPy.html

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" />
<title></title>
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  overflow: hidden;
}

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left, .figure.align-left, object.align-left {
  clear: left ;
  float: left ;
  margin-right: 1em }

img.align-right, .figure.align-right, object.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }

img.align-center, .figure.align-center, object.align-center {
  display: block;
  margin-left: auto;
  margin-right: auto;
}

.align-left {
  text-align: left }

.align-center {
  clear: both ;
  text-align: center }

.align-right {
  text-align: right }

/* reset inner alignment in figures */
div.align-right {
  text-align: inherit }

/* div.align-center * { */
/*   text-align: left } */

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }

pre.literal-block, pre.doctest-block, pre.math, pre.code {
  margin-left: 2em ;
  margin-right: 2em }

pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
  border: 0px;
  border-top: 2px solid;
  border-bottom: 2px solid;
  border-collapse: collapse;
}
table.docutils.booktabs * {
  border: 0px;
}
table.docutils.booktabs th {
  border-bottom: thin solid;
  text-align: left;
}

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document">


<p>IPy - class and tools for handling of IPv4 and IPv6 addresses and networks.</p>
<p>Website: <a class="reference external" href="https://github.com/autocracy/python-ipy/">https://github.com/autocracy/python-ipy/</a></p>
<div class="section" id="presentation-of-the-api">
<h1>Presentation of the API</h1>
<p>The IP class allows a comfortable parsing and handling for most
notations in use for IPv4 and IPv6 addresses and networks. It was
greatly inspired by RIPE's Perl module NET::IP's interface but
doesn't share the implementation. It doesn't share non-CIDR netmasks,
so funky stuff like a netmask of 0xffffff0f can't be done here.</p>
<blockquote>
<pre class="doctest-block">
&gt;&gt;&gt; from IPy import IP
&gt;&gt;&gt; ip = IP('127.0.0.0/30')
&gt;&gt;&gt; for x in ip:
...  print(x)
...
127.0.0.0
127.0.0.1
127.0.0.2
127.0.0.3
&gt;&gt;&gt; ip2 = IP('0x7f000000/30')
&gt;&gt;&gt; ip == ip2
1
&gt;&gt;&gt; ip.reverseNames()
['0.0.0.127.in-addr.arpa.', '1.0.0.127.in-addr.arpa.', '2.0.0.127.in-addr.arpa.', '3.0.0.127.in-addr.arpa.']
&gt;&gt;&gt; ip.reverseName()
'0-3.0.0.127.in-addr.arpa.'
&gt;&gt;&gt; ip.iptype()
'PRIVATE'
</pre>
</blockquote>
</div>
<div class="section" id="supports-most-ip-address-formats">
<h1>Supports most IP address formats</h1>
<p>It can detect about a dozen different ways of expressing IP addresses
and networks, parse them and distinguish between IPv4 and IPv6 addresses:</p>
<blockquote>
<pre class="doctest-block">
&gt;&gt;&gt; IP('10.0.0.0/8').version()
4
&gt;&gt;&gt; IP('::1').version()
6
</pre>
</blockquote>
<div class="section" id="ipv4-addresses">
<h2>IPv4 addresses</h2>
<blockquote>
<pre class="doctest-block">
&gt;&gt;&gt; print(IP(0x7f000001))
127.0.0.1
&gt;&gt;&gt; print(IP('0x7f000001'))
127.0.0.1
&gt;&gt;&gt; print(IP('127.0.0.1'))
127.0.0.1
&gt;&gt;&gt; print(IP('10'))
10.0.0.0
</pre>
</blockquote>
</div>
<div class="section" id="ipv6-addresses">
<h2>IPv6 addresses</h2>
<blockquote>
<pre class="doctest-block">
&gt;&gt;&gt; print(IP('1080:0:0:0:8:800:200C:417A'))
1080::8:800:200c:417a
&gt;&gt;&gt; print(IP('1080::8:800:200C:417A'))
1080::8:800:200c:417a
&gt;&gt;&gt; print(IP('::1'))
::1
&gt;&gt;&gt; print(IP('::13.1.68.3'))
::d01:4403
</pre>
</blockquote>
</div>
<div class="section" id="network-mask-and-prefixes">
<h2>Network mask and prefixes</h2>
<blockquote>
<pre class="doctest-block">
&gt;&gt;&gt; print(IP('127.0.0.0/8'))
127.0.0.0/8
&gt;&gt;&gt; print(IP('127.0.0.0/255.0.0.0'))
127.0.0.0/8
&gt;&gt;&gt; print(IP('127.0.0.0-127.255.255.255'))
127.0.0.0/8
</pre>
</blockquote>
</div>
</div>
<div class="section" id="derive-network-address">
<h1>Derive network address</h1>
<p>IPy can transform an IP address into a network address by applying the given
netmask:
&gt;&gt;&gt; print(IP('127.0.0.1/255.0.0.0', make_net=True))
127.0.0.0/8</p>
<p>This can also be done for existing IP instances:
&gt;&gt;&gt; print(IP('127.0.0.1').make_net('255.0.0.0'))
127.0.0.0/8</p>
</div>
<div class="section" id="convert-address-to-string">
<h1>Convert address to string</h1>
<p>Nearly all class methods which return a string have an optional
parameter 'wantprefixlen' which controls if the prefixlen or netmask
is printed. Per default the prefilen is always shown if the network
contains more than one address:</p>
<pre class="literal-block">
wantprefixlen == 0 / None     don't return anything   1.2.3.0
wantprefixlen == 1            /prefix                 1.2.3.0/24
wantprefixlen == 2            /netmask                1.2.3.0/255.255.255.0
wantprefixlen == 3            -lastip                 1.2.3.0-1.2.3.255
</pre>
<p>You can also change the defaults on an per-object basis by fiddling with
the class members:</p>
<blockquote>
<ul class="simple">
<li>NoPrefixForSingleIp</li>
<li>WantPrefixLen</li>
</ul>
</blockquote>
<p>Examples of string conversions:</p>
<blockquote>
<pre class="doctest-block">
&gt;&gt;&gt; IP('10.0.0.0/32').strNormal()
'10.0.0.0'
&gt;&gt;&gt; IP('10.0.0.0/24').strNormal()
'10.0.0.0/24'
&gt;&gt;&gt; IP('10.0.0.0/24').strNormal(0)
'10.0.0.0'
&gt;&gt;&gt; IP('10.0.0.0/24').strNormal(1)
'10.0.0.0/24'
&gt;&gt;&gt; IP('10.0.0.0/24').strNormal(2)
'10.0.0.0/255.255.255.0'
&gt;&gt;&gt; IP('10.0.0.0/24').strNormal(3)
'10.0.0.0-10.0.0.255'
&gt;&gt;&gt; ip = IP('10.0.0.0')
&gt;&gt;&gt; print(ip)
10.0.0.0
&gt;&gt;&gt; ip.NoPrefixForSingleIp = None
&gt;&gt;&gt; print(ip)
10.0.0.0/32
&gt;&gt;&gt; ip.WantPrefixLen = 3
&gt;&gt;&gt; print(ip)
10.0.0.0-10.0.0.0
</pre>
</blockquote>
</div>
<div class="section" id="work-with-multiple-networks">
<h1>Work with multiple networks</h1>
<p>Simple addition of neighboring netblocks that can be aggregated will yield
a parent network of both, but more complex range mapping and aggregation
requires is available with the IPSet class which will hold any number of
unique address ranges and will aggregate overlapping ranges.</p>
<blockquote>
<pre class="doctest-block">
&gt;&gt;&gt; from IPy import IP, IPSet
&gt;&gt;&gt; IP('10.0.0.0/22') - IP('10.0.2.0/24')
IPSet([IP('10.0.0.0/23'), IP('10.0.3.0/24')])
&gt;&gt;&gt; IPSet([IP('10.0.0.0/23'), IP('10.0.3.0/24'), IP('10.0.2.0/24')])
IPSet([IP('10.0.0.0/22')])
&gt;&gt;&gt; s = IPSet([IP('10.0.0.0/22')])
&gt;&gt;&gt; s.add(IP('192.168.1.0/29'))
&gt;&gt;&gt; s
IPSet([IP('10.0.0.0/22'), IP('192.168.1.0/29')])
&gt;&gt;&gt; s.discard(IP('192.168.1.2'))
&gt;&gt;&gt; s
IPSet([IP('10.0.0.0/22'), IP('192.168.1.0/31'), IP('192.168.1.3'), IP('192.168.1.4/30')])
</pre>
</blockquote>
<p>IPSet supports the <cite>set</cite> method <cite>isdisjoint</cite>:</p>
<blockquote>
<pre class="doctest-block">
&gt;&gt;&gt; s.isdisjoint(IPSet([IP('192.168.0.0/16')]))
False
&gt;&gt;&gt; s.isdisjoint(IPSet([IP('172.16.0.0/12')]))
True
</pre>
</blockquote>
<p>IPSet supports intersection:</p>
<blockquote>
<pre class="doctest-block">
&gt;&gt;&gt; s &amp; IPSet([IP('10.0.0.0/8')])
IPSet([IP('10.0.0.0/22')])
</pre>
</blockquote>
</div>
<div class="section" id="compatibility-and-links">
<h1>Compatibility and links</h1>
<p>IPy 0.83 works on Python version 2.6 - 3.4.</p>
<p>The IP module should work in Python 2.5 as long as the subtraction operation
is not used. IPSet requires features of the collecitons class which appear
in Python 2.6, though they can be backported.</p>
</div>
<div class="section" id="eratta">
<h1>Eratta</h1>
<p>When using IPv6 addresses, it is best to compare using IP().len() instead of
len(IP). Addresses with an integer value &gt; 64 bits can break the 2nd method.
See <a class="reference external" href="http://stackoverflow.com/questions/15650878">http://stackoverflow.com/questions/15650878</a> for more info.</p>
<p>Fuzz testing for IPSet will throw spurious errors when the IPSet module
combines two smaller prefixes into a larger prefix that matches the random
prefix tested against.</p>
<p>This Python module is under BSD license: see COPYING file.</p>
<p>Further Information might be available at:
<a class="reference external" href="https://github.com/autocracy/python-ipy">https://github.com/autocracy/python-ipy</a></p>
</div>
</div>
</body>
</html>
python-ipy 1:0.83-1 / usr / share / doc / python-ipy / IPy.html
