1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>netaddr.address.CIDR</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="netaddr-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>netaddr</th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="netaddr-module.html">Package netaddr</a> ::
<a href="netaddr.address-module.html" onclick="show_private();">Module address</a> ::
Class CIDR
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="netaddr.address.CIDR-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class CIDR</h1><p class="nomargin-top"><span class="codelink"><a href="netaddr.address-pysrc.html#CIDR">source code</a></span></p>
<pre class="base-tree">
object --+
|
<a href="netaddr.address.IPRange-class.html">IPRange</a> --+
|
<strong class="uidshort">CIDR</strong>
</pre>
<hr />
<p>Represents blocks of IPv4 and IPv6 addresses using CIDR (Classless
Inter-Domain Routing) notation.</p>
<p>CIDR is a method of categorising contiguous blocks of both IPv4 and
IPv6 addresses. It is very scalable allowing for the optimal usage of the
IP address space. It permits the aggregation of networks via route
summarisation (supernetting) where adjacent routes can be combined into a
single route easily. This greatly assists in the reduction of routing
table sizes and improves network router efficiency.</p>
<p>CIDR blocks are represented by a base network address and a prefix
indicating the size of the (variable length) subnet mask. These are
separated by a single '/' character. Subnet sizes increase in powers of
base 2 aligning to bit boundaries.</p>
<p>It is technically invalid to have non-zero bits in a CIDR address to
the right of the implied netmask. For user convenience this is however
configurable and can be disabled using a constructor argument.</p>
<p>The constructor accepts CIDRs expressed in one of 4 different ways
:-</p>
<p>A) Standard CIDR format :-</p>
<p>IPv4:</p>
<pre class="literalblock">
x.x.x.x/y -> 192.0.2.0/24
</pre>
<p>where the x's represent the network address and y is the netmask
prefix between 0 and 32.</p>
<p>IPv6:</p>
<pre class="literalblock">
x::/y -> fe80::/10
</pre>
<p>where the x's represent the network address and y is the netmask
prefix between 0 and 128.</p>
<p>B) Abbreviated CIDR format (IPv4 only):</p>
<pre class="literalblock">
x -> 192
x/y -> 10/8
x.x/y -> 192.168/16
x.x.x/y -> 192.168.0/24
</pre>
<p>which are equivalent to:</p>
<pre class="literalblock">
x.0.0.0/y -> 192.0.0.0/24
x.0.0.0/y -> 10.0.0.0/8
x.x.0.0/y -> 192.168.0.0/16
x.x.x.0/y -> 192.168.0.0/24
- The trailing zeros are implicit.
- Old classful IP address rules apply if y is omitted.
</pre>
<p>C) Hybrid CIDR format (prefix replaced by netmask) :-</p>
<p>IPv4:</p>
<pre class="literalblock">
x.x.x.x/y.y.y.y -> 192.0.2.0/255.255.255.0
</pre>
<p>IPv6:</p>
<pre class="literalblock">
x::/y:: -> fe80::/ffc0::
</pre>
<p>where the y's represent a valid netmask.</p>
<p>D) ACL-style CIDR format (prefix is replaced by a hostmask) :-</p>
<p>Akin to Cisco's ACL (Access Control List) bitmasking (reverse
netmasks).</p>
<p>IPv4:</p>
<pre class="literalblock">
x.x.x.x/y.y.y.y -> 192.0.2.0/0.0.0.255
</pre>
<p>IPv6:</p>
<pre class="literalblock">
x::/y:: -> fe80::/3f:ffff:ffff:ffff:ffff:ffff:ffff:ffff
</pre>
<p>where the y's represent a valid hostmask.</p>
<p>Reference: RFCs 1338 and 4632.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="netaddr.address.CIDR-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">cidr</span>,
<span class="summary-sig-arg">fmt</span>=<span class="summary-sig-default"><class 'netaddr.address.IP'></span>,
<span class="summary-sig-arg">strict</span>=<span class="summary-sig-default">True</span>)</span><br />
Constructor.</td>
<td align="right" valign="top">
<span class="codelink"><a href="netaddr.address-pysrc.html#CIDR.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="netaddr.address.CIDR-class.html#__sub__" class="summary-sig-name">__sub__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
Subtract another CIDR from this one.</td>
<td align="right" valign="top">
<span class="codelink"><a href="netaddr.address-pysrc.html#CIDR.__sub__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="netaddr.address.CIDR-class.html#__add__" class="summary-sig-name">__add__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">other</span>)</span><br />
Add another CIDR to this one returning a CIDR supernet that will
contain both in the smallest possible sized range.</td>
<td align="right" valign="top">
<span class="codelink"><a href="netaddr.address-pysrc.html#CIDR.__add__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="netaddr.address.CIDR-class.html#subnet" class="summary-sig-name">subnet</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">prefixlen</span>,
<span class="summary-sig-arg">count</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">fmt</span>=<span class="summary-sig-default">None</span>)</span><br />
A generator that returns CIDR subnets based on the current network
base address and provided CIDR prefix and count.</td>
<td align="right" valign="top">
<span class="codelink"><a href="netaddr.address-pysrc.html#CIDR.subnet">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="netaddr.address.CIDR-class.html#cidrs" class="summary-sig-name">cidrs</a>(<span class="summary-sig-arg">self</span>)</span><br />
Returns:
A list of a copy of this <a href="netaddr.address.CIDR-class.html"
class="link">CIDR</a> object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="netaddr.address-pysrc.html#CIDR.cidrs">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="netaddr.address.CIDR-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
str(x)</td>
<td align="right" valign="top">
<span class="codelink"><a href="netaddr.address-pysrc.html#CIDR.__str__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="netaddr.address.CIDR-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
Returns:
executable Python string to recreate equivalent object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="netaddr.address-pysrc.html#CIDR.__repr__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="netaddr.address.IPRange-class.html">IPRange</a></code></b>:
<code><a href="netaddr.address.IPRange-class.html#__contains__">__contains__</a></code>,
<code><a href="netaddr.address.IPRange-class.html#__eq__">__eq__</a></code>,
<code><a href="netaddr.address.IPRange-class.html#__ge__">__ge__</a></code>,
<code><a href="netaddr.address.IPRange-class.html#__getitem__">__getitem__</a></code>,
<code><a href="netaddr.address.IPRange-class.html#__gt__">__gt__</a></code>,
<code><a href="netaddr.address.IPRange-class.html#__hash__">__hash__</a></code>,
<code><a href="netaddr.address.IPRange-class.html#__iadd__">__iadd__</a></code>,
<code><a href="netaddr.address.IPRange-class.html#__isub__">__isub__</a></code>,
<code><a href="netaddr.address.IPRange-class.html#__iter__">__iter__</a></code>,
<code><a href="netaddr.address.IPRange-class.html#__le__">__le__</a></code>,
<code><a href="netaddr.address.IPRange-class.html#__len__">__len__</a></code>,
<code><a href="netaddr.address.IPRange-class.html#__lt__">__lt__</a></code>,
<code><a href="netaddr.address.IPRange-class.html#__ne__">__ne__</a></code>,
<code><a href="netaddr.address.IPRange-class.html#adjacent">adjacent</a></code>,
<code><a href="netaddr.address.IPRange-class.html#format">format</a></code>,
<code><a href="netaddr.address.IPRange-class.html#iprange">iprange</a></code>,
<code><a href="netaddr.address.IPRange-class.html#issubnet">issubnet</a></code>,
<code><a href="netaddr.address.IPRange-class.html#issupernet">issupernet</a></code>,
<code><a href="netaddr.address.IPRange-class.html#overlaps">overlaps</a></code>,
<code><a href="netaddr.address.IPRange-class.html#size">size</a></code>,
<code><a href="netaddr.address.IPRange-class.html#wildcard">wildcard</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__getattribute__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__setattr__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== STATIC METHODS ==================== -->
<a name="section-StaticMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Static Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="netaddr.address.CIDR-class.html#abbrev_to_verbose" class="summary-sig-name">abbrev_to_verbose</a>(<span class="summary-sig-arg">abbrev_cidr</span>)</span><br />
A static method that converts abbreviated IPv4 CIDRs to their more
verbose equivalent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="netaddr.address-pysrc.html#CIDR.abbrev_to_verbose">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="netaddr.address.CIDR-class.html#span" class="summary-sig-name">span</a>(<span class="summary-sig-arg">addrs</span>,
<span class="summary-sig-arg">fmt</span>=<span class="summary-sig-default">None</span>)</span><br />
Static method that accepts a sequence of IP addresses and/or CIDRs,
Wildcards and IPRanges returning a single CIDR that is large enough
to span the lowest and highest IP addresses in the sequence (with a
possible overlap on either end).</td>
<td align="right" valign="top">
<span class="codelink"><a href="netaddr.address-pysrc.html#CIDR.span">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Class Variables</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="STRATEGIES"></a><span class="summary-name">STRATEGIES</span> = <code title="ST_IPV4, ST_IPV6">ST_IPV4, ST_IPV6</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="ADDR_TYPES"></a><span class="summary-name">ADDR_TYPES</span> = <code title="AT_UNSPEC, AT_INET, AT_INET6">AT_UNSPEC, AT_INET, AT_INET6</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="strategy"></a><span class="summary-name">strategy</span> = <code title="StrategyDescriptor(STRATEGIES)">StrategyDescriptor(STRATEGIES)</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="addr_type"></a><span class="summary-name">addr_type</span> = <code title="AddrTypeDescriptor(ADDR_TYPES)">AddrTypeDescriptor(ADDR_TYPES)</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="prefixlen"></a><span class="summary-name">prefixlen</span> = <code title="PrefixLenDescriptor('CIDR')">PrefixLenDescriptor('CIDR')</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="fmt"></a><span class="summary-name">fmt</span> = <code title="FormatDescriptor(IP)">FormatDescriptor(IP)</code>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="netaddr.address.IPRange-class.html">IPRange</a></code></b>:
<code><a href="netaddr.address.IPRange-class.html#first">first</a></code>,
<code><a href="netaddr.address.IPRange-class.html#last">last</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Properties</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="netaddr.address.CIDR-class.html#network" class="summary-name">network</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="netaddr.address.CIDR-class.html#broadcast" class="summary-name">broadcast</a><br />
<b>Please Note:</b> although IPv6 doesn't actually recognise the
concept of a 'broadcast' address as the last address in a subnet (as
in IPv4) so many other libraries do this that it isn't worth trying
to resist.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="netaddr.address.CIDR-class.html#netmask" class="summary-name">netmask</a>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="netaddr.address.CIDR-class.html#hostmask" class="summary-name">hostmask</a>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="abbrev_to_verbose"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">abbrev_to_verbose</span>(<span class="sig-arg">abbrev_cidr</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="netaddr.address-pysrc.html#CIDR.abbrev_to_verbose">source code</a></span>
</td>
</tr></table>
<p>A static method that converts abbreviated IPv4 CIDRs to their more
verbose equivalent.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>abbrev_cidr</code></strong> - an abbreviated CIDR.
<p>Uses the old-style classful IP address rules to decide on a
default subnet prefix if one is not explicitly provided.</p>
<p>Only supports IPv4 addresses.</p>
<p>Examples :</p>
<pre class="literalblock">
10 - 10.0.0.0/8
10/16 - 10.0.0.0/16
128 - 128.0.0.0/16
128/8 - 128.0.0.0/8
192.168 - 192.168.0.0/16
</pre></li>
</ul></dd>
<dt>Returns:</dt>
<dd>A verbose CIDR from an abbreviated CIDR or old-style classful
network address, <code>None</code> if format provided was not
recognised or supported.</dd>
</dl>
</td></tr></table>
</div>
<a name="span"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">span</span>(<span class="sig-arg">addrs</span>,
<span class="sig-arg">fmt</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">Static Method</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="netaddr.address-pysrc.html#CIDR.span">source code</a></span>
</td>
</tr></table>
<p>Static method that accepts a sequence of IP addresses and/or CIDRs,
Wildcards and IPRanges returning a single CIDR that is large enough to
span the lowest and highest IP addresses in the sequence (with a possible
overlap on either end).</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>addrs</code></strong> - a sequence of IP, CIDR, Wildcard or IPRange objects and/or their
string representations.</li>
<li><strong class="pname"><code>fmt</code></strong> - (optional) callable used on return values. (Default: None - <a
href="netaddr.address.CIDR-class.html" class="link">CIDR</a>
object) Also accepts str() and unicode().</li>
</ul></dd>
<dt>Returns:</dt>
<dd>a single CIDR object spanning all addresses.</dd>
</dl>
</td></tr></table>
</div>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">cidr</span>,
<span class="sig-arg">fmt</span>=<span class="sig-default"><class 'netaddr.address.IP'></span>,
<span class="sig-arg">strict</span>=<span class="sig-default">True</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="netaddr.address-pysrc.html#CIDR.__init__">source code</a></span>
</td>
</tr></table>
<p>Constructor.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>cidr</code></strong> - a valid IPv4/IPv6 CIDR address or abbreviated IPv4 network
address.</li>
<li><strong class="pname"><code>fmt</code></strong> - (optional) callable used on return values. Default: <a
href="netaddr.address.IP-class.html" class="link">IP</a> class.
See <a href="netaddr.address-module.html#nrange"
class="link">nrange()</a> documentations for more details on the
various options.</li>
<li><strong class="pname"><code>strict</code></strong> - (optional) performs a test to ensure there are no non-zero bits
to the right of the subnet mask or prefix when it is applied to
the base address. (default: True)</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<a name="__sub__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__sub__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">other</span>)</span>
<br /><em class="fname">(Subtraction operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="netaddr.address-pysrc.html#CIDR.__sub__">source code</a></span>
</td>
</tr></table>
<p>Subtract another CIDR from this one.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>other</code></strong> - a CIDR object that is greater than or equal to <code>self</code>.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>A list of CIDR objects than remain after subtracting
<code>other</code> from <code>self</code>.</dd>
</dl>
</td></tr></table>
</div>
<a name="__add__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__add__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">other</span>)</span>
<br /><em class="fname">(Addition operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="netaddr.address-pysrc.html#CIDR.__add__">source code</a></span>
</td>
</tr></table>
<p>Add another CIDR to this one returning a CIDR supernet that will
contain both in the smallest possible sized range.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>other</code></strong> - a CIDR object.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>A new (potentially larger) CIDR object.</dd>
</dl>
</td></tr></table>
</div>
<a name="subnet"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">subnet</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">prefixlen</span>,
<span class="sig-arg">count</span>=<span class="sig-default">None</span>,
<span class="sig-arg">fmt</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="netaddr.address-pysrc.html#CIDR.subnet">source code</a></span>
</td>
</tr></table>
<p>A generator that returns CIDR subnets based on the current network
base address and provided CIDR prefix and count.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>prefixlen</code></strong> - a CIDR prefix.</li>
<li><strong class="pname"><code>count</code></strong> - number of consecutive CIDRs to be returned.</li>
<li><strong class="pname"><code>fmt</code></strong> - callable used on return values. Default: None - <a
href="netaddr.address.CIDR-class.html" class="link">CIDR</a>
objects. str() and unicode() supported.</li>
</ul></dd>
<dt>Returns:</dt>
<dd>an iterator (as lists could potentially be very large) containing
CIDR subnets below this CIDR's base address.</dd>
</dl>
</td></tr></table>
</div>
<a name="cidrs"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">cidrs</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="netaddr.address-pysrc.html#CIDR.cidrs">source code</a></span>
</td>
</tr></table>
<dl class="fields">
<dt>Returns:</dt>
<dd>A list of a copy of this <a
href="netaddr.address.CIDR-class.html" class="link">CIDR</a>
object. This method is here mainly for compatibility with IPRange
interface.</dd>
<dt>Overrides:
<a href="netaddr.address.IPRange-class.html#cidrs">IPRange.cidrs</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="__str__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Informal representation operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="netaddr.address-pysrc.html#CIDR.__str__">source code</a></span>
</td>
</tr></table>
<p>str(x)</p>
<dl class="fields">
<dt>Overrides:
object.__str__
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="__repr__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Representation operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="netaddr.address-pysrc.html#CIDR.__repr__">source code</a></span>
</td>
</tr></table>
<p>repr(x)</p>
<dl class="fields">
<dt>Returns:</dt>
<dd>executable Python string to recreate equivalent object.</dd>
<dt>Overrides:
object.__repr__
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Property Details</span></td>
</tr>
</table>
<a name="network"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">network</h3>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.network(<span class="summary-sig-arg">self</span>)</span>
- Returns:
The network (first) address in this CIDR block.
</dd>
</dl>
</td></tr></table>
</div>
<a name="broadcast"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">broadcast</h3>
<p><b>Please Note:</b> although IPv6 doesn't actually recognise the
concept of a 'broadcast' address as the last address in a subnet (as in
IPv4) so many other libraries do this that it isn't worth trying to
resist. This issue raises so many user queries that it is easier to
dispense with the theory and be pragmatic instead.</p>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.broadcast(<span class="summary-sig-arg">self</span>)</span>
- <b>Please Note:</b> although IPv6 doesn't actually recognise the concept of
a 'broadcast' address as the last address in a subnet (as in IPv4) so many
other libraries do this that it isn't worth trying to resist.
</dd>
</dl>
</td></tr></table>
</div>
<a name="netmask"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">netmask</h3>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.netmask(<span class="summary-sig-arg">self</span>)</span>
- Returns:
The subnet mask address of this CIDR block.
</dd>
</dl>
</td></tr></table>
</div>
<a name="hostmask"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">hostmask</h3>
<dl class="fields">
<dt>Get Method:</dt>
<dd class="value"><span class="summary-sig"><i>unreachable</i>.hostmask(<span class="summary-sig-arg">self</span>)</span>
- Returns:
The host mask address of this CIDR block.
</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="netaddr-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
>netaddr</th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Wed Jan 21 01:00:23 2009
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
|
