/usr/share/doc/python-netaddr-docs/api/_modules/netaddr/eui.html is in python-netaddr-docs 0.7.18-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!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">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>netaddr.eui — netaddr 0.7.18 documentation</title>
<link rel="stylesheet" href="../../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '0.7.18',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="copyright" title="Copyright" href="../../copyright.html" />
<link rel="top" title="netaddr 0.7.18 documentation" href="../../index.html" />
<link rel="up" title="Module code" href="../index.html" />
</head>
<body role="document">
<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="nav-item nav-item-0"><a href="../../index.html">netaddr 0.7.18 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for netaddr.eui</h1><div class="highlight"><pre>
<span></span><span class="c1">#-----------------------------------------------------------------------------</span>
<span class="c1"># Copyright (c) 2008-2015, David P. D. Moss. All rights reserved.</span>
<span class="c1">#</span>
<span class="c1"># Released under the BSD license. See the LICENSE file for details.</span>
<span class="c1">#-----------------------------------------------------------------------------</span>
<span class="sd">"""</span>
<span class="sd">Classes and functions for dealing with MAC addresses, EUI-48, EUI-64, OUI, IAB</span>
<span class="sd">identifiers.</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">netaddr.core</span> <span class="k">import</span> <span class="n">NotRegisteredError</span><span class="p">,</span> <span class="n">AddrFormatError</span><span class="p">,</span> <span class="n">DictDotLookup</span>
<span class="kn">from</span> <span class="nn">netaddr.strategy</span> <span class="k">import</span> <span class="n">eui48</span> <span class="k">as</span> <span class="n">_eui48</span><span class="p">,</span> <span class="n">eui64</span> <span class="k">as</span> <span class="n">_eui64</span>
<span class="kn">from</span> <span class="nn">netaddr.strategy.eui48</span> <span class="k">import</span> <span class="n">mac_eui48</span>
<span class="kn">from</span> <span class="nn">netaddr.strategy.eui64</span> <span class="k">import</span> <span class="n">eui64_base</span>
<span class="kn">from</span> <span class="nn">netaddr.ip</span> <span class="k">import</span> <span class="n">IPAddress</span>
<span class="kn">from</span> <span class="nn">netaddr.compat</span> <span class="k">import</span> <span class="n">_is_int</span><span class="p">,</span> <span class="n">_is_str</span>
<span class="k">class</span> <span class="nc">BaseIdentifier</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""Base class for all IEEE identifiers."""</span>
<span class="n">__slots__</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'_value'</span><span class="p">,)</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">def</span> <span class="nf">__int__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""":return: integer value of this identifier"""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span>
<span class="k">def</span> <span class="nf">__long__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""":return: integer value of this identifier"""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span>
<span class="k">def</span> <span class="nf">__oct__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""":return: octal string representation of this identifier."""</span>
<span class="c1"># Python 2.x only.</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="s1">'0'</span>
<span class="k">return</span> <span class="s1">'0</span><span class="si">%o</span><span class="s1">'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span>
<span class="k">def</span> <span class="nf">__hex__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""":return: hexadecimal string representation of this identifier."""</span>
<span class="c1"># Python 2.x only.</span>
<span class="k">return</span> <span class="s1">'0x</span><span class="si">%x</span><span class="s1">'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span>
<span class="k">def</span> <span class="nf">__index__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :return: return the integer value of this identifier when passed to</span>
<span class="sd"> hex(), oct() or bin().</span>
<span class="sd"> """</span>
<span class="c1"># Python 3.x only.</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span>
<div class="viewcode-block" id="OUI"><a class="viewcode-back" href="../../api.html#netaddr.OUI">[docs]</a><span class="k">class</span> <span class="nc">OUI</span><span class="p">(</span><span class="n">BaseIdentifier</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> An individual IEEE OUI (Organisationally Unique Identifier).</span>
<span class="sd"> For online details see - http://standards.ieee.org/regauth/oui/</span>
<span class="sd"> """</span>
<span class="n">__slots__</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'records'</span><span class="p">,)</span>
<div class="viewcode-block" id="OUI.__init__"><a class="viewcode-back" href="../../api.html#netaddr.OUI.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">oui</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Constructor</span>
<span class="sd"> :param oui: an OUI string ``XX-XX-XX`` or an unsigned integer. \</span>
<span class="sd"> Also accepts and parses full MAC/EUI-48 address strings (but not \</span>
<span class="sd"> MAC/EUI-48 integers)!</span>
<span class="sd"> """</span>
<span class="nb">super</span><span class="p">(</span><span class="n">OUI</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">()</span>
<span class="c1"># Lazy loading of IEEE data structures.</span>
<span class="kn">from</span> <span class="nn">netaddr.eui</span> <span class="k">import</span> <span class="n">ieee</span>
<span class="bp">self</span><span class="o">.</span><span class="n">records</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">oui</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="c1">#TODO: Improve string parsing here.</span>
<span class="c1">#TODO: Accept full MAC/EUI-48 addressses as well as XX-XX-XX</span>
<span class="c1">#TODO: and just take /16 (see IAB for details)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">oui</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'-'</span><span class="p">,</span> <span class="s1">''</span><span class="p">),</span> <span class="mi">16</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">_is_int</span><span class="p">(</span><span class="n">oui</span><span class="p">):</span>
<span class="k">if</span> <span class="mi">0</span> <span class="o"><=</span> <span class="n">oui</span> <span class="o"><=</span> <span class="mh">0xffffff</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="n">oui</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'OUI int outside expected range: </span><span class="si">%r</span><span class="s1">'</span> <span class="o">%</span> <span class="n">oui</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'unexpected OUI format: </span><span class="si">%r</span><span class="s1">'</span> <span class="o">%</span> <span class="n">oui</span><span class="p">)</span>
<span class="c1"># Discover offsets.</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="ow">in</span> <span class="n">ieee</span><span class="o">.</span><span class="n">OUI_INDEX</span><span class="p">:</span>
<span class="n">fh</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">ieee</span><span class="o">.</span><span class="n">OUI_REGISTRY</span><span class="p">)</span>
<span class="k">for</span> <span class="p">(</span><span class="n">offset</span><span class="p">,</span> <span class="n">size</span><span class="p">)</span> <span class="ow">in</span> <span class="n">ieee</span><span class="o">.</span><span class="n">OUI_INDEX</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">]:</span>
<span class="n">fh</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="n">offset</span><span class="p">)</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">fh</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">size</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_parse_data</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">offset</span><span class="p">,</span> <span class="n">size</span><span class="p">)</span>
<span class="n">fh</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">NotRegisteredError</span><span class="p">(</span><span class="s1">'OUI </span><span class="si">%r</span><span class="s1"> not registered!'</span> <span class="o">%</span> <span class="n">oui</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">OUI</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">other</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">NotImplemented</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_value</span>
<span class="k">def</span> <span class="nf">__ne__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">OUI</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">other</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">NotImplemented</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">!=</span> <span class="n">other</span><span class="o">.</span><span class="n">_value</span>
<div class="viewcode-block" id="OUI.__getstate__"><a class="viewcode-back" href="../../api.html#netaddr.OUI.__getstate__">[docs]</a> <span class="k">def</span> <span class="nf">__getstate__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""":returns: Pickled state of an `OUI` object."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">records</span></div>
<div class="viewcode-block" id="OUI.__setstate__"><a class="viewcode-back" href="../../api.html#netaddr.OUI.__setstate__">[docs]</a> <span class="k">def</span> <span class="nf">__setstate__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="p">):</span>
<span class="sd">""":param state: data used to unpickle a pickled `OUI` object."""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">records</span> <span class="o">=</span> <span class="n">state</span></div>
<span class="k">def</span> <span class="nf">_parse_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">offset</span><span class="p">,</span> <span class="n">size</span><span class="p">):</span>
<span class="sd">"""Returns a dict record from raw OUI record data"""</span>
<span class="n">record</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'idx'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s1">'oui'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
<span class="s1">'org'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
<span class="s1">'address'</span><span class="p">:</span> <span class="p">[],</span>
<span class="s1">'offset'</span><span class="p">:</span> <span class="n">offset</span><span class="p">,</span>
<span class="s1">'size'</span><span class="p">:</span> <span class="n">size</span><span class="p">,</span>
<span class="p">}</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">data</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">):</span>
<span class="n">line</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">line</span><span class="p">:</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="s1">'(hex)'</span> <span class="ow">in</span> <span class="n">line</span><span class="p">:</span>
<span class="n">record</span><span class="p">[</span><span class="s1">'idx'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span>
<span class="n">record</span><span class="p">[</span><span class="s1">'org'</span><span class="p">]</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="mi">2</span><span class="p">)[</span><span class="mi">2</span><span class="p">]</span>
<span class="n">record</span><span class="p">[</span><span class="s1">'oui'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="k">elif</span> <span class="s1">'(base 16)'</span> <span class="ow">in</span> <span class="n">line</span><span class="p">:</span>
<span class="k">continue</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">record</span><span class="p">[</span><span class="s1">'address'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">records</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">record</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">reg_count</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Number of registered organisations with this OUI"""</span>
<span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">records</span><span class="p">)</span>
<div class="viewcode-block" id="OUI.registration"><a class="viewcode-back" href="../../api.html#netaddr.OUI.registration">[docs]</a> <span class="k">def</span> <span class="nf">registration</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> The IEEE registration details for this OUI.</span>
<span class="sd"> :param index: the index of record (may contain multiple registrations)</span>
<span class="sd"> (Default: 0 - first registration)</span>
<span class="sd"> :return: Objectified Python data structure containing registration</span>
<span class="sd"> details.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">DictDotLookup</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">records</span><span class="p">[</span><span class="n">index</span><span class="p">])</span></div>
<div class="viewcode-block" id="OUI.__str__"><a class="viewcode-back" href="../../api.html#netaddr.OUI.__str__">[docs]</a> <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""":return: string representation of this OUI"""</span>
<span class="n">int_val</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span>
<span class="k">return</span> <span class="s2">"</span><span class="si">%02X</span><span class="s2">-</span><span class="si">%02X</span><span class="s2">-</span><span class="si">%02X</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span>
<span class="p">(</span><span class="n">int_val</span> <span class="o">>></span> <span class="mi">16</span><span class="p">)</span> <span class="o">&</span> <span class="mh">0xff</span><span class="p">,</span>
<span class="p">(</span><span class="n">int_val</span> <span class="o">>></span> <span class="mi">8</span><span class="p">)</span> <span class="o">&</span> <span class="mh">0xff</span><span class="p">,</span>
<span class="n">int_val</span> <span class="o">&</span> <span class="mh">0xff</span><span class="p">)</span></div>
<div class="viewcode-block" id="OUI.__repr__"><a class="viewcode-back" href="../../api.html#netaddr.OUI.__repr__">[docs]</a> <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""":return: executable Python string to recreate equivalent object."""</span>
<span class="k">return</span> <span class="s2">"OUI('</span><span class="si">%s</span><span class="s2">')"</span> <span class="o">%</span> <span class="bp">self</span></div></div>
<div class="viewcode-block" id="IAB"><a class="viewcode-back" href="../../api.html#netaddr.IAB">[docs]</a><span class="k">class</span> <span class="nc">IAB</span><span class="p">(</span><span class="n">BaseIdentifier</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> An individual IEEE IAB (Individual Address Block) identifier.</span>
<span class="sd"> For online details see - http://standards.ieee.org/regauth/oui/</span>
<span class="sd"> """</span>
<span class="n">__slots__</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'record'</span><span class="p">,)</span>
<span class="nd">@staticmethod</span>
<div class="viewcode-block" id="IAB.split_iab_mac"><a class="viewcode-back" href="../../api.html#netaddr.IAB.split_iab_mac">[docs]</a> <span class="k">def</span> <span class="nf">split_iab_mac</span><span class="p">(</span><span class="n">eui_int</span><span class="p">,</span> <span class="n">strict</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :param eui_int: a MAC IAB as an unsigned integer.</span>
<span class="sd"> :param strict: If True, raises a ValueError if the last 12 bits of</span>
<span class="sd"> IAB MAC/EUI-48 address are non-zero, ignores them otherwise.</span>
<span class="sd"> (Default: False)</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="mh">0x50c2000</span> <span class="o"><=</span> <span class="n">eui_int</span> <span class="o"><=</span> <span class="mh">0x50c2fff</span><span class="p">:</span>
<span class="k">return</span> <span class="n">eui_int</span><span class="p">,</span> <span class="mi">0</span>
<span class="n">user_mask</span> <span class="o">=</span> <span class="mi">2</span> <span class="o">**</span> <span class="mi">12</span> <span class="o">-</span> <span class="mi">1</span>
<span class="n">iab_mask</span> <span class="o">=</span> <span class="p">(</span><span class="mi">2</span> <span class="o">**</span> <span class="mi">48</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="o">^</span> <span class="n">user_mask</span>
<span class="n">iab_bits</span> <span class="o">=</span> <span class="n">eui_int</span> <span class="o">>></span> <span class="mi">12</span>
<span class="n">user_bits</span> <span class="o">=</span> <span class="p">(</span><span class="n">eui_int</span> <span class="o">|</span> <span class="n">iab_mask</span><span class="p">)</span> <span class="o">-</span> <span class="n">iab_mask</span>
<span class="k">if</span> <span class="mh">0x50c2000</span> <span class="o"><=</span> <span class="n">iab_bits</span> <span class="o"><=</span> <span class="mh">0x50c2fff</span><span class="p">:</span>
<span class="k">if</span> <span class="n">strict</span> <span class="ow">and</span> <span class="n">user_bits</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'</span><span class="si">%r</span><span class="s1"> is not a strict IAB!'</span> <span class="o">%</span> <span class="nb">hex</span><span class="p">(</span><span class="n">user_bits</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'</span><span class="si">%r</span><span class="s1"> is not an IAB address!'</span> <span class="o">%</span> <span class="nb">hex</span><span class="p">(</span><span class="n">eui_int</span><span class="p">))</span>
<span class="k">return</span> <span class="n">iab_bits</span><span class="p">,</span> <span class="n">user_bits</span></div>
<div class="viewcode-block" id="IAB.__init__"><a class="viewcode-back" href="../../api.html#netaddr.IAB.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">iab</span><span class="p">,</span> <span class="n">strict</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Constructor</span>
<span class="sd"> :param iab: an IAB string ``00-50-C2-XX-X0-00`` or an unsigned \</span>
<span class="sd"> integer. This address looks like an EUI-48 but it should not \</span>
<span class="sd"> have any non-zero bits in the last 3 bytes.</span>
<span class="sd"> :param strict: If True, raises a ValueError if the last 12 bits \</span>
<span class="sd"> of IAB MAC/EUI-48 address are non-zero, ignores them otherwise. \</span>
<span class="sd"> (Default: False)</span>
<span class="sd"> """</span>
<span class="nb">super</span><span class="p">(</span><span class="n">IAB</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">()</span>
<span class="c1"># Lazy loading of IEEE data structures.</span>
<span class="kn">from</span> <span class="nn">netaddr.eui</span> <span class="k">import</span> <span class="n">ieee</span>
<span class="bp">self</span><span class="o">.</span><span class="n">record</span> <span class="o">=</span> <span class="p">{</span>
<span class="s1">'idx'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s1">'iab'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
<span class="s1">'org'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
<span class="s1">'address'</span><span class="p">:</span> <span class="p">[],</span>
<span class="s1">'offset'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="s1">'size'</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
<span class="p">}</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">iab</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
<span class="c1">#TODO: Improve string parsing here.</span>
<span class="c1">#TODO: '00-50-C2' is actually invalid.</span>
<span class="c1">#TODO: Should be '00-50-C2-00-00-00' (i.e. a full MAC/EUI-48)</span>
<span class="n">int_val</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">iab</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'-'</span><span class="p">,</span> <span class="s1">''</span><span class="p">),</span> <span class="mi">16</span><span class="p">)</span>
<span class="n">iab_int</span><span class="p">,</span> <span class="n">user_int</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">split_iab_mac</span><span class="p">(</span><span class="n">int_val</span><span class="p">,</span> <span class="n">strict</span><span class="o">=</span><span class="n">strict</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="n">iab_int</span>
<span class="k">elif</span> <span class="n">_is_int</span><span class="p">(</span><span class="n">iab</span><span class="p">):</span>
<span class="n">iab_int</span><span class="p">,</span> <span class="n">user_int</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">split_iab_mac</span><span class="p">(</span><span class="n">iab</span><span class="p">,</span> <span class="n">strict</span><span class="o">=</span><span class="n">strict</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="n">iab_int</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'unexpected IAB format: </span><span class="si">%r</span><span class="s1">!'</span> <span class="o">%</span> <span class="n">iab</span><span class="p">)</span>
<span class="c1"># Discover offsets.</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="ow">in</span> <span class="n">ieee</span><span class="o">.</span><span class="n">IAB_INDEX</span><span class="p">:</span>
<span class="n">fh</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">ieee</span><span class="o">.</span><span class="n">IAB_REGISTRY</span><span class="p">)</span>
<span class="p">(</span><span class="n">offset</span><span class="p">,</span> <span class="n">size</span><span class="p">)</span> <span class="o">=</span> <span class="n">ieee</span><span class="o">.</span><span class="n">IAB_INDEX</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">][</span><span class="mi">0</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">record</span><span class="p">[</span><span class="s1">'offset'</span><span class="p">]</span> <span class="o">=</span> <span class="n">offset</span>
<span class="bp">self</span><span class="o">.</span><span class="n">record</span><span class="p">[</span><span class="s1">'size'</span><span class="p">]</span> <span class="o">=</span> <span class="n">size</span>
<span class="n">fh</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="n">offset</span><span class="p">)</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">fh</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">size</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_parse_data</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">offset</span><span class="p">,</span> <span class="n">size</span><span class="p">)</span>
<span class="n">fh</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">NotRegisteredError</span><span class="p">(</span><span class="s1">'IAB </span><span class="si">%r</span><span class="s1"> not unregistered!'</span> <span class="o">%</span> <span class="n">iab</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">IAB</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">other</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">NotImplemented</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_value</span>
<span class="k">def</span> <span class="nf">__ne__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">IAB</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">other</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">NotImplemented</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">!=</span> <span class="n">other</span><span class="o">.</span><span class="n">_value</span>
<div class="viewcode-block" id="IAB.__getstate__"><a class="viewcode-back" href="../../api.html#netaddr.IAB.__getstate__">[docs]</a> <span class="k">def</span> <span class="nf">__getstate__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""":returns: Pickled state of an `IAB` object."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">record</span></div>
<div class="viewcode-block" id="IAB.__setstate__"><a class="viewcode-back" href="../../api.html#netaddr.IAB.__setstate__">[docs]</a> <span class="k">def</span> <span class="nf">__setstate__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="p">):</span>
<span class="sd">""":param state: data used to unpickle a pickled `IAB` object."""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">record</span> <span class="o">=</span> <span class="n">state</span></div>
<span class="k">def</span> <span class="nf">_parse_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">offset</span><span class="p">,</span> <span class="n">size</span><span class="p">):</span>
<span class="sd">"""Returns a dict record from raw IAB record data"""</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">data</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">):</span>
<span class="n">line</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">line</span><span class="p">:</span>
<span class="k">continue</span>
<span class="k">if</span> <span class="s1">'(hex)'</span> <span class="ow">in</span> <span class="n">line</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">record</span><span class="p">[</span><span class="s1">'idx'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span>
<span class="bp">self</span><span class="o">.</span><span class="n">record</span><span class="p">[</span><span class="s1">'org'</span><span class="p">]</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="mi">2</span><span class="p">)[</span><span class="mi">2</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">record</span><span class="p">[</span><span class="s1">'iab'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="k">elif</span> <span class="s1">'(base 16)'</span> <span class="ow">in</span> <span class="n">line</span><span class="p">:</span>
<span class="k">continue</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">record</span><span class="p">[</span><span class="s1">'address'</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<div class="viewcode-block" id="IAB.registration"><a class="viewcode-back" href="../../api.html#netaddr.IAB.registration">[docs]</a> <span class="k">def</span> <span class="nf">registration</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""The IEEE registration details for this IAB"""</span>
<span class="k">return</span> <span class="n">DictDotLookup</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">record</span><span class="p">)</span></div>
<div class="viewcode-block" id="IAB.__str__"><a class="viewcode-back" href="../../api.html#netaddr.IAB.__str__">[docs]</a> <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""":return: string representation of this IAB"""</span>
<span class="n">int_val</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o"><<</span> <span class="mi">4</span>
<span class="k">return</span> <span class="s2">"</span><span class="si">%02X</span><span class="s2">-</span><span class="si">%02X</span><span class="s2">-</span><span class="si">%02X</span><span class="s2">-</span><span class="si">%02X</span><span class="s2">-</span><span class="si">%02X</span><span class="s2">-00"</span> <span class="o">%</span> <span class="p">(</span>
<span class="p">(</span><span class="n">int_val</span> <span class="o">>></span> <span class="mi">32</span><span class="p">)</span> <span class="o">&</span> <span class="mh">0xff</span><span class="p">,</span>
<span class="p">(</span><span class="n">int_val</span> <span class="o">>></span> <span class="mi">24</span><span class="p">)</span> <span class="o">&</span> <span class="mh">0xff</span><span class="p">,</span>
<span class="p">(</span><span class="n">int_val</span> <span class="o">>></span> <span class="mi">16</span><span class="p">)</span> <span class="o">&</span> <span class="mh">0xff</span><span class="p">,</span>
<span class="p">(</span><span class="n">int_val</span> <span class="o">>></span> <span class="mi">8</span><span class="p">)</span> <span class="o">&</span> <span class="mh">0xff</span><span class="p">,</span>
<span class="n">int_val</span> <span class="o">&</span> <span class="mh">0xff</span><span class="p">)</span></div>
<div class="viewcode-block" id="IAB.__repr__"><a class="viewcode-back" href="../../api.html#netaddr.IAB.__repr__">[docs]</a> <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""":return: executable Python string to recreate equivalent object."""</span>
<span class="k">return</span> <span class="s2">"IAB('</span><span class="si">%s</span><span class="s2">')"</span> <span class="o">%</span> <span class="bp">self</span></div></div>
<div class="viewcode-block" id="EUI"><a class="viewcode-back" href="../../api.html#netaddr.EUI">[docs]</a><span class="k">class</span> <span class="nc">EUI</span><span class="p">(</span><span class="n">BaseIdentifier</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> An IEEE EUI (Extended Unique Identifier).</span>
<span class="sd"> Both EUI-48 (used for layer 2 MAC addresses) and EUI-64 are supported.</span>
<span class="sd"> Input parsing for EUI-48 addresses is flexible, supporting many MAC</span>
<span class="sd"> variants.</span>
<span class="sd"> """</span>
<span class="n">__slots__</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'_module'</span><span class="p">,</span> <span class="s1">'_dialect'</span><span class="p">)</span>
<div class="viewcode-block" id="EUI.__init__"><a class="viewcode-back" href="../../api.html#netaddr.EUI.__init__">[docs]</a> <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">addr</span><span class="p">,</span> <span class="n">version</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">dialect</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Constructor.</span>
<span class="sd"> :param addr: an EUI-48 (MAC) or EUI-64 address in string format or \</span>
<span class="sd"> an unsigned integer. May also be another EUI object (copy \</span>
<span class="sd"> construction).</span>
<span class="sd"> :param version: (optional) the explicit EUI address version, either \</span>
<span class="sd"> 48 or 64. Mainly used to distinguish EUI-48 and EUI-64 identifiers \</span>
<span class="sd"> specified as integers which may be numerically equivalent.</span>
<span class="sd"> :param dialect: (optional) the mac_* dialect to be used to configure \</span>
<span class="sd"> the formatting of EUI-48 (MAC) addresses.</span>
<span class="sd"> """</span>
<span class="nb">super</span><span class="p">(</span><span class="n">EUI</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_module</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">addr</span><span class="p">,</span> <span class="n">EUI</span><span class="p">):</span>
<span class="c1"># Copy constructor.</span>
<span class="k">if</span> <span class="n">version</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">version</span> <span class="o">!=</span> <span class="n">addr</span><span class="o">.</span><span class="n">_module</span><span class="o">.</span><span class="n">version</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'cannot switch EUI versions using '</span>
<span class="s1">'copy constructor!'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_module</span> <span class="o">=</span> <span class="n">addr</span><span class="o">.</span><span class="n">_module</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="n">addr</span><span class="o">.</span><span class="n">_value</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dialect</span> <span class="o">=</span> <span class="n">addr</span><span class="o">.</span><span class="n">dialect</span>
<span class="k">return</span>
<span class="k">if</span> <span class="n">version</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="n">version</span> <span class="o">==</span> <span class="mi">48</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_module</span> <span class="o">=</span> <span class="n">_eui48</span>
<span class="k">elif</span> <span class="n">version</span> <span class="o">==</span> <span class="mi">64</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_module</span> <span class="o">=</span> <span class="n">_eui64</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'unsupported EUI version </span><span class="si">%r</span><span class="s1">'</span> <span class="o">%</span> <span class="n">version</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Choose a default version when addr is an integer and version is</span>
<span class="c1"># not specified.</span>
<span class="k">if</span> <span class="n">_is_int</span><span class="p">(</span><span class="n">addr</span><span class="p">):</span>
<span class="k">if</span> <span class="mi">0</span> <span class="o"><=</span> <span class="n">addr</span> <span class="o"><=</span> <span class="mh">0xffffffffffff</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_module</span> <span class="o">=</span> <span class="n">_eui48</span>
<span class="k">elif</span> <span class="mh">0xffffffffffff</span> <span class="o"><</span> <span class="n">addr</span> <span class="o"><=</span> <span class="mh">0xffffffffffffffff</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_module</span> <span class="o">=</span> <span class="n">_eui64</span>
<span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="n">addr</span>
<span class="c1"># Choose a dialect for MAC formatting.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dialect</span> <span class="o">=</span> <span class="n">dialect</span></div>
<div class="viewcode-block" id="EUI.__getstate__"><a class="viewcode-back" href="../../api.html#netaddr.EUI.__getstate__">[docs]</a> <span class="k">def</span> <span class="nf">__getstate__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""":returns: Pickled state of an `EUI` object."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span><span class="o">.</span><span class="n">version</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dialect</span></div>
<div class="viewcode-block" id="EUI.__setstate__"><a class="viewcode-back" href="../../api.html#netaddr.EUI.__setstate__">[docs]</a> <span class="k">def</span> <span class="nf">__setstate__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :param state: data used to unpickle a pickled `EUI` object.</span>
<span class="sd"> """</span>
<span class="n">value</span><span class="p">,</span> <span class="n">version</span><span class="p">,</span> <span class="n">dialect</span> <span class="o">=</span> <span class="n">state</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">if</span> <span class="n">version</span> <span class="o">==</span> <span class="mi">48</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_module</span> <span class="o">=</span> <span class="n">_eui48</span>
<span class="k">elif</span> <span class="n">version</span> <span class="o">==</span> <span class="mi">64</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_module</span> <span class="o">=</span> <span class="n">_eui64</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">'unpickling failed for object state: </span><span class="si">%s</span><span class="s1">'</span> \
<span class="o">%</span> <span class="nb">str</span><span class="p">(</span><span class="n">state</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">dialect</span> <span class="o">=</span> <span class="n">dialect</span></div>
<span class="k">def</span> <span class="nf">_get_value</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span>
<span class="k">def</span> <span class="nf">_set_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># EUI version is implicit, detect it from value.</span>
<span class="k">for</span> <span class="n">module</span> <span class="ow">in</span> <span class="p">(</span><span class="n">_eui48</span><span class="p">,</span> <span class="n">_eui64</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="n">module</span><span class="o">.</span><span class="n">str_to_int</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_module</span> <span class="o">=</span> <span class="n">module</span>
<span class="k">break</span>
<span class="k">except</span> <span class="n">AddrFormatError</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">if</span> <span class="mi">0</span> <span class="o"><=</span> <span class="nb">int</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="o"><=</span> <span class="n">module</span><span class="o">.</span><span class="n">max_int</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_module</span> <span class="o">=</span> <span class="n">module</span>
<span class="k">break</span>
<span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AddrFormatError</span><span class="p">(</span><span class="s1">'failed to detect EUI version: </span><span class="si">%r</span><span class="s1">'</span>
<span class="o">%</span> <span class="n">value</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># EUI version is explicit.</span>
<span class="k">if</span> <span class="n">_is_str</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span><span class="o">.</span><span class="n">str_to_int</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">except</span> <span class="n">AddrFormatError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AddrFormatError</span><span class="p">(</span><span class="s1">'address </span><span class="si">%r</span><span class="s1"> is not an EUIv</span><span class="si">%d</span><span class="s1">'</span>
<span class="o">%</span> <span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span><span class="o">.</span><span class="n">version</span><span class="p">))</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="mi">0</span> <span class="o"><=</span> <span class="nb">int</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="o"><=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span><span class="o">.</span><span class="n">max_int</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AddrFormatError</span><span class="p">(</span><span class="s1">'bad address format: </span><span class="si">%r</span><span class="s1">'</span> <span class="o">%</span> <span class="n">value</span><span class="p">)</span>
<span class="n">value</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">_get_value</span><span class="p">,</span> <span class="n">_set_value</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span>
<span class="s1">'a positive integer representing the value of this EUI indentifier.'</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_get_dialect</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dialect</span>
<span class="k">def</span> <span class="nf">_set_dialect</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="k">if</span> <span class="n">value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span> <span class="ow">is</span> <span class="n">_eui64</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_dialect</span> <span class="o">=</span> <span class="n">eui64_base</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_dialect</span> <span class="o">=</span> <span class="n">mac_eui48</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s1">'word_size'</span><span class="p">)</span> <span class="ow">and</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="s1">'word_fmt'</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_dialect</span> <span class="o">=</span> <span class="n">value</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'custom dialects should subclass mac_eui48!'</span><span class="p">)</span>
<span class="n">dialect</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">_get_dialect</span><span class="p">,</span> <span class="n">_set_dialect</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span>
<span class="s2">"a Python class providing support for the interpretation of "</span>
<span class="s2">"various MAC</span><span class="se">\n</span><span class="s2"> address formats."</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">oui</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""The OUI (Organisationally Unique Identifier) for this EUI."""</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span> <span class="o">==</span> <span class="n">_eui48</span><span class="p">:</span>
<span class="k">return</span> <span class="n">OUI</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">>></span> <span class="mi">24</span><span class="p">)</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span> <span class="o">==</span> <span class="n">_eui64</span><span class="p">:</span>
<span class="k">return</span> <span class="n">OUI</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">>></span> <span class="mi">40</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">ei</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""The EI (Extension Identifier) for this EUI"""</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span> <span class="o">==</span> <span class="n">_eui48</span><span class="p">:</span>
<span class="k">return</span> <span class="s1">'</span><span class="si">%02X</span><span class="s1">-</span><span class="si">%02X</span><span class="s1">-</span><span class="si">%02X</span><span class="s1">'</span> <span class="o">%</span> <span class="nb">tuple</span><span class="p">(</span><span class="bp">self</span><span class="p">[</span><span class="mi">3</span><span class="p">:</span><span class="mi">6</span><span class="p">])</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span> <span class="o">==</span> <span class="n">_eui64</span><span class="p">:</span>
<span class="k">return</span> <span class="s1">'</span><span class="si">%02X</span><span class="s1">-</span><span class="si">%02X</span><span class="s1">-</span><span class="si">%02X</span><span class="s1">-</span><span class="si">%02X</span><span class="s1">-</span><span class="si">%02X</span><span class="s1">'</span> <span class="o">%</span> <span class="nb">tuple</span><span class="p">(</span><span class="bp">self</span><span class="p">[</span><span class="mi">3</span><span class="p">:</span><span class="mi">8</span><span class="p">])</span>
<div class="viewcode-block" id="EUI.is_iab"><a class="viewcode-back" href="../../api.html#netaddr.EUI.is_iab">[docs]</a> <span class="k">def</span> <span class="nf">is_iab</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""":return: True if this EUI is an IAB address, False otherwise"""</span>
<span class="k">return</span> <span class="mh">0x50c2000</span> <span class="o"><=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">>></span> <span class="mi">12</span><span class="p">)</span> <span class="o"><=</span> <span class="mh">0x50c2fff</span></div>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">iab</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> If is_iab() is True, the IAB (Individual Address Block) is returned,</span>
<span class="sd"> ``None`` otherwise.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_iab</span><span class="p">():</span>
<span class="k">return</span> <span class="n">IAB</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">>></span> <span class="mi">12</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">version</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""The EUI version represented by this EUI object."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span><span class="o">.</span><span class="n">version</span>
<div class="viewcode-block" id="EUI.__getitem__"><a class="viewcode-back" href="../../api.html#netaddr.EUI.__getitem__">[docs]</a> <span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">idx</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :return: The integer value of the word referenced by index (both \</span>
<span class="sd"> positive and negative). Raises ``IndexError`` if index is out \</span>
<span class="sd"> of bounds. Also supports Python list slices for accessing \</span>
<span class="sd"> word groups.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">_is_int</span><span class="p">(</span><span class="n">idx</span><span class="p">):</span>
<span class="c1"># Indexing, including negative indexing goodness.</span>
<span class="n">num_words</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dialect</span><span class="o">.</span><span class="n">num_words</span>
<span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="o">-</span><span class="n">num_words</span><span class="p">)</span> <span class="o"><=</span> <span class="n">idx</span> <span class="o"><=</span> <span class="p">(</span><span class="n">num_words</span> <span class="o">-</span> <span class="mi">1</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">IndexError</span><span class="p">(</span><span class="s1">'index out range for address type!'</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span><span class="o">.</span><span class="n">int_to_words</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dialect</span><span class="p">)[</span><span class="n">idx</span><span class="p">]</span>
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">idx</span><span class="p">,</span> <span class="nb">slice</span><span class="p">):</span>
<span class="n">words</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span><span class="o">.</span><span class="n">int_to_words</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dialect</span><span class="p">)</span>
<span class="k">return</span> <span class="p">[</span><span class="n">words</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="o">*</span><span class="n">idx</span><span class="o">.</span><span class="n">indices</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">words</span><span class="p">)))]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'unsupported type </span><span class="si">%r</span><span class="s1">!'</span> <span class="o">%</span> <span class="n">idx</span><span class="p">)</span></div>
<div class="viewcode-block" id="EUI.__setitem__"><a class="viewcode-back" href="../../api.html#netaddr.EUI.__setitem__">[docs]</a> <span class="k">def</span> <span class="nf">__setitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">idx</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""Set the value of the word referenced by index in this address"""</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">idx</span><span class="p">,</span> <span class="nb">slice</span><span class="p">):</span>
<span class="c1"># TODO - settable slices.</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s1">'settable slices are not supported!'</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_is_int</span><span class="p">(</span><span class="n">idx</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'index not an integer!'</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="mi">0</span> <span class="o"><=</span> <span class="n">idx</span> <span class="o"><=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_dialect</span><span class="o">.</span><span class="n">num_words</span> <span class="o">-</span> <span class="mi">1</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">IndexError</span><span class="p">(</span><span class="s1">'index </span><span class="si">%d</span><span class="s1"> outside address type boundary!'</span> <span class="o">%</span> <span class="n">idx</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_is_int</span><span class="p">(</span><span class="n">value</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'value not an integer!'</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="mi">0</span> <span class="o"><=</span> <span class="n">value</span> <span class="o"><=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dialect</span><span class="o">.</span><span class="n">max_word</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">IndexError</span><span class="p">(</span><span class="s1">'value </span><span class="si">%d</span><span class="s1"> outside word size maximum of </span><span class="si">%d</span><span class="s1"> bits!'</span>
<span class="o">%</span> <span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dialect</span><span class="o">.</span><span class="n">word_size</span><span class="p">))</span>
<span class="n">words</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_module</span><span class="o">.</span><span class="n">int_to_words</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dialect</span><span class="p">))</span>
<span class="n">words</span><span class="p">[</span><span class="n">idx</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span><span class="o">.</span><span class="n">words_to_int</span><span class="p">(</span><span class="n">words</span><span class="p">)</span></div>
<div class="viewcode-block" id="EUI.__hash__"><a class="viewcode-back" href="../../api.html#netaddr.EUI.__hash__">[docs]</a> <span class="k">def</span> <span class="nf">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""":return: hash of this EUI object suitable for dict keys, sets etc"""</span>
<span class="k">return</span> <span class="nb">hash</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">version</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">))</span></div>
<div class="viewcode-block" id="EUI.__eq__"><a class="viewcode-back" href="../../api.html#netaddr.EUI.__eq__">[docs]</a> <span class="k">def</span> <span class="nf">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :return: ``True`` if this EUI object is numerically the same as other, \</span>
<span class="sd"> ``False`` otherwise.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">EUI</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">other</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">NotImplemented</span>
<span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">version</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">)</span> <span class="o">==</span> <span class="p">(</span><span class="n">other</span><span class="o">.</span><span class="n">version</span><span class="p">,</span> <span class="n">other</span><span class="o">.</span><span class="n">_value</span><span class="p">)</span></div>
<div class="viewcode-block" id="EUI.__ne__"><a class="viewcode-back" href="../../api.html#netaddr.EUI.__ne__">[docs]</a> <span class="k">def</span> <span class="nf">__ne__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :return: ``True`` if this EUI object is numerically the same as other, \</span>
<span class="sd"> ``False`` otherwise.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">EUI</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">other</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">NotImplemented</span>
<span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">version</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">)</span> <span class="o">!=</span> <span class="p">(</span><span class="n">other</span><span class="o">.</span><span class="n">version</span><span class="p">,</span> <span class="n">other</span><span class="o">.</span><span class="n">_value</span><span class="p">)</span></div>
<div class="viewcode-block" id="EUI.__lt__"><a class="viewcode-back" href="../../api.html#netaddr.EUI.__lt__">[docs]</a> <span class="k">def</span> <span class="nf">__lt__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :return: ``True`` if this EUI object is numerically lower in value than \</span>
<span class="sd"> other, ``False`` otherwise.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">EUI</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">other</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">NotImplemented</span>
<span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">version</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">)</span> <span class="o"><</span> <span class="p">(</span><span class="n">other</span><span class="o">.</span><span class="n">version</span><span class="p">,</span> <span class="n">other</span><span class="o">.</span><span class="n">_value</span><span class="p">)</span></div>
<div class="viewcode-block" id="EUI.__le__"><a class="viewcode-back" href="../../api.html#netaddr.EUI.__le__">[docs]</a> <span class="k">def</span> <span class="nf">__le__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :return: ``True`` if this EUI object is numerically lower or equal in \</span>
<span class="sd"> value to other, ``False`` otherwise.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">EUI</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">other</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">NotImplemented</span>
<span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">version</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">)</span> <span class="o"><=</span> <span class="p">(</span><span class="n">other</span><span class="o">.</span><span class="n">version</span><span class="p">,</span> <span class="n">other</span><span class="o">.</span><span class="n">_value</span><span class="p">)</span></div>
<div class="viewcode-block" id="EUI.__gt__"><a class="viewcode-back" href="../../api.html#netaddr.EUI.__gt__">[docs]</a> <span class="k">def</span> <span class="nf">__gt__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :return: ``True`` if this EUI object is numerically greater in value \</span>
<span class="sd"> than other, ``False`` otherwise.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">EUI</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">other</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">NotImplemented</span>
<span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">version</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">)</span> <span class="o">></span> <span class="p">(</span><span class="n">other</span><span class="o">.</span><span class="n">version</span><span class="p">,</span> <span class="n">other</span><span class="o">.</span><span class="n">_value</span><span class="p">)</span></div>
<div class="viewcode-block" id="EUI.__ge__"><a class="viewcode-back" href="../../api.html#netaddr.EUI.__ge__">[docs]</a> <span class="k">def</span> <span class="nf">__ge__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :return: ``True`` if this EUI object is numerically greater or equal \</span>
<span class="sd"> in value to other, ``False`` otherwise.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">EUI</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">other</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="p">(</span><span class="n">other</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">NotImplemented</span>
<span class="k">return</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">version</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">)</span> <span class="o">>=</span> <span class="p">(</span><span class="n">other</span><span class="o">.</span><span class="n">version</span><span class="p">,</span> <span class="n">other</span><span class="o">.</span><span class="n">_value</span><span class="p">)</span></div>
<div class="viewcode-block" id="EUI.bits"><a class="viewcode-back" href="../../api.html#netaddr.EUI.bits">[docs]</a> <span class="k">def</span> <span class="nf">bits</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">word_sep</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :param word_sep: (optional) the separator to insert between words. \</span>
<span class="sd"> Default: None - use default separator for address type.</span>
<span class="sd"> :return: human-readable binary digit string of this address.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span><span class="o">.</span><span class="n">int_to_bits</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">,</span> <span class="n">word_sep</span><span class="p">)</span></div>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">packed</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""The value of this EUI address as a packed binary string."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span><span class="o">.</span><span class="n">int_to_packed</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">words</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""A list of unsigned integer octets found in this EUI address."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span><span class="o">.</span><span class="n">int_to_words</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">bin</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> The value of this EUI adddress in standard Python binary</span>
<span class="sd"> representational form (0bxxx). A back port of the format provided by</span>
<span class="sd"> the builtin bin() function found in Python 2.6.x and higher.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span><span class="o">.</span><span class="n">int_to_bin</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">)</span>
<div class="viewcode-block" id="EUI.eui64"><a class="viewcode-back" href="../../api.html#netaddr.EUI.eui64">[docs]</a> <span class="k">def</span> <span class="nf">eui64</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> - If this object represents an EUI-48 it is converted to EUI-64 \</span>
<span class="sd"> as per the standard.</span>
<span class="sd"> - If this object is already an EUI-64, a new, numerically \</span>
<span class="sd"> equivalent object is returned instead.</span>
<span class="sd"> :return: The value of this EUI object as a new 64-bit EUI object.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">version</span> <span class="o">==</span> <span class="mi">48</span><span class="p">:</span>
<span class="c1"># Convert 11:22:33:44:55:66 into 11:22:33:FF:FE:44:55:66.</span>
<span class="n">first_three</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">>></span> <span class="mi">24</span>
<span class="n">last_three</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span> <span class="o">&</span> <span class="mh">0xffffff</span>
<span class="n">new_value</span> <span class="o">=</span> <span class="p">(</span><span class="n">first_three</span> <span class="o"><<</span> <span class="mi">40</span><span class="p">)</span> <span class="o">|</span> <span class="mh">0xfffe000000</span> <span class="o">|</span> <span class="n">last_three</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># is already a EUI64</span>
<span class="n">new_value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_value</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="p">(</span><span class="n">new_value</span><span class="p">,</span> <span class="n">version</span><span class="o">=</span><span class="mi">64</span><span class="p">)</span></div>
<div class="viewcode-block" id="EUI.modified_eui64"><a class="viewcode-back" href="../../api.html#netaddr.EUI.modified_eui64">[docs]</a> <span class="k">def</span> <span class="nf">modified_eui64</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> - create a new EUI object with a modified EUI-64 as described in RFC 4291 section 2.5.1</span>
<span class="sd"> :return: a new and modified 64-bit EUI object.</span>
<span class="sd"> """</span>
<span class="c1"># Modified EUI-64 format interface identifiers are formed by inverting</span>
<span class="c1"># the "u" bit (universal/local bit in IEEE EUI-64 terminology) when</span>
<span class="c1"># forming the interface identifier from IEEE EUI-64 identifiers. In</span>
<span class="c1"># the resulting Modified EUI-64 format, the "u" bit is set to one (1)</span>
<span class="c1"># to indicate universal scope, and it is set to zero (0) to indicate</span>
<span class="c1"># local scope.</span>
<span class="n">eui64</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">eui64</span><span class="p">()</span>
<span class="n">eui64</span><span class="o">.</span><span class="n">_value</span> <span class="o">^=</span> <span class="mh">0x00000000000000000200000000000000</span>
<span class="k">return</span> <span class="n">eui64</span></div>
<div class="viewcode-block" id="EUI.ipv6"><a class="viewcode-back" href="../../api.html#netaddr.EUI.ipv6">[docs]</a> <span class="k">def</span> <span class="nf">ipv6</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">prefix</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> .. note:: This poses security risks in certain scenarios. \</span>
<span class="sd"> Please read RFC 4941 for details. Reference: RFCs 4291 and 4941.</span>
<span class="sd"> :param prefix: ipv6 prefix</span>
<span class="sd"> :return: new IPv6 `IPAddress` object based on this `EUI` \</span>
<span class="sd"> using the technique described in RFC 4291.</span>
<span class="sd"> """</span>
<span class="n">int_val</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">prefix</span><span class="p">)</span> <span class="o">+</span> <span class="nb">int</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">modified_eui64</span><span class="p">())</span>
<span class="k">return</span> <span class="n">IPAddress</span><span class="p">(</span><span class="n">int_val</span><span class="p">,</span> <span class="n">version</span><span class="o">=</span><span class="mi">6</span><span class="p">)</span></div>
<div class="viewcode-block" id="EUI.ipv6_link_local"><a class="viewcode-back" href="../../api.html#netaddr.EUI.ipv6_link_local">[docs]</a> <span class="k">def</span> <span class="nf">ipv6_link_local</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> .. note:: This poses security risks in certain scenarios. \</span>
<span class="sd"> Please read RFC 4941 for details. Reference: RFCs 4291 and 4941.</span>
<span class="sd"> :return: new link local IPv6 `IPAddress` object based on this `EUI` \</span>
<span class="sd"> using the technique described in RFC 4291.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">ipv6</span><span class="p">(</span><span class="mh">0xfe800000000000000000000000000000</span><span class="p">)</span></div>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">info</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A record dict containing IEEE registration details for this EUI</span>
<span class="sd"> (MAC-48) if available, None otherwise.</span>
<span class="sd"> """</span>
<span class="n">data</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'OUI'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">oui</span><span class="o">.</span><span class="n">registration</span><span class="p">()}</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_iab</span><span class="p">():</span>
<span class="n">data</span><span class="p">[</span><span class="s1">'IAB'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">iab</span><span class="o">.</span><span class="n">registration</span><span class="p">()</span>
<span class="k">return</span> <span class="n">DictDotLookup</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<div class="viewcode-block" id="EUI.__str__"><a class="viewcode-back" href="../../api.html#netaddr.EUI.__str__">[docs]</a> <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""":return: EUI in representational format"""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_module</span><span class="o">.</span><span class="n">int_to_str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dialect</span><span class="p">)</span></div>
<div class="viewcode-block" id="EUI.__repr__"><a class="viewcode-back" href="../../api.html#netaddr.EUI.__repr__">[docs]</a> <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">""":return: executable Python string to recreate equivalent object."""</span>
<span class="k">return</span> <span class="s2">"EUI('</span><span class="si">%s</span><span class="s2">')"</span> <span class="o">%</span> <span class="bp">self</span></div></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</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="nav-item nav-item-0"><a href="../../index.html">netaddr 0.7.18 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© <a href="../../copyright.html">Copyright</a> 2008-2016, David P. D. Moss. All rights reserved.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.4.6.
</div>
</body>
</html>
|