/usr/share/doc/python-padme-doc/html/_modules/padme.html is in python-padme-doc 1.1.1-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 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 | <!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>padme — padme 1.1.1 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: '1.1.1',
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="top" title="padme 1.1.1 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="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">padme 1.1.1 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 padme</h1><div class="highlight"><pre>
<span class="c"># Copyright 2015 Canonical Ltd.</span>
<span class="c"># Written by:</span>
<span class="c"># Zygmunt Krynicki <zygmunt.krynicki@canonical.com></span>
<span class="c">#</span>
<span class="c"># This file is part of Padme.</span>
<span class="c">#</span>
<span class="c"># Padme is free software: you can redistribute it and/or modify</span>
<span class="c"># it under the terms of the GNU Lesser General Public License version 3,</span>
<span class="c"># as published by the Free Software Foundation.</span>
<span class="c">#</span>
<span class="c"># Padme is distributed in the hope that it will be useful,</span>
<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<span class="c"># GNU Lesser General Public License for more details.</span>
<span class="c">#</span>
<span class="c"># You should have received a copy of the GNU Lesser General Public License</span>
<span class="c"># along with Padme. If not, see <http://www.gnu.org/licenses/>.</span>
<span class="sd">"""</span>
<span class="sd">:mod:`padme` -- a mostly transparent proxy class for Python.</span>
<span class="sd">============================================================</span>
<span class="sd">Padme, named after the Star Wars (tm) character, is a library for creating</span>
<span class="sd">proxy objects out of any other python object.</span>
<span class="sd">The resulting object is as close to mimicking the original as possible. Some</span>
<span class="sd">things are impossible to fake in CPython so those are highlighted below. All</span>
<span class="sd">other operations are silently forwarded to the original.</span>
<span class="sd">Terminology</span>
<span class="sd">-----------</span>
<span class="sd">.. glossary:</span>
<span class="sd">proxy:</span>
<span class="sd"> An intermediate object that is used in place of some original object.</span>
<span class="sd">proxiee:</span>
<span class="sd"> The original object hidden behind one or more proxies.</span>
<span class="sd">Basic features</span>
<span class="sd">--------------</span>
<span class="sd">Let's consider a simple example:</span>
<span class="sd"> >>> pets = [str('cat'), str('dog'), str('fish')]</span>
<span class="sd"> >>> pets_proxy = proxy(pets)</span>
<span class="sd"> >>> pets_proxy</span>
<span class="sd"> ['cat', 'dog', 'fish']</span>
<span class="sd"> >>> isinstance(pets_proxy, list)</span>
<span class="sd"> True</span>
<span class="sd"> >>> pets_proxy.append(str('rooster'))</span>
<span class="sd"> >>> pets</span>
<span class="sd"> ['cat', 'dog', 'fish', 'rooster']</span>
<span class="sd">By default, a proxy object is not that interesting. What is more interesting is</span>
<span class="sd">the ability to create subclasses that change a subset of the behavior. For</span>
<span class="sd">implementation simplicity such methods need to be decorated with</span>
<span class="sd">``@proxy.direct``.</span>
<span class="sd">Let's consider a crazy proxy that overrides the ``__repr__()`` method to censor</span>
<span class="sd">the word 'cat'. This is how it can be implemented:</span>
<span class="sd"> >>> class censor_cat(proxy):</span>
<span class="sd"> ... @proxy.direct</span>
<span class="sd"> ... def __repr__(self):</span>
<span class="sd"> ... return repr(proxy.original(self)).replace(</span>
<span class="sd"> ... str('cat'), str('***'))</span>
<span class="sd">Now let's create a proxy for our pets collection and see how it looks like:</span>
<span class="sd"> >>> pets_proxy = censor_cat(pets)</span>
<span class="sd"> >>> pets_proxy</span>
<span class="sd"> ['***', 'dog', 'fish', 'rooster']</span>
<span class="sd">As before, all other aspects of the proxy behave the same way. All of the</span>
<span class="sd">methods work and are forwarded to the original object. The type of the proxy</span>
<span class="sd">object is correct, event the meta-class of the object is correct (this matters</span>
<span class="sd">for ``issubclass()``, for instance).</span>
<span class="sd">Accessing the original object</span>
<span class="sd">-----------------------------</span>
<span class="sd">At any time one can access the original object hidden behind any proxy by using</span>
<span class="sd">the :meth:`proxy.original()` function. For example:</span>
<span class="sd"> >>> obj = 'hello world'</span>
<span class="sd"> >>> proxy.original(proxy(obj)) is obj</span>
<span class="sd"> True</span>
<span class="sd">Accessing proxy state</span>
<span class="sd">---------------------</span>
<span class="sd">At any time the state of any proxy object can be accessed using the</span>
<span class="sd">:meth:`proxy.state()` function. The state object behaves as a regular object</span>
<span class="sd">with attributes. It can be used to add custom state to an object that cannot</span>
<span class="sd">hold it, for example:</span>
<span class="sd"> >>> obj = 42</span>
<span class="sd"> >>> obj.foo = 42</span>
<span class="sd"> Traceback (most recent call last):</span>
<span class="sd"> ...</span>
<span class="sd"> AttributeError: 'int' object has no attribute 'foo'</span>
<span class="sd"> >>> obj = proxy(obj)</span>
<span class="sd"> >>> obj.foo = 42</span>
<span class="sd"> Traceback (most recent call last):</span>
<span class="sd"> ...</span>
<span class="sd"> AttributeError: 'int' object has no attribute 'foo'</span>
<span class="sd"> >>> proxy.state(obj).foo = 42</span>
<span class="sd"> >>> proxy.state(obj).foo</span>
<span class="sd"> 42</span>
<span class="sd">Using the @proxy.direct decorator</span>
<span class="sd">---------------------------------</span>
<span class="sd">The ``@proxy.direct`` decorator can be used to disable the automatic</span>
<span class="sd">pass-through behavior that is exhibited by any proxy object. In practice we can</span>
<span class="sd">use it to either intercept and substitute an existing functionality or to add a</span>
<span class="sd">new functionality that doesn't exist in the original object.</span>
<span class="sd">First, let's write a custom proxy class for the ``bool`` class (which cannot be</span>
<span class="sd">used as a base class anymore) and change the core functionality.</span>
<span class="sd"> >>> class nay(proxy):</span>
<span class="sd"> ...</span>
<span class="sd"> ... @proxy.direct</span>
<span class="sd"> ... def __nonzero__(self):</span>
<span class="sd"> ... return not bool(proxiee(self))</span>
<span class="sd"> ...</span>
<span class="sd"> ... @proxy.direct</span>
<span class="sd"> ... def __bool__(self):</span>
<span class="sd"> ... return not bool(proxiee(self))</span>
<span class="sd"> >>> bool(nay(True))</span>
<span class="sd"> False</span>
<span class="sd"> >>> bool(nay(False))</span>
<span class="sd"> True</span>
<span class="sd"> >>> if nay([]):</span>
<span class="sd"> ... print("It works!")</span>
<span class="sd"> It works!</span>
<span class="sd">Now, let's write a different proxy class that will add some new functionality</span>
<span class="sd">Here, the self_aware_proxy class gives any object a new property, ``is_proxy``</span>
<span class="sd">which always returns ``True``.</span>
<span class="sd"> >>> class self_aware_proxy(proxy):</span>
<span class="sd"> ... @proxy.direct</span>
<span class="sd"> ... def is_proxy(self):</span>
<span class="sd"> ... return True</span>
<span class="sd"> >>> self_aware_proxy('hello').is_proxy()</span>
<span class="sd"> True</span>
<span class="sd">Limitations</span>
<span class="sd">-----------</span>
<span class="sd">There are only two things that that give our proxy away.</span>
<span class="sd">The ``type()`` function:</span>
<span class="sd"> >>> type(pets_proxy) # doctest: +ELLIPSIS</span>
<span class="sd"> <class '...censor_cat[list]'></span>
<span class="sd">And the ``id`` function (and anything that checks object identity):</span>
<span class="sd"> >>> pets_proxy is pets</span>
<span class="sd"> False</span>
<span class="sd"> >>> id(pets) == id(pets_proxy)</span>
<span class="sd"> False</span>
<span class="sd">That's it, enjoy. You can read the unit tests for additional interesting</span>
<span class="sd">details of how the proxy class works. Those are not covered in this short</span>
<span class="sd">introduction.</span>
<span class="sd">.. note::</span>
<span class="sd"> There are a number of classes and meta-classes but the only public</span>
<span class="sd"> interface is the :class:`proxy` class and the :meth:`proxy.direct`</span>
<span class="sd"> decorator. See below for examples.</span>
<span class="sd">Deprecated 1.0 APIs</span>
<span class="sd">-------------------</span>
<span class="sd">If you've used Padme before you may have seen ``@unproxied()`` and</span>
<span class="sd">``proxiee()``. They are still here but ``@unproxied`` is now spelled</span>
<span class="sd">``@proxy.direct`` and ``proxiee()`` is now ``proxy.original()``. This was done</span>
<span class="sd">to allow all of Padme to be used from the one :class:`proxy` class.</span>
<span class="sd">"""</span>
<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">print_function</span><span class="p">,</span> <span class="n">absolute_import</span><span class="p">,</span> <span class="n">unicode_literals</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">operator</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="n">__author__</span> <span class="o">=</span> <span class="s">'Zygmunt Krynicki'</span>
<span class="n">__email__</span> <span class="o">=</span> <span class="s">'zygmunt.krynicki@canonical.com'</span>
<span class="n">__version__</span> <span class="o">=</span> <span class="s">'1.1.1'</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="s">'proxy'</span><span class="p">),</span> <span class="p">)</span>
<span class="n">_logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s">"padme"</span><span class="p">)</span>
<div class="viewcode-block" id="proxy_meta"><a class="viewcode-back" href="../usage.html#padme.proxy_meta">[docs]</a><span class="k">class</span> <span class="nc">proxy_meta</span><span class="p">(</span><span class="nb">type</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Meta-class for all proxy types.</span>
<span class="sd"> This meta-class is responsible for gathering the __unproxied__ attributes</span>
<span class="sd"> on each created class. The attribute is a frozenset of names that will not</span>
<span class="sd"> be forwarded to the ``proxiee`` but instead will be looked up on the proxy</span>
<span class="sd"> itself.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__new__</span><span class="p">(</span><span class="n">mcls</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">bases</span><span class="p">,</span> <span class="n">ns</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span>
<span class="s">"</span><span class="si">%s</span><span class="s">.__new__ with name: </span><span class="si">%r</span><span class="s">, bases: </span><span class="si">%r</span><span class="s"> (args: </span><span class="si">%r</span><span class="s">, kwargs </span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span>
<span class="n">mcls</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">bases</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">)</span>
<span class="n">unproxied_set</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="k">for</span> <span class="n">base</span> <span class="ow">in</span> <span class="n">bases</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">base</span><span class="p">,</span> <span class="s">'__unproxied__'</span><span class="p">):</span>
<span class="n">unproxied_set</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">base</span><span class="o">.</span><span class="n">__unproxied__</span><span class="p">)</span>
<span class="k">for</span> <span class="n">ns_attr</span><span class="p">,</span> <span class="n">ns_value</span> <span class="ow">in</span> <span class="n">ns</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="k">if</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">ns_value</span><span class="p">,</span> <span class="s">'unproxied'</span><span class="p">,</span> <span class="bp">False</span><span class="p">):</span>
<span class="n">unproxied_set</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">ns_attr</span><span class="p">)</span>
<span class="k">if</span> <span class="n">unproxied_set</span><span class="p">:</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span>
<span class="s">"proxy type </span><span class="si">%r</span><span class="s"> will pass-thru </span><span class="si">%r</span><span class="s">"</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">unproxied_set</span><span class="p">)</span>
<span class="n">ns</span><span class="p">[</span><span class="s">'__unproxied__'</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">(</span><span class="n">unproxied_set</span><span class="p">)</span>
<span class="c"># _logger.debug("injecting fresh _c_registry into %s", name)</span>
<span class="n">ns</span><span class="p">[</span><span class="s">'_c_registry'</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
<span class="n">cls</span> <span class="o">=</span> <span class="nb">super</span><span class="p">(</span><span class="n">proxy_meta</span><span class="p">,</span> <span class="n">mcls</span><span class="p">)</span><span class="o">.</span><span class="n">__new__</span><span class="p">(</span><span class="n">mcls</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">bases</span><span class="p">,</span> <span class="n">ns</span><span class="p">)</span>
<span class="n">cls</span><span class="o">.</span><span class="n">_untyped_base</span> <span class="o">=</span> <span class="n">cls</span>
<span class="k">return</span> <span class="n">cls</span>
<span class="k">def</span> <span class="nf">__getitem__</span><span class="p">(</span><span class="n">proxy_cls</span><span class="p">,</span> <span class="n">proxiee_cls</span><span class="p">):</span>
<span class="n">proxy_cls</span> <span class="o">=</span> <span class="n">proxy_cls</span><span class="o">.</span><span class="n">_untyped_base</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">proxiee_cls</span><span class="p">,</span> <span class="nb">type</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">"proxiee_cls must be a type"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">proxiee_cls</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">proxy_cls</span><span class="o">.</span><span class="n">_m_registry</span><span class="p">:</span>
<span class="n">typed_proxy_meta</span> <span class="o">=</span> <span class="n">make_typed_proxy_meta</span><span class="p">(</span><span class="n">proxiee_cls</span><span class="p">)</span>
<span class="n">proxy_cls</span><span class="o">.</span><span class="n">_m_registry</span><span class="p">[</span><span class="n">proxiee_cls</span><span class="p">]</span> <span class="o">=</span> <span class="n">typed_proxy_meta</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">typed_proxy_meta</span> <span class="o">=</span> <span class="n">proxy_cls</span><span class="o">.</span><span class="n">_m_registry</span><span class="p">[</span><span class="n">proxiee_cls</span><span class="p">]</span>
<span class="k">if</span> <span class="n">proxiee_cls</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">proxy_cls</span><span class="o">.</span><span class="n">_c_registry</span><span class="p">:</span>
<span class="n">typed_proxy_cls</span> <span class="o">=</span> <span class="n">metaclass</span><span class="p">(</span><span class="n">typed_proxy_meta</span><span class="p">)(</span>
<span class="n">proxy_cls</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="s">'{}[{}]'</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">proxy_cls</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">proxiee_cls</span><span class="o">.</span><span class="n">__name__</span><span class="p">))</span>
<span class="n">proxy_cls</span><span class="o">.</span><span class="n">_c_registry</span><span class="p">[</span><span class="n">proxiee_cls</span><span class="p">]</span> <span class="o">=</span> <span class="n">typed_proxy_cls</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">typed_proxy_cls</span> <span class="o">=</span> <span class="n">proxy_cls</span><span class="o">.</span><span class="n">_c_registry</span><span class="p">[</span><span class="n">proxiee_cls</span><span class="p">]</span>
<span class="n">typed_proxy_cls</span><span class="o">.</span><span class="n">_untyped_base</span> <span class="o">=</span> <span class="n">proxy_cls</span>
<span class="k">return</span> <span class="n">typed_proxy_cls</span>
</div>
<div class="viewcode-block" id="make_typed_proxy_meta"><a class="viewcode-back" href="../usage.html#padme.make_typed_proxy_meta">[docs]</a><span class="k">def</span> <span class="nf">make_typed_proxy_meta</span><span class="p">(</span><span class="n">proxiee_cls</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Make a new proxy meta-class for the specified class of proxiee objects.</span>
<span class="sd"> .. note::</span>
<span class="sd"> Had python had an easier way of doing this, it would have been spelled</span>
<span class="sd"> as ``proxy_meta[cls]`` but I didn't want to drag pretty things into</span>
<span class="sd"> something nobody would ever see.</span>
<span class="sd"> :param proxiee_cls:</span>
<span class="sd"> The type of the that will be proxied</span>
<span class="sd"> :returns:</span>
<span class="sd"> A new meta-class that lexically wraps ``proxiee`` and ``proxiee_cls``</span>
<span class="sd"> and subclasses :class:`proxy_meta`.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__instancecheck__</span><span class="p">(</span><span class="n">mcls</span><span class="p">,</span> <span class="n">instance</span><span class="p">):</span>
<span class="c"># NOTE: this is never called in practice since</span>
<span class="c"># proxy(obj).__class__ is really obj.__class__.</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__instancecheck__ </span><span class="si">%r</span><span class="s"> on </span><span class="si">%r</span><span class="s">"</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">proxiee_cls</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">instance</span><span class="p">,</span> <span class="n">proxiee_cls</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">__subclasscheck__</span><span class="p">(</span><span class="n">mcls</span><span class="p">,</span> <span class="n">subclass</span><span class="p">):</span>
<span class="c"># This is still called though since type(proxy(obj)) is</span>
<span class="c"># something else</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__subclasscheck__ </span><span class="si">%r</span><span class="s"> on </span><span class="si">%r</span><span class="s">"</span><span class="p">,</span> <span class="n">subclass</span><span class="p">,</span> <span class="n">proxiee_cls</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">proxiee_cls</span><span class="p">,</span> <span class="n">subclass</span><span class="p">)</span>
<span class="n">name</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="s">'proxy_meta[{}]'</span><span class="p">)</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">proxiee_cls</span><span class="o">.</span><span class="n">__name__</span><span class="p">)</span>
<span class="n">bases</span> <span class="o">=</span> <span class="p">(</span><span class="n">proxy_meta</span><span class="p">,)</span>
<span class="n">ns</span> <span class="o">=</span> <span class="p">{</span>
<span class="s">'__doc__'</span><span class="p">:</span> <span class="s">"""</span>
<span class="s"> Meta-class for all proxies type-bound to type {}.</span>
<span class="s"> This class implements two methods that participate in instance and</span>
<span class="s"> class checks: ``__instancecheck__`` and ``__subclasscheck__``.</span>
<span class="s"> """</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">proxiee_cls</span><span class="o">.</span><span class="n">__name__</span><span class="p">),</span>
<span class="s">'__instancecheck__'</span><span class="p">:</span> <span class="n">__instancecheck__</span><span class="p">,</span>
<span class="s">'__subclasscheck__'</span><span class="p">:</span> <span class="n">__subclasscheck__</span>
<span class="p">}</span>
<span class="k">return</span> <span class="n">proxy_meta</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">bases</span><span class="p">,</span> <span class="n">ns</span><span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">_get_proxiee</span><span class="p">(</span><span class="n">proxy_obj</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">proxy_obj</span><span class="p">,</span> <span class="s">'_original'</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_set_proxiee</span><span class="p">(</span><span class="n">proxy_obj</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">object</span><span class="o">.</span><span class="n">__setattr__</span><span class="p">(</span><span class="n">proxy_obj</span><span class="p">,</span> <span class="s">'_original'</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_get_unproxied</span><span class="p">(</span><span class="n">proxy</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="n">proxy</span><span class="p">)</span><span class="o">.</span><span class="n">__unproxied__</span>
<span class="c"># All augmented assignment methods. We need to know those to let use intercept</span>
<span class="c"># __getattribute__ access to them. Normally it is safe to directly call methods</span>
<span class="c"># on the original object but augmented assignment a (op)= b actually changes a</span>
<span class="c"># and we need to make sure that a proxy object is returned there.</span>
<span class="n">_imethods</span> <span class="o">=</span> <span class="nb">set</span><span class="p">([</span>
<span class="s">'__iadd__'</span><span class="p">,</span>
<span class="s">'__isub__'</span><span class="p">,</span>
<span class="s">'__imul__'</span><span class="p">,</span>
<span class="s">'__itruediv__'</span><span class="p">,</span>
<span class="s">'__ifloordiv__'</span><span class="p">,</span>
<span class="s">'__imod__'</span><span class="p">,</span>
<span class="s">'__ipow__'</span><span class="p">,</span>
<span class="s">'__ilshift__'</span><span class="p">,</span>
<span class="s">'__irshift__'</span><span class="p">,</span>
<span class="s">'__iand__'</span><span class="p">,</span>
<span class="s">'__ixor__'</span><span class="p">,</span>
<span class="s">'__ior__'</span><span class="p">,</span>
<span class="p">])</span>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="n">_imethods</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s">'__idiv__'</span><span class="p">)</span>
<span class="n">_imethods</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">(</span><span class="n">_imethods</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">_imethod</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="n">name</span><span class="p">,</span> <span class="n">op</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Shared implementation of __iFUNC__ method.</span>
<span class="sd"> :param self:</span>
<span class="sd"> A proxy_base instance</span>
<span class="sd"> :param other:</span>
<span class="sd"> Any right-hand-side value</span>
<span class="sd"> :param name:</span>
<span class="sd"> Name of the __iFUNC__</span>
<span class="sd"> :param op:</span>
<span class="sd"> Appropriate operator.__iFUNC__ operator</span>
<span class="sd"> :returns:</span>
<span class="sd"> self</span>
<span class="sd"> """</span>
<span class="n">proxiee_old</span> <span class="o">=</span> <span class="n">proxiee_new</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s"> on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">proxiee_old</span><span class="p">)</span>
<span class="c"># NOTE: This _may_ or _may not be_ calling __iFUNC__</span>
<span class="c"># as the proxiee may not support it in the first place</span>
<span class="n">proxiee_new</span> <span class="o">=</span> <span class="n">op</span><span class="p">(</span><span class="n">proxiee_old</span><span class="p">,</span> <span class="n">other</span><span class="p">)</span>
<span class="k">if</span> <span class="n">proxiee_new</span> <span class="ow">is</span> <span class="ow">not</span> <span class="n">proxiee_old</span><span class="p">:</span>
<span class="c"># NOTE: all of the augmented assignment methods handle the case where</span>
<span class="c"># the __iFUNC__ method returns something other than self. To maintain</span>
<span class="c"># the illusion that the proxy is not there the internal proxiee</span>
<span class="c"># reference is changed to the new proxiee.</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s"> creates new </span><span class="si">%s</span><span class="s"> (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span>
<span class="n">name</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">proxiee_new</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)(</span><span class="n">proxiee_new</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span>
<div class="viewcode-block" id="proxy_base"><a class="viewcode-back" href="../usage.html#padme.proxy_base">[docs]</a><span class="k">class</span> <span class="nc">proxy_base</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Base class for all proxies.</span>
<span class="sd"> This class implements the bulk of the proxy work by having a lot of dunder</span>
<span class="sd"> methods that delegate their work to a ``proxiee`` object. The ``proxiee``</span>
<span class="sd"> object must be available as the ``__proxiee__`` attribute on a class</span>
<span class="sd"> deriving from ``base_proxy``. Apart from ``__proxiee__`, the</span>
<span class="sd"> ``__unproxied__`` attribute, which should be a frozenset, must also be</span>
<span class="sd"> present in all derived classes.</span>
<span class="sd"> In practice, the two special attributes are injected via</span>
<span class="sd"> ``boundproxy_meta`` created by :func:`make_boundproxy_meta()`. This class</span>
<span class="sd"> is also used as a base class for the tricky :class:`proxy` below.</span>
<span class="sd"> NOTE: Look at ``pydoc3 SPECIALMETHODS`` section titled ``Special method</span>
<span class="sd"> lookup`` for a rationale of why we have all those dunder methods while</span>
<span class="sd"> still having __getattribute__()</span>
<span class="sd"> """</span>
<span class="c"># NOTE: the order of methods below matches that of ``pydoc3</span>
<span class="c"># SPECIALMETHODS``. The "N/A to instances" text means that it makes no</span>
<span class="c"># sense to add proxy support to the specified method because that method</span>
<span class="c"># makes no sense on instances. Proxy is designed to intercept access to</span>
<span class="c"># *objects*, not construction of such objects in the first place.</span>
<span class="c"># N/A to instances: __new__</span>
<span class="c"># N/A to instances: __init__</span>
<div class="viewcode-block" id="proxy_base.__del__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__del__">[docs]</a> <span class="k">def</span> <span class="nf">__del__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> No-op object delete method.</span>
<span class="sd"> .. note::</span>
<span class="sd"> This method is handled specially since it must be called after an</span>
<span class="sd"> object becomes unreachable. As long as the proxy object itself</span>
<span class="sd"> exits, it holds a strong reference to the original object.</span>
<span class="sd"> """</span>
</div>
<div class="viewcode-block" id="proxy_base.__repr__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__repr__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">repr</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__str__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__str__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__bytes__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__bytes__">[docs]</a> <span class="k">def</span> <span class="nf">__bytes__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__bytes__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">bytes</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__format__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__format__">[docs]</a> <span class="k">def</span> <span class="nf">__format__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">format_spec</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__format__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">format</span><span class="p">(</span><span class="n">proxiee</span><span class="p">,</span> <span class="n">format_spec</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__lt__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__lt__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span> <span class="o"><</span> <span class="n">other</span>
</div>
<div class="viewcode-block" id="proxy_base.__le__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__le__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span> <span class="o"><=</span> <span class="n">other</span>
</div>
<div class="viewcode-block" id="proxy_base.__eq__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__eq__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span> <span class="o">==</span> <span class="n">other</span>
</div>
<div class="viewcode-block" id="proxy_base.__ne__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__ne__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span> <span class="o">!=</span> <span class="n">other</span>
</div>
<div class="viewcode-block" id="proxy_base.__gt__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__gt__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span> <span class="o">></span> <span class="n">other</span>
</div>
<div class="viewcode-block" id="proxy_base.__ge__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__ge__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span> <span class="o">>=</span> <span class="n">other</span>
</div>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="c"># NOTE: having it in python3 is harmless but it's handled by</span>
<span class="c"># __getattribute__ already</span>
<span class="k">def</span> <span class="nf">__cmp__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__cmp__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">cmp</span><span class="p">(</span><span class="n">proxiee</span><span class="p">,</span> <span class="n">other</span><span class="p">)</span>
<div class="viewcode-block" id="proxy_base.__hash__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__hash__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">hash</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span>
<span class="c"># NOTE: __bool__ is spelled as __nonzero__ in pre-3K world</span>
<span class="c"># See PEP:`3100` for details.</span></div>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">3</span><span class="p">:</span>
<div class="viewcode-block" id="proxy_base.__bool__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__bool__">[docs]</a> <span class="k">def</span> <span class="nf">__bool__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__bool__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span></div>
<span class="k">else</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">__nonzero__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__nonzero__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">__unicode__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__unicode__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">unicode</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span>
<div class="viewcode-block" id="proxy_base.__getattr__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__getattr__">[docs]</a> <span class="k">def</span> <span class="nf">__getattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__getattr__ </span><span class="si">%r</span><span class="s"> on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">proxiee</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__getattribute__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__getattribute__">[docs]</a> <span class="k">def</span> <span class="nf">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="n">is_unproxied</span> <span class="o">=</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">_get_unproxied</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">is_imethod</span> <span class="o">=</span> <span class="n">name</span> <span class="ow">in</span> <span class="n">_imethods</span>
<span class="k">if</span> <span class="n">is_unproxied</span><span class="p">:</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s">.__getattribute__ </span><span class="si">%r</span><span class="s"> on proxy itself (direct)"</span><span class="p">,</span>
<span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="k">elif</span> <span class="n">is_imethod</span><span class="p">:</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span>
<span class="s">"</span><span class="si">%s</span><span class="s">.__getattribute__ </span><span class="si">%r</span><span class="s"> on proxy itself (augmented"</span>
<span class="s">" assignment)"</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">proxiee</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"</span><span class="si">%s</span><span class="s">.__getattribute__ </span><span class="si">%r</span><span class="s"> on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span>
<span class="nb">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">proxiee</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__setattr__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__setattr__">[docs]</a> <span class="k">def</span> <span class="nf">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">_get_unproxied</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__setattr__ </span><span class="si">%r</span><span class="s"> on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="nb">setattr</span><span class="p">(</span><span class="n">proxiee</span><span class="p">,</span> <span class="n">name</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="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__setattr__ </span><span class="si">%r</span><span class="s"> on proxy itself (direct)"</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="nb">object</span><span class="o">.</span><span class="n">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__delattr__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__delattr__">[docs]</a> <span class="k">def</span> <span class="nf">__delattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">):</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">_get_unproxied</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__delattr__ </span><span class="si">%r</span><span class="s"> on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="nb">delattr</span><span class="p">(</span><span class="n">proxiee</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__delattr__ </span><span class="si">%r</span><span class="s"> on proxy itself (direct)"</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="nb">object</span><span class="o">.</span><span class="n">__delattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__dir__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__dir__">[docs]</a> <span class="k">def</span> <span class="nf">__dir__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__dir__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">dir</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__get__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__get__">[docs]</a> <span class="k">def</span> <span class="nf">__get__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">owner</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__get__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span><span class="o">.</span><span class="n">__get__</span><span class="p">(</span><span class="n">instance</span><span class="p">,</span> <span class="n">owner</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__set__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__set__">[docs]</a> <span class="k">def</span> <span class="nf">__set__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__set__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="n">proxiee</span><span class="o">.</span><span class="n">__set__</span><span class="p">(</span><span class="n">instance</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__delete__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__delete__">[docs]</a> <span class="k">def</span> <span class="nf">__delete__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">instance</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__delete__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="n">proxiee</span><span class="o">.</span><span class="n">__delete__</span><span class="p">(</span><span class="n">instance</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__call__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__call__">[docs]</a> <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__call__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__len__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__len__">[docs]</a> <span class="k">def</span> <span class="nf">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__len__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span>
</div>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">2</span><span class="p">]</span> <span class="o">>=</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">):</span>
<div class="viewcode-block" id="proxy_base.__length_hint__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__length_hint__">[docs]</a> <span class="k">def</span> <span class="nf">__length_hint__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__length_hint__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span><span class="o">.</span><span class="n">__length_hint__</span><span class="p">()</span>
</div>
<div class="viewcode-block" id="proxy_base.__getitem__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__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">item</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__getitem__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span><span class="p">[</span><span class="n">item</span><span class="p">]</span>
</div>
<div class="viewcode-block" id="proxy_base.__setitem__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__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">item</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__setitem__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="n">proxiee</span><span class="p">[</span><span class="n">item</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
</div>
<div class="viewcode-block" id="proxy_base.__delitem__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__delitem__">[docs]</a> <span class="k">def</span> <span class="nf">__delitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">item</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__delitem__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">del</span> <span class="n">proxiee</span><span class="p">[</span><span class="n">item</span><span class="p">]</span>
</div>
<div class="viewcode-block" id="proxy_base.__iter__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__iter__">[docs]</a> <span class="k">def</span> <span class="nf">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__iter__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">iter</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__reversed__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__reversed__">[docs]</a> <span class="k">def</span> <span class="nf">__reversed__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__reversed__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">reversed</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__contains__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__contains__">[docs]</a> <span class="k">def</span> <span class="nf">__contains__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">item</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__contains__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">proxiee</span>
<span class="c"># NOTE: __{get,set,del}slice__() methods are not implemented as they are</span>
<span class="c"># not used anymore by anything, AFAIK</span>
<span class="c"># all basic numeric methods</span>
</div>
<div class="viewcode-block" id="proxy_base.__add__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__add__">[docs]</a> <span class="k">def</span> <span class="nf">__add__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__add__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span> <span class="o">+</span> <span class="n">other</span>
</div>
<div class="viewcode-block" id="proxy_base.__sub__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__sub__">[docs]</a> <span class="k">def</span> <span class="nf">__sub__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__sub__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span> <span class="o">-</span> <span class="n">other</span>
</div>
<div class="viewcode-block" id="proxy_base.__mul__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__mul__">[docs]</a> <span class="k">def</span> <span class="nf">__mul__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__mul__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span> <span class="o">*</span> <span class="n">other</span>
</div>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">2</span><span class="p">]</span> <span class="o">>=</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">5</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__matmul__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__matmul__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="c"># NOTE: this is equivalent to ``proxiee @ other`` but we cannot use</span>
<span class="c"># this syntax as long as 3.4 and earlier have to be supported.</span>
<span class="k">return</span> <span class="n">operator</span><span class="o">.</span><span class="n">matmul</span><span class="p">(</span><span class="n">proxiee</span><span class="p">,</span> <span class="n">other</span><span class="p">)</span>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">__div__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__div__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">operator</span><span class="o">.</span><span class="n">div</span><span class="p">(</span><span class="n">proxiee</span><span class="p">,</span> <span class="n">other</span><span class="p">)</span>
<div class="viewcode-block" id="proxy_base.__truediv__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__truediv__">[docs]</a> <span class="k">def</span> <span class="nf">__truediv__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__truediv__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">operator</span><span class="o">.</span><span class="n">truediv</span><span class="p">(</span><span class="n">proxiee</span><span class="p">,</span> <span class="n">other</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__floordiv__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__floordiv__">[docs]</a> <span class="k">def</span> <span class="nf">__floordiv__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__floordiv__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span> <span class="o">//</span> <span class="n">other</span>
</div>
<div class="viewcode-block" id="proxy_base.__mod__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__mod__">[docs]</a> <span class="k">def</span> <span class="nf">__mod__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__mod__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span> <span class="o">%</span> <span class="n">other</span>
</div>
<div class="viewcode-block" id="proxy_base.__divmod__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__divmod__">[docs]</a> <span class="k">def</span> <span class="nf">__divmod__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__divmod__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">divmod</span><span class="p">(</span><span class="n">proxiee</span><span class="p">,</span> <span class="n">other</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__pow__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__pow__">[docs]</a> <span class="k">def</span> <span class="nf">__pow__</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="n">modulo</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__pow__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">pow</span><span class="p">(</span><span class="n">proxiee</span><span class="p">,</span> <span class="n">other</span><span class="p">,</span> <span class="n">modulo</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__lshift__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__lshift__">[docs]</a> <span class="k">def</span> <span class="nf">__lshift__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__lshift__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span> <span class="o"><<</span> <span class="n">other</span>
</div>
<div class="viewcode-block" id="proxy_base.__rshift__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__rshift__">[docs]</a> <span class="k">def</span> <span class="nf">__rshift__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__rshift__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span> <span class="o">>></span> <span class="n">other</span>
</div>
<div class="viewcode-block" id="proxy_base.__and__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__and__">[docs]</a> <span class="k">def</span> <span class="nf">__and__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__and__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span> <span class="o">&</span> <span class="n">other</span>
</div>
<div class="viewcode-block" id="proxy_base.__xor__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__xor__">[docs]</a> <span class="k">def</span> <span class="nf">__xor__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__xor__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span> <span class="o">^</span> <span class="n">other</span>
</div>
<div class="viewcode-block" id="proxy_base.__or__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__or__">[docs]</a> <span class="k">def</span> <span class="nf">__or__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__or__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span> <span class="o">|</span> <span class="n">other</span>
<span class="c"># all reversed numeric methods</span>
</div>
<div class="viewcode-block" id="proxy_base.__radd__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__radd__">[docs]</a> <span class="k">def</span> <span class="nf">__radd__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__radd__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">other</span> <span class="o">+</span> <span class="n">proxiee</span>
</div>
<div class="viewcode-block" id="proxy_base.__rsub__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__rsub__">[docs]</a> <span class="k">def</span> <span class="nf">__rsub__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__rsub__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">other</span> <span class="o">-</span> <span class="n">proxiee</span>
</div>
<div class="viewcode-block" id="proxy_base.__rmul__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__rmul__">[docs]</a> <span class="k">def</span> <span class="nf">__rmul__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__rmul__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">other</span> <span class="o">*</span> <span class="n">proxiee</span>
</div>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">2</span><span class="p">]</span> <span class="o">>=</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">5</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__rmatmul__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__rmatmul__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="c"># NOTE: this is equivalent to ``proxiee @ other`` but we cannot use</span>
<span class="c"># this syntax as long as 3.4 and earlier have to be supported.</span>
<span class="k">return</span> <span class="n">operator</span><span class="o">.</span><span class="n">matmul</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">__rdiv__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__rdiv__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">operator</span><span class="o">.</span><span class="n">__div__</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<div class="viewcode-block" id="proxy_base.__rtruediv__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__rtruediv__">[docs]</a> <span class="k">def</span> <span class="nf">__rtruediv__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__rtruediv__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">operator</span><span class="o">.</span><span class="n">__truediv__</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__rfloordiv__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__rfloordiv__">[docs]</a> <span class="k">def</span> <span class="nf">__rfloordiv__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__rfloordiv__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">other</span> <span class="o">//</span> <span class="n">proxiee</span>
</div>
<div class="viewcode-block" id="proxy_base.__rmod__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__rmod__">[docs]</a> <span class="k">def</span> <span class="nf">__rmod__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__rmod__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">other</span> <span class="o">%</span> <span class="n">proxiee</span>
</div>
<div class="viewcode-block" id="proxy_base.__rdivmod__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__rdivmod__">[docs]</a> <span class="k">def</span> <span class="nf">__rdivmod__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__rdivmod__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">divmod</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__rpow__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__rpow__">[docs]</a> <span class="k">def</span> <span class="nf">__rpow__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__rpow__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">pow</span><span class="p">(</span><span class="n">other</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__rlshift__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__rlshift__">[docs]</a> <span class="k">def</span> <span class="nf">__rlshift__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__rlshift__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">other</span> <span class="o"><<</span> <span class="n">proxiee</span>
</div>
<div class="viewcode-block" id="proxy_base.__rrshift__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__rrshift__">[docs]</a> <span class="k">def</span> <span class="nf">__rrshift__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__rrshift__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">other</span> <span class="o">>></span> <span class="n">proxiee</span>
</div>
<div class="viewcode-block" id="proxy_base.__rand__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__rand__">[docs]</a> <span class="k">def</span> <span class="nf">__rand__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__rand__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">other</span> <span class="o">&</span> <span class="n">proxiee</span>
</div>
<div class="viewcode-block" id="proxy_base.__rxor__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__rxor__">[docs]</a> <span class="k">def</span> <span class="nf">__rxor__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__rxor__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">other</span> <span class="o">^</span> <span class="n">proxiee</span>
</div>
<div class="viewcode-block" id="proxy_base.__ror__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__ror__">[docs]</a> <span class="k">def</span> <span class="nf">__ror__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__rrshift__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">other</span> <span class="o">|</span> <span class="n">proxiee</span>
<span class="c"># all augmented assignment numeric methods</span>
</div>
<div class="viewcode-block" id="proxy_base.__iadd__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__iadd__">[docs]</a> <span class="k">def</span> <span class="nf">__iadd__</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">return</span> <span class="n">_imethod</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="s">'__iadd__'</span><span class="p">,</span> <span class="n">operator</span><span class="o">.</span><span class="n">iadd</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__isub__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__isub__">[docs]</a> <span class="k">def</span> <span class="nf">__isub__</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">return</span> <span class="n">_imethod</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="s">'__isub__'</span><span class="p">,</span> <span class="n">operator</span><span class="o">.</span><span class="n">isub</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__imul__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__imul__">[docs]</a> <span class="k">def</span> <span class="nf">__imul__</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">return</span> <span class="n">_imethod</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="s">'__imul__'</span><span class="p">,</span> <span class="n">operator</span><span class="o">.</span><span class="n">imul</span><span class="p">)</span>
</div>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">2</span><span class="p">]</span> <span class="o">>=</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">5</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">__imatmul__</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">return</span> <span class="n">_imethod</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="s">'__imatmul__'</span><span class="p">,</span> <span class="n">operator</span><span class="o">.</span><span class="n">imatmul</span><span class="p">)</span>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">__idiv__</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">return</span> <span class="n">_imethod</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="s">'__idiv__'</span><span class="p">,</span> <span class="n">operator</span><span class="o">.</span><span class="n">idiv</span><span class="p">)</span>
<div class="viewcode-block" id="proxy_base.__itruediv__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__itruediv__">[docs]</a> <span class="k">def</span> <span class="nf">__itruediv__</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">return</span> <span class="n">_imethod</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="s">'__itruediv__'</span><span class="p">,</span> <span class="n">operator</span><span class="o">.</span><span class="n">itruediv</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__ifloordiv__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__ifloordiv__">[docs]</a> <span class="k">def</span> <span class="nf">__ifloordiv__</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">return</span> <span class="n">_imethod</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="s">'__ifloordiv__'</span><span class="p">,</span> <span class="n">operator</span><span class="o">.</span><span class="n">ifloordiv</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__imod__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__imod__">[docs]</a> <span class="k">def</span> <span class="nf">__imod__</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">return</span> <span class="n">_imethod</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="s">'__imod__'</span><span class="p">,</span> <span class="n">operator</span><span class="o">.</span><span class="n">imod</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__ipow__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__ipow__">[docs]</a> <span class="k">def</span> <span class="nf">__ipow__</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="n">modulo</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="k">assert</span> <span class="n">modulo</span> <span class="ow">is</span> <span class="bp">None</span>
<span class="k">return</span> <span class="n">_imethod</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="s">'__ipow__'</span><span class="p">,</span> <span class="n">operator</span><span class="o">.</span><span class="n">ipow</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__ilshift__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__ilshift__">[docs]</a> <span class="k">def</span> <span class="nf">__ilshift__</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">return</span> <span class="n">_imethod</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="s">'__ilshift__'</span><span class="p">,</span> <span class="n">operator</span><span class="o">.</span><span class="n">ilshift</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__irshift__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__irshift__">[docs]</a> <span class="k">def</span> <span class="nf">__irshift__</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">return</span> <span class="n">_imethod</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="s">'__irshift__'</span><span class="p">,</span> <span class="n">operator</span><span class="o">.</span><span class="n">irshift</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__iand__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__iand__">[docs]</a> <span class="k">def</span> <span class="nf">__iand__</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">return</span> <span class="n">_imethod</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="s">'__iand__'</span><span class="p">,</span> <span class="n">operator</span><span class="o">.</span><span class="n">iand</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__ixor__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__ixor__">[docs]</a> <span class="k">def</span> <span class="nf">__ixor__</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">return</span> <span class="n">_imethod</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="s">'__ixor__'</span><span class="p">,</span> <span class="n">operator</span><span class="o">.</span><span class="n">ixor</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__ior__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__ior__">[docs]</a> <span class="k">def</span> <span class="nf">__ior__</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">return</span> <span class="n">_imethod</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="s">'__ior__'</span><span class="p">,</span> <span class="n">operator</span><span class="o">.</span><span class="n">ior</span><span class="p">)</span>
<span class="c"># all miscellaneous numeric methods</span>
</div>
<div class="viewcode-block" id="proxy_base.__neg__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__neg__">[docs]</a> <span class="k">def</span> <span class="nf">__neg__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__neg__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="o">-</span> <span class="n">proxiee</span>
</div>
<div class="viewcode-block" id="proxy_base.__pos__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__pos__">[docs]</a> <span class="k">def</span> <span class="nf">__pos__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__pos__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="o">+</span> <span class="n">proxiee</span>
</div>
<div class="viewcode-block" id="proxy_base.__abs__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__abs__">[docs]</a> <span class="k">def</span> <span class="nf">__abs__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__abs__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">abs</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__invert__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__invert__">[docs]</a> <span class="k">def</span> <span class="nf">__invert__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__invert__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="o">~</span> <span class="n">proxiee</span>
<span class="c"># Helpers for built-ins: complex(), int(), float() and round()</span>
</div>
<div class="viewcode-block" id="proxy_base.__complex__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__complex__">[docs]</a> <span class="k">def</span> <span class="nf">__complex__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__complex__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">complex</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_base.__int__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__int__">[docs]</a> <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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__int__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span>
</div>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__long__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">long</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span>
<div class="viewcode-block" id="proxy_base.__float__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__float__">[docs]</a> <span class="k">def</span> <span class="nf">__float__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__float__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">float</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span>
</div>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">3</span><span class="p">:</span>
<div class="viewcode-block" id="proxy_base.__round__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__round__">[docs]</a> <span class="k">def</span> <span class="nf">__round__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">n</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__float__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">round</span><span class="p">(</span><span class="n">proxiee</span><span class="p">,</span> <span class="n">n</span><span class="p">)</span>
</div>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__oct__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">oct</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__hex__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">hex</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span>
<div class="viewcode-block" id="proxy_base.__index__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__index__">[docs]</a> <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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__index__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">operator</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span>
</div>
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
<span class="k">def</span> <span class="nf">__coerce__</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="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__coerce__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">coerce</span><span class="p">(</span><span class="n">proxiee</span><span class="p">,</span> <span class="n">other</span><span class="p">)</span>
<div class="viewcode-block" id="proxy_base.__enter__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__enter__">[docs]</a> <span class="k">def</span> <span class="nf">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__enter__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span><span class="o">.</span><span class="n">__enter__</span><span class="p">()</span>
</div>
<div class="viewcode-block" id="proxy_base.__exit__"><a class="viewcode-back" href="../usage.html#padme.proxy_base.__exit__">[docs]</a> <span class="k">def</span> <span class="nf">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">,</span> <span class="n">traceback</span><span class="p">):</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">_get_proxiee</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"__exit__ on proxiee (</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="k">return</span> <span class="n">proxiee</span><span class="o">.</span><span class="n">__exit__</span><span class="p">(</span><span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">,</span> <span class="n">traceback</span><span class="p">)</span>
</div></div>
<div class="viewcode-block" id="proxy_state"><a class="viewcode-back" href="../usage.html#padme.proxy_state">[docs]</a><span class="k">class</span> <span class="nc">proxy_state</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Support class for working with proxy state.</span>
<span class="sd"> This class implements simple attribute-based access methods. It is normally</span>
<span class="sd"> instantiated internally for each proxy object. You don't want to fuss with</span>
<span class="sd"> it manually, instead just use :meth:`proxy.state()` function to access it.</span>
<span class="sd"> """</span>
<div class="viewcode-block" id="proxy_state.__init__"><a class="viewcode-back" href="../usage.html#padme.proxy_state.__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">proxy_obj</span><span class="p">):</span>
<span class="n">proxy_dict</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__getattribute__</span><span class="p">(</span><span class="n">proxy_obj</span><span class="p">,</span> <span class="s">'__dict__'</span><span class="p">)</span>
<span class="nb">object</span><span class="o">.</span><span class="n">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">'__dict__'</span><span class="p">,</span> <span class="n">proxy_dict</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="proxy_state.__repr__"><a class="viewcode-back" href="../usage.html#padme.proxy_state.__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="k">return</span> <span class="s">"<{}.{} object at {:#x} with state {!r}>"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">__name__</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="nb">id</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">__dict__</span><span class="p">)</span>
</div></div>
<span class="k">class</span> <span class="nc">metaclass</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Support decorator for Python-agnostic meta-class injection.</span>
<span class="sd"> The following snippet illustrates how to use this decorator:</span>
<span class="sd"> >>> class my_meta(type):</span>
<span class="sd"> ... METACLASS_WORKS = True</span>
<span class="sd"> >>> @metaclass(my_meta)</span>
<span class="sd"> ... class my_cls(object):</span>
<span class="sd"> ... pass</span>
<span class="sd"> >>> assert my_cls.METACLASS_WORKS</span>
<span class="sd"> """</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="n">mcls</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">mcls</span> <span class="o">=</span> <span class="n">mcls</span>
<span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cls</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="c"># NOTE: the name is not changed so that sphinx doesn't think this is an</span>
<span class="c"># alias of some other object. This is pretty weird but important.</span>
<span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">name</span> <span class="o">=</span> <span class="n">cls</span><span class="o">.</span><span class="n">__name__</span>
<span class="n">bases</span> <span class="o">=</span> <span class="p">(</span><span class="n">cls</span><span class="p">,)</span>
<span class="n">ns</span> <span class="o">=</span> <span class="p">{</span>
<span class="c"># Patch-in __doc__ so that various help systems work better</span>
<span class="s">'__doc__'</span><span class="p">:</span> <span class="n">cls</span><span class="o">.</span><span class="n">__doc__</span><span class="p">,</span>
<span class="p">}</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"metaclass(</span><span class="si">%s</span><span class="s">)(</span><span class="si">%s</span><span class="s">, name=</span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">mcls</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">cls</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">name</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">mcls</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">bases</span><span class="p">,</span> <span class="n">ns</span><span class="p">)</span>
<span class="nd">@metaclass</span><span class="p">(</span><span class="n">proxy_meta</span><span class="p">)</span>
<div class="viewcode-block" id="proxy"><a class="viewcode-back" href="../usage.html#padme.proxy">[docs]</a><span class="k">class</span> <span class="nc">proxy</span><span class="p">(</span><span class="n">proxy_base</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> A mostly transparent proxy type.</span>
<span class="sd"> The proxy class can be used in two different ways. First, as a callable</span>
<span class="sd"> ``proxy(obj)``. This simply returns a proxy for a single object.</span>
<span class="sd"> >>> truth = [str('trust no one')]</span>
<span class="sd"> >>> lie = proxy(truth)</span>
<span class="sd"> This will return an instance of a new ``proxy`` sub-class which for all</span>
<span class="sd"> intents and purposes, to the extent possible in CPython, forwards all</span>
<span class="sd"> requests to the original object.</span>
<span class="sd"> One can still examine the proxy with some ways::</span>
<span class="sd"> >>> lie is truth</span>
<span class="sd"> False</span>
<span class="sd"> >>> type(lie) is type(truth)</span>
<span class="sd"> False</span>
<span class="sd"> Having said that, the vast majority of stuff will make the proxy behave</span>
<span class="sd"> identically to the original object.</span>
<span class="sd"> >>> lie[0]</span>
<span class="sd"> 'trust no one'</span>
<span class="sd"> >>> lie[0] = str('trust the government')</span>
<span class="sd"> >>> truth[0]</span>
<span class="sd"> 'trust the government'</span>
<span class="sd"> The second way of using the ``proxy`` class is as a base class. In this</span>
<span class="sd"> way, one can actually override certain methods. To ensure that all the</span>
<span class="sd"> dunder methods work correctly please use the ``@proxy.direct`` decorator on</span>
<span class="sd"> them.</span>
<span class="sd"> >>> import codecs</span>
<span class="sd"> >>> class crypto(proxy):</span>
<span class="sd"> ...</span>
<span class="sd"> ... @proxy.direct</span>
<span class="sd"> ... def __repr__(self):</span>
<span class="sd"> ... return codecs.encode(</span>
<span class="sd"> ... super(crypto, self).__repr__(), "rot_13")</span>
<span class="sd"> With this weird class, we can change the repr() of any object we want to be</span>
<span class="sd"> ROT-13 encoded. Let's see:</span>
<span class="sd"> >>> orig = [str('ala ma kota'), str('a kot ma ale')]</span>
<span class="sd"> >>> prox = crypto(orig)</span>
<span class="sd"> We can sill access all of the data through the proxy:</span>
<span class="sd"> >>> prox[0]</span>
<span class="sd"> 'ala ma kota'</span>
<span class="sd"> But the whole repr() is now a bit different than usual:</span>
<span class="sd"> >>> prox</span>
<span class="sd"> ['nyn zn xbgn', 'n xbg zn nyr']</span>
<span class="sd"> """</span>
<span class="c"># Registry of known typed_proxy_meta objects</span>
<span class="n">_m_registry</span> <span class="o">=</span> <span class="p">{}</span>
<span class="c"># There is a corresponding _c_registry but it is reset for each proxy</span>
<span class="c"># subclass by proxy_meta.</span>
<span class="k">def</span> <span class="nf">__new__</span><span class="p">(</span><span class="n">proxy_cls</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Create a new instance of ``proxy()`` wrapping ``proxiee``.</span>
<span class="sd"> :param proxiee:</span>
<span class="sd"> The object to proxy</span>
<span class="sd"> :returns:</span>
<span class="sd"> An instance of new subclass of ``proxy`` with injected meta-class</span>
<span class="sd"> proxy_meta[cls] where cls is the type of proxiee.</span>
<span class="sd"> """</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span>
<span class="s">"</span><span class="si">%s</span><span class="s">.__new__ with proxiee: </span><span class="si">%r</span><span class="s"> (args: </span><span class="si">%r</span><span class="s">, kwargs </span><span class="si">%r</span><span class="s">)"</span><span class="p">,</span>
<span class="n">proxy_cls</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">)</span>
<span class="n">proxiee_cls</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="n">proxiee</span><span class="p">)</span>
<span class="n">typed_proxy_cls</span> <span class="o">=</span> <span class="n">proxy_cls</span><span class="p">[</span><span class="n">proxiee_cls</span><span class="p">]</span>
<span class="n">proxy_obj</span> <span class="o">=</span> <span class="nb">object</span><span class="o">.</span><span class="n">__new__</span><span class="p">(</span><span class="n">typed_proxy_cls</span><span class="p">)</span>
<span class="n">state</span> <span class="o">=</span> <span class="n">proxy_state</span><span class="p">(</span><span class="n">proxy_obj</span><span class="p">)</span>
<span class="c"># _logger.debug("%s.__new__ inserted _original into instance",</span>
<span class="c"># proxy_cls.__name__)</span>
<span class="n">state</span><span class="o">.</span><span class="n">_original</span> <span class="o">=</span> <span class="n">proxiee</span>
<span class="c"># _logger.debug("%s.__new__ is about to return", proxy_cls.__name__)</span>
<span class="k">return</span> <span class="n">proxy_obj</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="n">proxy_obj</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Initialize a fresh proxy instance specific to ``proxiee``.</span>
<span class="sd"> :param proxiee:</span>
<span class="sd"> The object to proxy</span>
<span class="sd"> """</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span>
<span class="s">"</span><span class="si">%s</span><span class="s">.__init__ with proxiee: </span><span class="si">%r</span><span class="s">"</span><span class="p">,</span> <span class="nb">type</span><span class="p">(</span><span class="n">proxy_obj</span><span class="p">)</span><span class="o">.</span><span class="n">__name__</span><span class="p">,</span> <span class="n">proxiee</span><span class="p">)</span>
<span class="nd">@staticmethod</span>
<div class="viewcode-block" id="proxy.direct"><a class="viewcode-back" href="../usage.html#padme.proxy.direct">[docs]</a> <span class="k">def</span> <span class="nf">direct</span><span class="p">(</span><span class="n">fn</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Mark a method as not-to-be-proxied.</span>
<span class="sd"> This decorator can be used inside :class:`proxy` sub-classes. Please</span>
<span class="sd"> consult the documentation of ``proxy`` for details.</span>
<span class="sd"> In practical terms there are two reasons one can use ``proxy.direct``.</span>
<span class="sd"> - First, as a way to change the behaviour of a proxy. In this mode a</span>
<span class="sd"> method that already exists on the proxied object is intercepted and</span>
<span class="sd"> custom code is executed. The custom code can still call the original,</span>
<span class="sd"> if desired, by using the :meth:`proxy.original()` function to access</span>
<span class="sd"> the original object</span>
<span class="sd"> - Second, as a way to introduce new functionality to an object. In that</span>
<span class="sd"> sense the resulting proxy will be less transparent as all</span>
<span class="sd"> ``proxy.direct`` methods are explicitly visible and available to</span>
<span class="sd"> access but this may be exactly what is desired in some situations.</span>
<span class="sd"> For additional details on how to use this decorator, see the</span>
<span class="sd"> documentation of the :mod:`padme` module.</span>
<span class="sd"> """</span>
<span class="n">fn</span><span class="o">.</span><span class="n">unproxied</span> <span class="o">=</span> <span class="bp">True</span>
<span class="n">_logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s">"function </span><span class="si">%r</span><span class="s"> marked as unproxied/direct"</span><span class="p">,</span> <span class="n">fn</span><span class="p">)</span>
<span class="k">return</span> <span class="n">fn</span>
</div>
<span class="nd">@staticmethod</span>
<div class="viewcode-block" id="proxy.original"><a class="viewcode-back" href="../usage.html#padme.proxy.original">[docs]</a> <span class="k">def</span> <span class="nf">original</span><span class="p">(</span><span class="n">proxy_obj</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Return the :term:`proxiee` hidden behind the given proxy.</span>
<span class="sd"> :param proxy:</span>
<span class="sd"> An instance of :class:`proxy` or its subclass.</span>
<span class="sd"> :returns:</span>
<span class="sd"> The original object that the proxy is hiding.</span>
<span class="sd"> This function can be used to access the object hidden behind a proxy.</span>
<span class="sd"> This is useful when access to original object is necessary, for</span>
<span class="sd"> example, to implement an method decorated with ``@proxy.direct``.</span>
<span class="sd"> In the following example, we cannot use ``super()`` to get access to</span>
<span class="sd"> the append method because the proxy does not really subclass the list</span>
<span class="sd"> object. To override the ``append`` method in a way that allows us to</span>
<span class="sd"> still call the original we must use the :meth:`proxy.original()`</span>
<span class="sd"> function::</span>
<span class="sd"> >>> class verbose_list(proxy):</span>
<span class="sd"> ... @proxy.direct</span>
<span class="sd"> ... def append(self, item):</span>
<span class="sd"> ... print("Appending:", item)</span>
<span class="sd"> ... proxy.original(self).append(item)</span>
<span class="sd"> Now that we have a ``verbose_list`` class, we can use it to see that it</span>
<span class="sd"> works as expected:</span>
<span class="sd"> >>> l = verbose_list([])</span>
<span class="sd"> >>> l.append(42)</span>
<span class="sd"> Appending: 42</span>
<span class="sd"> >>> l</span>
<span class="sd"> [42]</span>
<span class="sd"> """</span>
<span class="n">state</span> <span class="o">=</span> <span class="n">proxy_state</span><span class="p">(</span><span class="n">proxy_obj</span><span class="p">)</span>
<span class="k">return</span> <span class="n">state</span><span class="o">.</span><span class="n">_original</span>
</div>
<span class="nd">@staticmethod</span>
<div class="viewcode-block" id="proxy.state"><a class="viewcode-back" href="../usage.html#padme.proxy.state">[docs]</a> <span class="k">def</span> <span class="nf">state</span><span class="p">(</span><span class="n">proxy_obj</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> Support function for accessing the state of a proxy object.</span>
<span class="sd"> The main reason for this function to exist is to facilitate creating</span>
<span class="sd"> stateful proxy objects. This allows you to put state on objects that</span>
<span class="sd"> cannot otherwise hold it (typically built-in classes or classes using</span>
<span class="sd"> ``__slots__``) and to keep the state invisible to the original object</span>
<span class="sd"> so that it cannot interfere with any future APIs.</span>
<span class="sd"> To use it, just call it on any proxy object and use the return value as</span>
<span class="sd"> a normal object you can get/set attributes on. For example:</span>
<span class="sd"> >>> life = proxy(42)</span>
<span class="sd"> We cannot set attributes on integer instances:</span>
<span class="sd"> >>> life.foo = True</span>
<span class="sd"> Traceback (most recent call last):</span>
<span class="sd"> ...</span>
<span class="sd"> AttributeError: 'int' object has no attribute 'foo'</span>
<span class="sd"> But we can do that with a proxy around the integer object.</span>
<span class="sd"> >>> proxy.state(life).foo = True</span>
<span class="sd"> >>> proxy.state(life).foo</span>
<span class="sd"> True</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">proxy_state</span><span class="p">(</span><span class="n">proxy_obj</span><span class="p">)</span>
<span class="c"># 1.0 backwards-compatibility aliases</span></div></div>
<span class="n">unproxied</span> <span class="o">=</span> <span class="n">proxy</span><span class="o">.</span><span class="n">direct</span>
<span class="n">proxiee</span> <span class="o">=</span> <span class="n">proxy</span><span class="o">.</span><span class="n">original</span>
</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">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</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="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">padme 1.1.1 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">
© Copyright 2014, Zygmunt Krynicki.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
</div>
</body>
</html>
|