/usr/share/pyshared/zope/component/registry.txt is in python-zope.component 3.10.0-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 | Component-Management objects
============================
Component-management objects provide a higher-level
component-management API over the basic adapter-registration API
provided by the zope.interface package. In particular, it provides:
- utilities
- support for computing adapters, rather than just looking up adapter
factories.
- management of registration comments
The zope.component.registry.Components class provides an
implementation of zope.component.interfaces.IComponents that provides
these features.
>>> from zope.component import registry
>>> from zope.component import tests
>>> components = registry.Components('comps')
As components are registered, events are generated. Let's register
an event subscriber, so we can see the events generated:
>>> import zope.event
>>> def logevent(event):
... print event
>>> zope.event.subscribers.append(logevent)
Utilities
---------
You can register Utilities using registerUtility:
>>> components.registerUtility(tests.U1(1))
Registered event:
UtilityRegistration(<Components comps>, I1, u'', 1, None, u'')
Here we didn't specify an interface or name. An unnamed utility was
registered for interface I1, since that is only interface implemented
by the U1 class:
>>> components.getUtility(tests.I1)
U1(1)
You can also register a utility using a factory instead of a utility instance:
>>> def factory():
... return tests.U1(1)
>>> components.registerUtility(factory=factory)
Unregistered event:
UtilityRegistration(<Components comps>, I1, u'', 1, None, u'')
Registered event:
UtilityRegistration(<Components comps>, I1, u'', 1, <function factory at <SOME ADDRESS>>, u'')
If a component implements other than one interface or no interface,
then an error will be raised:
>>> components.registerUtility(tests.U12(2))
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
TypeError: The utility doesn't provide a single interface and
no provided interface was specified.
>>> components.registerUtility(tests.A)
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
TypeError: The utility doesn't provide a single interface and
no provided interface was specified.
We can provide an interface if desired:
>>> components.registerUtility(tests.U12(2), tests.I2)
Registered event:
UtilityRegistration(<Components comps>, I2, u'', 2, None, u'')
and we can specify a name:
>>> components.registerUtility(tests.U12(3), tests.I2, u'three')
Registered event:
UtilityRegistration(<Components comps>, I2, u'three', 3, None, u'')
>>> components.getUtility(tests.I2)
U12(2)
>>> components.getUtility(tests.I2, 'three')
U12(3)
If you try to get a utility that doesn't exist, you'll get a component
lookup error:
>>> components.getUtility(tests.I3)
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
ComponentLookupError:
(<InterfaceClass zope.component.tests.I3>, u'')
Unless you use queryUtility:
>>> components.queryUtility(tests.I3)
>>> components.queryUtility(tests.I3, default=42)
42
You can get information about registered utilities with the
registeredUtilities method:
>>> for registration in sorted(components.registeredUtilities()):
... print registration.provided, registration.name
... print registration.component, registration.info
<InterfaceClass zope.component.tests.I1>
U1(1)
<InterfaceClass zope.component.tests.I2>
U12(2)
<InterfaceClass zope.component.tests.I2> three
U12(3)
Duplicate registrations replace existing ones:
>>> components.registerUtility(tests.U1(4), info=u'use 4 now')
Unregistered event:
UtilityRegistration(<Components comps>, I1, u'', 1, <function factory at <SOME ADDRESS>>, u'')
Registered event:
UtilityRegistration(<Components comps>, I1, u'', 4, None, u'use 4 now')
>>> components.getUtility(tests.I1)
U1(4)
>>> for registration in sorted(components.registeredUtilities()):
... print registration.provided, registration.name
... print registration.component, registration.info
<InterfaceClass zope.component.tests.I1>
U1(4) use 4 now
<InterfaceClass zope.component.tests.I2>
U12(2)
<InterfaceClass zope.component.tests.I2> three
U12(3)
As shown in the this example, you can provide an "info" argumemnt when
registering utilities. This provides extra documentation about the
registration itself that is shown when listing registrations.
You can also unregister utilities:
>>> components.unregisterUtility(provided=tests.I1)
Unregistered event:
UtilityRegistration(<Components comps>, I1, u'', 4, None, u'use 4 now')
True
A boolean is returned indicating whether anything changed:
>>> components.queryUtility(tests.I1)
>>> for registration in sorted(components.registeredUtilities()):
... print registration.provided, registration.name
... print registration.component, registration.info
<InterfaceClass zope.component.tests.I2>
U12(2)
<InterfaceClass zope.component.tests.I2> three
U12(3)
When you unregister, you can specify a component. If the component
doesn't match the one registered, then nothing happens:
>>> u5 = tests.U1(5)
>>> components.registerUtility(u5)
Registered event:
UtilityRegistration(<Components comps>, I1, u'', 5, None, u'')
>>> components.unregisterUtility(tests.U1(6))
False
>>> components.queryUtility(tests.I1)
U1(5)
>>> components.unregisterUtility(u5)
Unregistered event:
UtilityRegistration(<Components comps>, I1, u'', 5, None, u'')
True
>>> components.queryUtility(tests.I1)
You can get the name and utility for all of the utilities that provide
an interface using getUtilitiesFor:
>>> sorted(components.getUtilitiesFor(tests.I2))
[(u'', U12(2)), (u'three', U12(3))]
getAllUtilitiesRegisteredFor is similar to getUtilitiesFor except that
it includes utilities that are overridden. For example, we'll
register a utility that for an extending interface of I2:
>>> util = tests.U('ext')
>>> components.registerUtility(util, tests.I2e)
Registered event:
UtilityRegistration(<Components comps>, I2e, u'', ext, None, u'')
We don't get the new utility for getUtilitiesFor:
>>> sorted(components.getUtilitiesFor(tests.I2))
[(u'', U12(2)), (u'three', U12(3))]
but we do get it from getAllUtilitiesRegisteredFor:
>>> sorted(map(str, components.getAllUtilitiesRegisteredFor(tests.I2)))
['U(ext)', 'U12(2)', 'U12(3)']
Removing a utility also makes it disappear from getUtilitiesFor:
>>> components.unregisterUtility(util, tests.I2e)
Unregistered event:
UtilityRegistration(<Components comps>, I2e, u'', ext, None, u'')
True
>>> list(components.getAllUtilitiesRegisteredFor(tests.I2e))
[]
Adapters
--------
You can register adapters with registerAdapter:
>>> components.registerAdapter(tests.A12_1)
Registered event:
AdapterRegistration(<Components comps>, [I1, I2], IA1, u'', A12_1, u'')
Here, we didn't specify required interfaces, a provided interface, or
a name. The required interfaces were determined from the factory
s __component_adapts__ attribute and the provided interface was
determined by introspecting what the factory implements.
>>> components.getMultiAdapter((tests.U1(6), tests.U12(7)), tests.IA1)
A12_1(U1(6), U12(7))
If a factory implements more than one interface, an exception will be
raised:
>>> components.registerAdapter(tests.A1_12)
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
TypeError: The adapter factory doesn't implement a single
interface and no provided interface was specified.
Unless the provided interface is specified:
>>> components.registerAdapter(tests.A1_12, provided=tests.IA2)
Registered event:
AdapterRegistration(<Components comps>, [I1], IA2, u'', A1_12, u'')
If a factory doesn't declare an implemented interface, an exception will be
raised:
>>> components.registerAdapter(tests.A12_)
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
TypeError: The adapter factory doesn't implement a single
interface and no provided interface was specified.
Unless the provided interface is specified:
>>> components.registerAdapter(tests.A12_, provided=tests.IA2)
Registered event:
AdapterRegistration(<Components comps>, [I1, I2], IA2, u'', A12_, u'')
The required interface needs to be specified in the registration if
the factory doesn't have a __component_adapts__ attribute:
>>> components.registerAdapter(tests.A_2)
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
TypeError: The adapter factory doesn't have a __component_adapts__
attribute and no required specifications were specified
Unless the required specifications specified:
>>> components.registerAdapter(tests.A_2, required=[tests.I3])
Registered event:
AdapterRegistration(<Components comps>, [I3], IA2, u'', A_2, u'')
Classes can be specified in place of specifications, in which case the
implementedBy specification for the class is used:
>>> components.registerAdapter(tests.A_3, required=[tests.U],
... info="Really class specific")
... # doctest: +NORMALIZE_WHITESPACE
Registered event:
AdapterRegistration(<Components comps>, [zope.component.tests.U], IA3, u'',
A_3, 'Really class specific')
We can see the adapters that have been registered using the
registeredAdapters method:
>>> for registration in sorted(components.registeredAdapters()):
... print registration.required
... print registration.provided, registration.name
... print registration.factory, registration.info
... # doctest: +NORMALIZE_WHITESPACE
(<InterfaceClass zope.component.tests.I1>,
<InterfaceClass zope.component.tests.I2>)
<InterfaceClass zope.component.tests.IA1>
zope.component.tests.A12_1
(<InterfaceClass zope.component.tests.I1>,
<InterfaceClass zope.component.tests.I2>)
<InterfaceClass zope.component.tests.IA2>
zope.component.tests.A12_
(<InterfaceClass zope.component.tests.I1>,)
<InterfaceClass zope.component.tests.IA2>
zope.component.tests.A1_12
(<InterfaceClass zope.component.tests.I3>,)
<InterfaceClass zope.component.tests.IA2>
zope.component.tests.A_2
(<implementedBy zope.component.tests.U>,)
<InterfaceClass zope.component.tests.IA3>
zope.component.tests.A_3 Really class specific
As with utilities, we can provide registration information when
registering adapters.
If you try to fetch an adapter that isn't registered, you'll get a
component-lookup error:
>>> components.getMultiAdapter((tests.U(8), ), tests.IA1)
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
ComponentLookupError: ((U(8),),
<InterfaceClass zope.component.tests.IA1>, u'')
unless you use queryAdapter:
>>> components.queryMultiAdapter((tests.U(8), ), tests.IA1)
>>> components.queryMultiAdapter((tests.U(8), ), tests.IA1, default=42)
42
When looking up an adapter for a single object, you can use the
slightly simpler getAdapter and queryAdapter calls:
>>> components.getAdapter(tests.U1(9), tests.IA2)
A1_12(U1(9))
>>> components.queryAdapter(tests.U1(9), tests.IA2)
A1_12(U1(9))
>>> components.getAdapter(tests.U(8), tests.IA1)
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
ComponentLookupError: (U(8),
<InterfaceClass zope.component.tests.IA1>, u'')
>>> components.queryAdapter(tests.U(8), tests.IA2)
>>> components.queryAdapter(tests.U(8), tests.IA2, default=42)
42
You can unregister an adapter. If a factory is provided and if the
rewuired and provided interfaces, can be infered, then they need not
be provided:
>>> components.unregisterAdapter(tests.A12_1)
Unregistered event:
AdapterRegistration(<Components comps>, [I1, I2], IA1, u'', A12_1, u'')
True
>>> for registration in sorted(components.registeredAdapters()):
... print registration.required
... print registration.provided, registration.name
... print registration.factory, registration.info
... # doctest: +NORMALIZE_WHITESPACE
(<InterfaceClass zope.component.tests.I1>,
<InterfaceClass zope.component.tests.I2>)
<InterfaceClass zope.component.tests.IA2>
zope.component.tests.A12_
(<InterfaceClass zope.component.tests.I1>,)
<InterfaceClass zope.component.tests.IA2>
zope.component.tests.A1_12
(<InterfaceClass zope.component.tests.I3>,)
<InterfaceClass zope.component.tests.IA2>
zope.component.tests.A_2
(<implementedBy zope.component.tests.U>,)
<InterfaceClass zope.component.tests.IA3>
zope.component.tests.A_3 Really class specific
A boolean is returned indicating whether a change was made.
If a factory implements more than one interface, an exception will be
raised:
>>> components.unregisterAdapter(tests.A1_12)
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
TypeError: The adapter factory doesn't implement a single
interface and no provided interface was specified.
Unless the provided interface is specified:
>>> components.unregisterAdapter(tests.A1_12, provided=tests.IA2)
Unregistered event:
AdapterRegistration(<Components comps>, [I1], IA2, u'', A1_12, u'')
True
If a factory doesn't declare an implemented interface, an exception will be
raised:
>>> components.unregisterAdapter(tests.A12_)
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
TypeError: The adapter factory doesn't implement a single
interface and no provided interface was specified.
Unless the provided interface is specified:
>>> components.unregisterAdapter(tests.A12_, provided=tests.IA2)
Unregistered event:
AdapterRegistration(<Components comps>, [I1, I2], IA2, u'', A12_, u'')
True
The required interface needs to be specified if the factory doesn't
have a __component_adapts__ attribute:
>>> components.unregisterAdapter(tests.A_2)
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
TypeError: The adapter factory doesn't have a __component_adapts__
attribute and no required specifications were specified
>>> components.unregisterAdapter(tests.A_2, required=[tests.I3])
Unregistered event:
AdapterRegistration(<Components comps>, [I3], IA2, u'', A_2, u'')
True
>>> for registration in sorted(components.registeredAdapters()):
... print registration.required
... print registration.provided, registration.name
... print registration.factory, registration.info
... # doctest: +NORMALIZE_WHITESPACE
(<implementedBy zope.component.tests.U>,)
<InterfaceClass zope.component.tests.IA3>
zope.component.tests.A_3 Really class specific
If a factory is unregistered that is not registered, False is
returned:
>>> components.unregisterAdapter(tests.A_2, required=[tests.I3])
False
>>> components.unregisterAdapter(tests.A12_1, required=[tests.U])
False
The factory can be omitted, to unregister *any* factory that matches
specified required and provided interfaces:
>>> components.unregisterAdapter(required=[tests.U], provided=tests.IA3)
... # doctest: +NORMALIZE_WHITESPACE
Unregistered event:
AdapterRegistration(<Components comps>, [zope.component.tests.U],
IA3, u'', A_3, 'Really class specific')
True
>>> for registration in sorted(components.registeredAdapters()):
... print registration
Adapters can be named:
>>> components.registerAdapter(tests.A1_12, provided=tests.IA2,
... name=u'test')
Registered event:
AdapterRegistration(<Components comps>, [I1], IA2, u'test', A1_12, u'')
>>> components.queryMultiAdapter((tests.U1(9), ), tests.IA2)
>>> components.queryMultiAdapter((tests.U1(9), ), tests.IA2, name=u'test')
A1_12(U1(9))
>>> components.queryAdapter(tests.U1(9), tests.IA2)
>>> components.queryAdapter(tests.U1(9), tests.IA2, name=u'test')
A1_12(U1(9))
>>> components.getAdapter(tests.U1(9), tests.IA2, name=u'test')
A1_12(U1(9))
It is possible to look up all of the adapters that provide an
interface:
>>> components.registerAdapter(tests.A1_23, provided=tests.IA2,
... name=u'test 2')
Registered event:
AdapterRegistration(<Components comps>, [I1], IA2, u'test 2', A1_23, u'')
>>> components.registerAdapter(tests.A1_12, provided=tests.IA2)
Registered event:
AdapterRegistration(<Components comps>, [I1], IA2, u'', A1_12, u'')
>>> for name, adapter in sorted(components.getAdapters((tests.U1(9), ),
... tests.IA2)):
... print name, adapter
A1_12(U1(9))
test A1_12(U1(9))
test 2 A1_23(U1(9))
getAdapters is most commonly used as the basis of menu systems.
If an adapter factory returns None, it is equivalent to there being no
factory:
>>> components.registerAdapter(tests.noop,
... required=[tests.IA1], provided=tests.IA2,
... name=u'test noop')
... # doctest: +NORMALIZE_WHITESPACE
Registered event:
AdapterRegistration(<Components comps>, [IA1], IA2, u'test noop',
noop, u'')
>>> components.queryAdapter(tests.U1(9), tests.IA2, name=u'test noop')
>>> components.registerAdapter(tests.A1_12, provided=tests.IA2)
Registered event:
AdapterRegistration(<Components comps>, [I1], IA2, u'', A1_12, u'')
>>> for name, adapter in sorted(components.getAdapters((tests.U1(9), ),
... tests.IA2)):
... print name, adapter
A1_12(U1(9))
test A1_12(U1(9))
test 2 A1_23(U1(9))
>>> components.unregisterAdapter(tests.A1_12, provided=tests.IA2,
... name=u'test')
Unregistered event:
AdapterRegistration(<Components comps>, [I1], IA2, u'test', A1_12, u'')
True
>>> components.unregisterAdapter(tests.A1_12, provided=tests.IA2)
Unregistered event:
AdapterRegistration(<Components comps>, [I1], IA2, u'', A1_12, u'')
True
>>> for registration in sorted(components.registeredAdapters()):
... print registration.required
... print registration.provided, registration.name
... print registration.factory, registration.info
... # doctest: +NORMALIZE_WHITESPACE
(<InterfaceClass zope.component.tests.I1>,)
<InterfaceClass zope.component.tests.IA2> test 2
zope.component.tests.A1_23
(<InterfaceClass zope.component.tests.IA1>,)
<InterfaceClass zope.component.tests.IA2> test noop
<function noop at 0xb79a1064>
Subscribers
-----------
Subscribers provide a way to get multiple adapters of a given type.
In this regard, subscribers are like named adapters, except that there
isn't any concept of the most specific adapter for a given name.
Subscribers are registered by calling registerSubscriptionAdapter:
>>> components.registerSubscriptionAdapter(tests.A1_2)
... # doctest: +NORMALIZE_WHITESPACE
Registered event:
SubscriptionRegistration(<Components comps>, [I1], IA2, u'', A1_2, u'')
>>> components.registerSubscriptionAdapter(
... tests.A1_12, provided=tests.IA2)
... # doctest: +NORMALIZE_WHITESPACE
Registered event:
SubscriptionRegistration(<Components comps>, [I1], IA2, u'', A1_12, u'')
>>> components.registerSubscriptionAdapter(
... tests.A, [tests.I1], tests.IA2,
... info='a sample comment')
... # doctest: +NORMALIZE_WHITESPACE
Registered event:
SubscriptionRegistration(<Components comps>, [I1], IA2, u'',
A, 'a sample comment')
The same rules, with regard to when required and provided interfaces
have to be specified apply as with adapters:
>>> components.registerSubscriptionAdapter(tests.A1_12)
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
TypeError: The adapter factory doesn't implement a single
interface and no provided interface was specified.
>>> components.registerSubscriptionAdapter(tests.A)
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
TypeError: The adapter factory doesn't implement a single interface and
no provided interface was specified.
>>> components.registerSubscriptionAdapter(tests.A, required=[tests.IA1])
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
TypeError: The adapter factory doesn't implement a single interface
and no provided interface was specified.
Note that we provided the info argument as a keyword argument above.
That's because there is a name argument that's reserved for future
use. We can give a name, as long as it is an empty string:
>>> components.registerSubscriptionAdapter(
... tests.A, [tests.I1], tests.IA2, u'', 'a sample comment')
... # doctest: +NORMALIZE_WHITESPACE
Registered event:
SubscriptionRegistration(<Components comps>, [I1], IA2, u'',
A, 'a sample comment')
>>> components.registerSubscriptionAdapter(
... tests.A, [tests.I1], tests.IA2, u'oops', 'a sample comment')
Traceback (most recent call last):
...
TypeError: Named subscribers are not yet supported
Subscribers are looked up using the subscribers method:
>>> for s in components.subscribers((tests.U1(1), ), tests.IA2):
... print s
A1_2(U1(1))
A1_12(U1(1))
A(U1(1),)
A(U1(1),)
Note that, because we created multiple subscriptions for A, we got multiple
subscriber instances.
As with normal adapters, if a factory returns None, the result is skipped:
>>> components.registerSubscriptionAdapter(
... tests.noop, [tests.I1], tests.IA2)
Registered event:
SubscriptionRegistration(<Components comps>, [I1], IA2, u'', noop, u'')
>>> for s in components.subscribers((tests.U1(1), ), tests.IA2):
... print s
A1_2(U1(1))
A1_12(U1(1))
A(U1(1),)
A(U1(1),)
We can get registration information for subscriptions:
>>> for registration in sorted(
... components.registeredSubscriptionAdapters()):
... print registration.required
... print registration.provided, registration.name
... print registration.factory, registration.info
(<InterfaceClass zope.component.tests.I1>,)
<InterfaceClass zope.component.tests.IA2>
zope.component.tests.A a sample comment
(<InterfaceClass zope.component.tests.I1>,)
<InterfaceClass zope.component.tests.IA2>
zope.component.tests.A a sample comment
(<InterfaceClass zope.component.tests.I1>,)
<InterfaceClass zope.component.tests.IA2>
zope.component.tests.A1_12
(<InterfaceClass zope.component.tests.I1>,)
<InterfaceClass zope.component.tests.IA2>
zope.component.tests.A1_2
(<InterfaceClass zope.component.tests.I1>,)
<InterfaceClass zope.component.tests.IA2>
<function noop at 0xb796ff7c>
We can also unregister subscriptions in much the same way we can for adapters:
>>> components.unregisterSubscriptionAdapter(tests.A1_2)
... # doctest: +NORMALIZE_WHITESPACE
Unregistered event:
SubscriptionRegistration(<Components comps>, [I1], IA2, u'', A1_2, '')
True
>>> for s in components.subscribers((tests.U1(1), ), tests.IA2):
... print s
A1_12(U1(1))
A(U1(1),)
A(U1(1),)
>>> for registration in sorted(
... components.registeredSubscriptionAdapters()):
... print registration.required
... print registration.provided, registration.name
... print registration.factory, registration.info
(<InterfaceClass zope.component.tests.I1>,)
<InterfaceClass zope.component.tests.IA2>
zope.component.tests.A a sample comment
(<InterfaceClass zope.component.tests.I1>,)
<InterfaceClass zope.component.tests.IA2>
zope.component.tests.A a sample comment
(<InterfaceClass zope.component.tests.I1>,)
<InterfaceClass zope.component.tests.IA2>
zope.component.tests.A1_12
(<InterfaceClass zope.component.tests.I1>,)
<InterfaceClass zope.component.tests.IA2>
<function noop at 0xb796ff7c>
>>> components.unregisterSubscriptionAdapter(
... tests.A, [tests.I1], tests.IA2)
Unregistered event:
SubscriptionRegistration(<Components comps>, [I1], IA2, u'', A, '')
True
>>> for s in components.subscribers((tests.U1(1), ), tests.IA2):
... print s
A1_12(U1(1))
>>> for registration in sorted(
... components.registeredSubscriptionAdapters()):
... print registration.required
... print registration.provided, registration.name
... print registration.factory, registration.info
(<InterfaceClass zope.component.tests.I1>,)
<InterfaceClass zope.component.tests.IA2>
zope.component.tests.A1_12
(<InterfaceClass zope.component.tests.I1>,)
<InterfaceClass zope.component.tests.IA2>
<function noop at 0xb796ff7c>
Note here that both registrations for A were removed.
If we omit the factory, we must specify the required and provided interfaces:
>>> components.unregisterSubscriptionAdapter(required=[tests.I1])
Traceback (most recent call last):
...
TypeError: Must specify one of factory and provided
>>> components.unregisterSubscriptionAdapter(provided=tests.IA2)
Traceback (most recent call last):
...
TypeError: Must specify one of factory and required
>>> components.unregisterSubscriptionAdapter(
... required=[tests.I1], provided=tests.IA2)
Unregistered event:
SubscriptionRegistration(<Components comps>, [I1], IA2, u'', None, '')
True
>>> for s in components.subscribers((tests.U1(1), ), tests.IA2):
... print s
>>> for registration in sorted(
... components.registeredSubscriptionAdapters()):
... print registration.factory
As when registering, an error is raised if the registration
information can't be determined from the factory and isn't specified:
>>> components.unregisterSubscriptionAdapter(tests.A1_12)
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
TypeError: The adapter factory doesn't implement a single
interface and no provided interface was specified.
>>> components.unregisterSubscriptionAdapter(tests.A)
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
TypeError: The adapter factory doesn't implement a single interface and
no provided interface was specified.
>>> components.unregisterSubscriptionAdapter(tests.A, required=[tests.IA1])
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
TypeError: The adapter factory doesn't implement a single interface
and no provided interface was specified.
If you unregister something that's not registered, nothing will be
changed and False will be returned:
>>> components.unregisterSubscriptionAdapter(
... required=[tests.I1], provided=tests.IA2)
False
Handlers
--------
Handlers are used when you want to perform some function in response
to an event. Handlers aren't expected to return anything when called
and are not registered to provide any interface.
>>> from zope import component
>>> @component.adapter(tests.I1)
... def handle1(x):
... print 'handle1', x
>>> components.registerHandler(handle1, info="First handler")
... # doctest: +NORMALIZE_WHITESPACE
Registered event:
HandlerRegistration(<Components comps>, [I1], u'',
handle1, 'First handler')
>>> components.handle(tests.U1(1))
handle1 U1(1)
>>> @component.adapter(tests.I1, tests.I2)
... def handle12(x, y):
... print 'handle12', x, y
>>> components.registerHandler(handle12)
Registered event:
HandlerRegistration(<Components comps>, [I1, I2], u'', handle12, u'')
>>> components.handle(tests.U1(1), tests.U12(2))
handle12 U1(1) U12(2)
If a handler doesn't document interfaces it handles, then
the required interfaces must be specified:
>>> def handle(*objects):
... print 'handle', objects
>>> components.registerHandler(handle)
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
TypeError: The adapter factory doesn't have a __component_adapts__
attribute and no required specifications were specified
>>> components.registerHandler(handle, required=[tests.I1],
... info="a comment")
Registered event:
HandlerRegistration(<Components comps>, [I1], u'', handle, 'a comment')
Handlers can also be registered for classes:
>>> components.registerHandler(handle, required=[tests.U],
... info="handle a class")
... # doctest: +NORMALIZE_WHITESPACE
Registered event:
HandlerRegistration(<Components comps>, [zope.component.tests.U], u'',
handle, 'handle a class')
>>> components.handle(tests.U1(1))
handle (U1(1),)
handle1 U1(1)
handle (U1(1),)
We can list the handler registrations:
>>> for registration in components.registeredHandlers():
... print registration.required
... print registration.handler, registration.info
... # doctest: +NORMALIZE_WHITESPACE
(<InterfaceClass zope.component.tests.I1>,)
<function handle1 at 0xb78f5bfc> First handler
(<InterfaceClass zope.component.tests.I1>,
<InterfaceClass zope.component.tests.I2>)
<function handle12 at 0xb78f5c34>
(<InterfaceClass zope.component.tests.I1>,)
<function handle at 0xb78f5ca4> a comment
(<implementedBy zope.component.tests.U>,)
<function handle at 0xb78f5ca4> handle a class
and we can unregister handlers:
>>> components.unregisterHandler(required=[tests.U])
... # doctest: +NORMALIZE_WHITESPACE
Unregistered event:
HandlerRegistration(<Components comps>, [zope.component.tests.U], u'',
None, '')
True
>>> for registration in components.registeredHandlers():
... print registration.required
... print registration.handler, registration.info
... # doctest: +NORMALIZE_WHITESPACE
(<InterfaceClass zope.component.tests.I1>,)
<function handle1 at 0xb78f5bfc> First handler
(<InterfaceClass zope.component.tests.I1>,
<InterfaceClass zope.component.tests.I2>)
<function handle12 at 0xb78f5c34>
(<InterfaceClass zope.component.tests.I1>,)
<function handle at 0xb78f5ca4> a comment
>>> components.unregisterHandler(handle12)
Unregistered event:
HandlerRegistration(<Components comps>, [I1, I2], u'', handle12, '')
True
>>> for registration in components.registeredHandlers():
... print registration.required
... print registration.handler, registration.info
(<InterfaceClass zope.component.tests.I1>,)
<function handle1 at 0xb78f5bfc> First handler
(<InterfaceClass zope.component.tests.I1>,)
<function handle at 0xb78f5ca4> a comment
>>> components.unregisterHandler(handle12)
False
>>> components.unregisterHandler()
Traceback (most recent call last):
...
TypeError: Must specify one of factory and required
>>> components.registerHandler(handle)
... # doctest: +NORMALIZE_WHITESPACE
Traceback (most recent call last):
...
TypeError: The adapter factory doesn't have a __component_adapts__
attribute and no required specifications were specified
Extending
---------
Component-management objects can extend other component-management
objects.
>>> c1 = registry.Components('1')
>>> c1.__bases__
()
>>> c2 = registry.Components('2', (c1, ))
>>> c2.__bases__ == (c1, )
True
>>> c1.registerUtility(tests.U1(1))
Registered event:
UtilityRegistration(<Components 1>, I1, u'', 1, None, u'')
>>> c1.queryUtility(tests.I1)
U1(1)
>>> c2.queryUtility(tests.I1)
U1(1)
>>> c1.registerUtility(tests.U1(2))
Unregistered event:
UtilityRegistration(<Components 1>, I1, u'', 1, None, u'')
Registered event:
UtilityRegistration(<Components 1>, I1, u'', 2, None, u'')
>>> c2.queryUtility(tests.I1)
U1(2)
We can use multiple inheritence:
>>> c3 = registry.Components('3', (c1, ))
>>> c4 = registry.Components('4', (c2, c3))
>>> c4.queryUtility(tests.I1)
U1(2)
>>> c1.registerUtility(tests.U12(1), tests.I2)
Registered event:
UtilityRegistration(<Components 1>, I2, u'', 1, None, u'')
>>> c4.queryUtility(tests.I2)
U12(1)
>>> c3.registerUtility(tests.U12(3), tests.I2)
Registered event:
UtilityRegistration(<Components 3>, I2, u'', 3, None, u'')
>>> c4.queryUtility(tests.I2)
U12(3)
>>> c1.registerHandler(handle1, info="First handler")
Registered event:
HandlerRegistration(<Components 1>, [I1], u'', handle1, 'First handler')
>>> c2.registerHandler(handle, required=[tests.U])
... # doctest: +NORMALIZE_WHITESPACE
Registered event:
HandlerRegistration(<Components 2>, [zope.component.tests.U], u'',
handle, u'')
>>> @component.adapter(tests.I1)
... def handle3(x):
... print 'handle3', x
>>> c3.registerHandler(handle3)
Registered event:
HandlerRegistration(<Components 3>, [I1], u'', handle3, u'')
>>> @component.adapter(tests.I1)
... def handle4(x):
... print 'handle4', x
>>> c4.registerHandler(handle4)
Registered event:
HandlerRegistration(<Components 4>, [I1], u'', handle4, u'')
>>> c4.handle(tests.U1(1))
handle1 U1(1)
handle3 U1(1)
handle (U1(1),)
handle4 U1(1)
Redispatch of registration events
---------------------------------
Some handlers are available that, if registered, redispatch
registration events to the objects being registered. They depend on
being dispatched to by the object-event dispatcher:
>>> from zope import component
>>> import zope.component.event
>>> zope.component.getGlobalSiteManager().registerHandler(
... zope.component.event.objectEventNotify)
... # doctest: +NORMALIZE_WHITESPACE
Registered event:
HandlerRegistration(<BaseGlobalComponents base>,
[IObjectEvent], u'', objectEventNotify, u'')
To see this, we'll first register a multi-handler to show is when
handlers are called on 2 objects:
>>> @zope.component.adapter(None, None)
... def double_handler(o1, o2):
... print 'Double dispatch:'
... print ' ', o1
... print ' ', o2
>>> zope.component.getGlobalSiteManager().registerHandler(double_handler)
... # doctest: +NORMALIZE_WHITESPACE
Double dispatch:
HandlerRegistration(<BaseGlobalComponents base>,
[Interface, Interface], u'', double_handler, u'')
Registered event:
HandlerRegistration(<BaseGlobalComponents base>,
[Interface, Interface], u'', double_handler, u'')
Registered event:
HandlerRegistration(<BaseGlobalComponents base>,
[Interface, Interface], u'', double_handler, u'')
In the example above, the double_handler reported it's own registration. :)
Now we'll register our handlers:
>>> zope.component.getGlobalSiteManager().registerHandler(
... registry.dispatchUtilityRegistrationEvent)
... # doctest: +NORMALIZE_WHITESPACE +ELLIPSIS
Double dispatch:
...
>>> zope.component.getGlobalSiteManager().registerHandler(
... registry.dispatchAdapterRegistrationEvent)
... # doctest: +NORMALIZE_WHITESPACE +ELLIPSIS
Double dispatch:
...
>>> zope.component.getGlobalSiteManager().registerHandler(
... registry.dispatchSubscriptionAdapterRegistrationEvent)
... # doctest: +NORMALIZE_WHITESPACE +ELLIPSIS
Double dispatch:
...
>>> zope.component.getGlobalSiteManager().registerHandler(
... registry.dispatchHandlerRegistrationEvent)
... # doctest: +NORMALIZE_WHITESPACE
Double dispatch:
HandlerRegistration(<BaseGlobalComponents base>,
[IHandlerRegistration, IRegistrationEvent], u'',
dispatchHandlerRegistrationEvent, u'')
Registered event:
HandlerRegistration(<BaseGlobalComponents base>,
[IHandlerRegistration, IRegistrationEvent], u'',
dispatchHandlerRegistrationEvent, u'')
Double dispatch:
<function dispatchHandlerRegistrationEvent at 0xb799f72c>
Registered event:
HandlerRegistration(<BaseGlobalComponents base>,
[IHandlerRegistration, IRegistrationEvent], u'',
dispatchHandlerRegistrationEvent, u'')
Registered event:
HandlerRegistration(<BaseGlobalComponents base>,
[IHandlerRegistration, IRegistrationEvent], u'',
dispatchHandlerRegistrationEvent, u'')
In the last example above, we can see that the registration of
dispatchHandlerRegistrationEvent was handled by
dispatchHandlerRegistrationEvent and redispatched. This can be seen
in the second double-dispatch output, where the first argument is the
object being registered, which is dispatchHandlerRegistrationEvent.
If we change some other registrations, we can the double dispatch
taking place:
>>> components.registerUtility(u5)
... # doctest: +NORMALIZE_WHITESPACE
Double dispatch:
UtilityRegistration(<Components comps>, I1, u'', 5, None, u'')
Registered event:
UtilityRegistration(<Components comps>, I1, u'', 5, None, u'')
Double dispatch:
U1(5)
Registered event:
UtilityRegistration(<Components comps>, I1, u'', 5, None, u'')
Registered event:
UtilityRegistration(<Components comps>, I1, u'', 5, None, u'')
>>> components.registerAdapter(tests.A12_1)
... # doctest: +NORMALIZE_WHITESPACE
Double dispatch:
AdapterRegistration(<Components comps>, [I1, I2], IA1, u'', A12_1, u'')
Registered event:
AdapterRegistration(<Components comps>, [I1, I2], IA1, u'', A12_1, u'')
Double dispatch:
zope.component.tests.A12_1
Registered event:
AdapterRegistration(<Components comps>, [I1, I2], IA1, u'', A12_1, u'')
Registered event:
AdapterRegistration(<Components comps>, [I1, I2], IA1, u'', A12_1, u'')
>>> components.registerSubscriptionAdapter(tests.A1_2)
... # doctest: +NORMALIZE_WHITESPACE
Double dispatch:
SubscriptionRegistration(<Components comps>, [I1], IA2, u'', A1_2, u'')
Registered event:
SubscriptionRegistration(<Components comps>, [I1], IA2, u'', A1_2, u'')
Double dispatch:
zope.component.tests.A1_2
Registered event:
SubscriptionRegistration(<Components comps>, [I1], IA2, u'', A1_2, u'')
Registered event:
SubscriptionRegistration(<Components comps>, [I1], IA2, u'', A1_2, u'')
|