/usr/share/pyshared/zope/interface/README.ru.txt is in python-zope.interface 3.6.1-1ubuntu3.
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 | ==========
Интерфейсы
==========
.. contents::
Интерфейсы - это объекты специфицирующие (документирующие) внешнее поведение
объектов которые их "предоставляют". Интерфейсы определяют поведение через
следующие составляющие:
- Неформальную документацию в строках документации
- Определения атрибутов
- Инварианты - условия, которые должны соблюдаться для объектов предоставляющих
интерфейс
Определения атрибутов описывают конкретные атрибуты. Они определяют
имя атрибута и предоставляют документацию и ограничения для значений
атрибута. Определения атрибутов могут быть заданы несколькими путями
как мы увидим ниже.
Определение интерфейсов
=======================
Интерфейсы определяются с использованием ключевого слова class::
>>> import zope.interface
>>> class IFoo(zope.interface.Interface):
... """Foo blah blah"""
...
... x = zope.interface.Attribute("""X blah blah""")
...
... def bar(q, r=None):
... """bar blah blah"""
В примере выше мы создали интерфейс `IFoo`. Мы наследуем его от
класса `zope.interface.Interface`, который является родительским интерфейсом
для всех интерфейсов, как `object` - это родительский класс для всех новых
классов [#create]_. Данный интерфейс не является классом, а является
Интерфейсом, экземпляром `InterfaceClass`::
>>> type(IFoo)
<class 'zope.interface.interface.InterfaceClass'>
Мы можем запросить у интерфейса его документацию::
>>> IFoo.__doc__
'Foo blah blah'
и его имя::
>>> IFoo.__name__
'IFoo'
и даже модуль в котором он определен::
>>> IFoo.__module__
'__main__'
Наш интерфейс определяет два атрибута:
`x`
Это простейшая форма определения атрибутов. Определяются имя
и строка документации. Формально здесь не определяется ничего более.
`bar`
Это метод. Методы определяются как обычные функции. Метод - это просто
атрибут который должен быть вызываемым с указанием сигнатуры,
предоставляемой определением функции.
Надо отметить, что аргумент `self` не указывается для `bar`. Интерфейс
документирует как объект *используется*. Когда методы экземпляров классов
вызываются мы не передаем аргумент `self`, таким образом аргумент `self`
не включается и в сигнатуру интерфейса. Аргумент `self` в методах
экземпляров классов на самом деле деталь реализации экземпляров классов
в Python. Другие объекты кроме экземпляров классов могут предоставлять
интерфейсы и их методы могут не быть методами экземпляров классов. Для
примера модули могут предоставлять интерфейсы и их методы обычно просто
функции. Даже экземпляры могут иметь методы не являющиеся методами
экземпляров класса.
Мы можем получить доступ к атрибутам определенным интерфейсом используя
синтаксис доступа к элементам массива::
>>> x = IFoo['x']
>>> type(x)
<class 'zope.interface.interface.Attribute'>
>>> x.__name__
'x'
>>> x.__doc__
'X blah blah'
>>> IFoo.get('x').__name__
'x'
>>> IFoo.get('y')
Можно использовать `in` для определения содержит ли интерфейс
определенное имя::
>>> 'x' in IFoo
True
Мы можем использовать итератор для интерфейсов что бы получить все имена
которые интерфейсы определяют::
>>> names = list(IFoo)
>>> names.sort()
>>> names
['bar', 'x']
Надо помнить, что интерфейсы не являются классами. Мы не можем получить
доступ к определениям атрибутов через доступ к атрибутам интерфейсов::
>>> IFoo.x
Traceback (most recent call last):
File "<stdin>", line 1, in ?
AttributeError: 'InterfaceClass' object has no attribute 'x'
Методы также предоставляют доступ к сигнатуре метода::
>>> bar = IFoo['bar']
>>> bar.getSignatureString()
'(q, r=None)'
Объявление интерфейсов
======================
Определив интерфейс мы можем теперь *объявить*, что объекты предоставляют их.
Перед описанием деталей определим некоторые термины:
*предоставлять*
Мы говорим, что объекты *предоставляют* интерфейсы. Если объект
предоставляет интерфейс, тогда интерфейс специфицирует поведение объекта.
Другими словами, интерфейсы специфицируют поведение объектов которые
предоставляют их.
*реализовать*
Мы обычно говорим что классы *реализуют* интерфейсы. Если класс
реализует интерфейс, тогда экземпляры этого класса предоставляют
данный интерфейс. Объекты предоставляют интерфейсы которые их классы
реализуют [#factory]_. (Объекты также могут предоставлять интерфейсы напрямую
плюс к тем которые реализуют их классы.)
Важно помнить, что классы обычно не предоставляют интерфейсы которые
они реализуют.
Мы можем обобщить это до фабрик. Для любого вызываемого объекта мы можем
объявить что он производит объекты которые предоставляют какие-либо
интерфейсы сказав, что фабрика реализует данные интерфейсы.
Теперь после того как мы определили эти термины мы можем поговорить об
API для объявления интерфейсов.
Объявление реализуемых интерфейсов
----------------------------------
Наиболее часто используемый путь для объявления интерфейсов - это использование
функции implements в определении класса::
>>> class Foo:
... zope.interface.implements(IFoo)
...
... def __init__(self, x=None):
... self.x = x
...
... def bar(self, q, r=None):
... return q, r, self.x
...
... def __repr__(self):
... return "Foo(%s)" % self.x
В этом примере мы объявили, что `Foo` реализует `IFoo`. Это значит, что
экземпляры `Foo` предоставляют `IFoo`. После данного объявления есть
несколько путей для анализа объявлений. Во-первых мы можем спросить
что интерфейс реализован классом::
>>> IFoo.implementedBy(Foo)
True
Также мы можем спросить если интерфейс предоставляется объектами класса::
>>> foo = Foo()
>>> IFoo.providedBy(foo)
True
Конечно `Foo` не предоставляет `IFoo`, он реализует его::
>>> IFoo.providedBy(Foo)
False
Мы можем также узнать какие интерфейсы реализуются объектами::
>>> list(zope.interface.implementedBy(Foo))
[<InterfaceClass __main__.IFoo>]
Это ошибка спрашивать про интерфейсы реализуемые не вызываемым объектом::
>>> IFoo.implementedBy(foo)
Traceback (most recent call last):
...
TypeError: ('ImplementedBy called for non-factory', Foo(None))
>>> list(zope.interface.implementedBy(foo))
Traceback (most recent call last):
...
TypeError: ('ImplementedBy called for non-factory', Foo(None))
Также можно узнать какие интерфейсы предоставляются объектами::
>>> list(zope.interface.providedBy(foo))
[<InterfaceClass __main__.IFoo>]
>>> list(zope.interface.providedBy(Foo))
[]
Мы можем объявить интерфейсы реализуемые другими фабриками (кроме классов).
Это можно сделать используя декоратор `implementer` (в стиле Python 2.4).
Для версий Python ниже 2.4 это будет выглядеть следующим образом::
>>> def yfoo(y):
... foo = Foo()
... foo.y = y
... return foo
>>> yfoo = zope.interface.implementer(IFoo)(yfoo)
>>> list(zope.interface.implementedBy(yfoo))
[<InterfaceClass __main__.IFoo>]
Надо заметить, что декоратор implementer может модифицировать свои аргументы.
Вызывающая сторона не должна предполагать, что всегда будет создаваться
новый объект.
XXX: Double check and update these version numbers, and translate to russian:
In zope.interface 3.5.1 and lower, the implementor decorator can not
be used for classes, but in 3.5.2 and higher it can:
>>> Foo = zope.interface.implementer(IFoo)(Foo)
>>> list(zope.interface.providedBy(Foo()))
[<InterfaceClass __main__.IFoo>]
Note that class decorators using the @implementor(IFoo) syntax are only
supported in Python 2.6 and later.
Объявление предоставляемых интерфейсов
--------------------------------------
Мы можем объявлять интерфейсы напрямую предоставляемые объектами. Предположим
что мы хотим документировать что делает метод `__init__` класса `Foo`. Это
*точно* не часть `IFoo`. Обычно мы не должны напрямую вызывать метод `__init__`
для экземпляров Foo. Скорее метод `__init__` является частью метода `__call__`
класса `Foo`::
>>> class IFooFactory(zope.interface.Interface):
... """Create foos"""
...
... def __call__(x=None):
... """Create a foo
...
... The argument provides the initial value for x ...
... """
У нас есть класс предоставляющий данный интерфейс, таким образом мы можем
объявить интерфейс класса::
>>> zope.interface.directlyProvides(Foo, IFooFactory)
Теперь мы видим, что Foo уже предоставляет интерфейсы::
>>> list(zope.interface.providedBy(Foo))
[<InterfaceClass __main__.IFooFactory>]
>>> IFooFactory.providedBy(Foo)
True
Объявление интерфейсов класса достаточно частая операция и для нее есть
специальная функция объявления `classProvides`, которая позволяет объявлять
интерфейсы при определении класса::
>>> class Foo2:
... zope.interface.implements(IFoo)
... zope.interface.classProvides(IFooFactory)
...
... def __init__(self, x=None):
... self.x = x
...
... def bar(self, q, r=None):
... return q, r, self.x
...
... def __repr__(self):
... return "Foo(%s)" % self.x
>>> list(zope.interface.providedBy(Foo2))
[<InterfaceClass __main__.IFooFactory>]
>>> IFooFactory.providedBy(Foo2)
True
Похожая функция `moduleProvides` поддерживает объявление интерфейсов при
определении модуля. Для примера смотрите использование вызова
`moduleProvides` в `zope.interface.__init__`, который объявляет, что
пакет `zope.interface` предоставляет `IInterfaceDeclaration`.
Иногда мы хотим объявить интерфейсы экземпляров, даже если эти экземпляры
уже берут интерфейсы от своих классов. Предположим, что мы создаем новый
интерфейс `ISpecial`::
>>> class ISpecial(zope.interface.Interface):
... reason = zope.interface.Attribute("Reason why we're special")
... def brag():
... "Brag about being special"
Мы можем сделать созданный экземпляр foo специальным предоставив атрибуты
`reason` и `brag`::
>>> foo.reason = 'I just am'
>>> def brag():
... return "I'm special!"
>>> foo.brag = brag
>>> foo.reason
'I just am'
>>> foo.brag()
"I'm special!"
и объявив интерфейс::
>>> zope.interface.directlyProvides(foo, ISpecial)
таким образом новый интерфейс включается в список предоставляемых интерфейсов::
>>> ISpecial.providedBy(foo)
True
>>> list(zope.interface.providedBy(foo))
[<InterfaceClass __main__.ISpecial>, <InterfaceClass __main__.IFoo>]
Мы также можем определить, что интерфейсы напрямую предоставляются
объектами::
>>> list(zope.interface.directlyProvidedBy(foo))
[<InterfaceClass __main__.ISpecial>]
>>> newfoo = Foo()
>>> list(zope.interface.directlyProvidedBy(newfoo))
[]
Наследуемые объявления
----------------------
Обычно объявления наследуются::
>>> class SpecialFoo(Foo):
... zope.interface.implements(ISpecial)
... reason = 'I just am'
... def brag(self):
... return "I'm special because %s" % self.reason
>>> list(zope.interface.implementedBy(SpecialFoo))
[<InterfaceClass __main__.ISpecial>, <InterfaceClass __main__.IFoo>]
>>> list(zope.interface.providedBy(SpecialFoo()))
[<InterfaceClass __main__.ISpecial>, <InterfaceClass __main__.IFoo>]
Иногда мы не хотим наследовать объявления. В этом случае мы можем
использовать `implementsOnly` вместо `implements`::
>>> class Special(Foo):
... zope.interface.implementsOnly(ISpecial)
... reason = 'I just am'
... def brag(self):
... return "I'm special because %s" % self.reason
>>> list(zope.interface.implementedBy(Special))
[<InterfaceClass __main__.ISpecial>]
>>> list(zope.interface.providedBy(Special()))
[<InterfaceClass __main__.ISpecial>]
Внешние объявления
------------------
Обычно мы создаем объявления реализации как часть объявления класса. Иногда
мы можем захотеть создать объявления вне объявления класса. Для примера,
мы можем хотеть объявить интерфейсы для классов которые писали не мы.
Для этого может использоваться функция `classImplements`::
>>> class C:
... pass
>>> zope.interface.classImplements(C, IFoo)
>>> list(zope.interface.implementedBy(C))
[<InterfaceClass __main__.IFoo>]
Мы можем использовать `classImplementsOnly` для исключения наследуемых
интерфейсов::
>>> class C(Foo):
... pass
>>> zope.interface.classImplementsOnly(C, ISpecial)
>>> list(zope.interface.implementedBy(C))
[<InterfaceClass __main__.ISpecial>]
Объекты объявлений
------------------
Когда мы объявляем интерфейсы мы создаем объект *объявления*. Когда мы
запрашиваем объявления возвращается объект объявления::
>>> type(zope.interface.implementedBy(Special))
<class 'zope.interface.declarations.Implements'>
Объекты объявления и объекты интерфейсов во многом похожи друг на друга.
На самом деле они даже имеют общий базовый класс. Важно понять, что они могут
использоваться там где в объявлениях ожидаются интерфейсы. Вот простой
пример::
>>> class Special2(Foo):
... zope.interface.implementsOnly(
... zope.interface.implementedBy(Foo),
... ISpecial,
... )
... reason = 'I just am'
... def brag(self):
... return "I'm special because %s" % self.reason
Объявление здесь практически такое же как
``zope.interface.implements(ISpecial)``, отличие только в порядке
интерфейсов в итоговом объявления::
>>> list(zope.interface.implementedBy(Special2))
[<InterfaceClass __main__.IFoo>, <InterfaceClass __main__.ISpecial>]
Наследование интерфейсов
========================
Интерфейсы могут расширять другие интерфейсы. Они делают это просто
показывая эти интерфейсы как базовые::
>>> class IBlat(zope.interface.Interface):
... """Blat blah blah"""
...
... y = zope.interface.Attribute("y blah blah")
... def eek():
... """eek blah blah"""
>>> IBlat.__bases__
(<InterfaceClass zope.interface.Interface>,)
>>> class IBaz(IFoo, IBlat):
... """Baz blah"""
... def eek(a=1):
... """eek in baz blah"""
...
>>> IBaz.__bases__
(<InterfaceClass __main__.IFoo>, <InterfaceClass __main__.IBlat>)
>>> names = list(IBaz)
>>> names.sort()
>>> names
['bar', 'eek', 'x', 'y']
Заметим, что `IBaz` переопределяет eek::
>>> IBlat['eek'].__doc__
'eek blah blah'
>>> IBaz['eek'].__doc__
'eek in baz blah'
Мы были осторожны переопределяя eek совместимым путем. Когда интерфейс
расширяется, расширенный интерфейс должен быть совместимым [#compat]_ с
расширяемыми интерфейсами.
Мы можем запросить расширяет ли один из интерфейсов другой::
>>> IBaz.extends(IFoo)
True
>>> IBlat.extends(IFoo)
False
Заметим, что интерфейсы не расширяют сами себя::
>>> IBaz.extends(IBaz)
False
Иногда мы можем хотеть что бы они расширяли сами себя, но вместо этого
мы можем использовать `isOrExtends`::
>>> IBaz.isOrExtends(IBaz)
True
>>> IBaz.isOrExtends(IFoo)
True
>>> IFoo.isOrExtends(IBaz)
False
Когда мы применяем итерацию к интерфейсу мы получаем все имена которые он
определяет включая имена определенные для базовых интерфейсов. Иногда
мы хотим получить *только* имена определенные интерфейсом напрямую.
Для этого мы используем метод `names`::
>>> list(IBaz.names())
['eek']
Наследование в случае определения атрибутов
--------------------------------------------
Интерфейс может переопределять определения атрибутов из базовых интерфейсов.
Если два базовых интерфейса определяют один и тот же атрибут атрибут
наследуется от более специфичного интерфейса. Для примера::
>>> class IBase(zope.interface.Interface):
...
... def foo():
... "base foo doc"
>>> class IBase1(IBase):
... pass
>>> class IBase2(IBase):
...
... def foo():
... "base2 foo doc"
>>> class ISub(IBase1, IBase2):
... pass
Определение ISub для foo будет из IBase2 т.к. IBase2 более специфичен для
IBase::
>>> ISub['foo'].__doc__
'base2 foo doc'
Заметим, что это отличается от поиска в глубину.
Иногда полезно узнать, что интерфейс определяет атрибут напрямую. Мы можем
использовать метод direct для получения напрямую определенных атрибутов::
>>> IBase.direct('foo').__doc__
'base foo doc'
>>> ISub.direct('foo')
Спецификации
------------
Интерфейсы и объявления - это специальные случаи спецификаций. Описание
выше для наследования интерфейсов можно применить и к объявлениям и
к спецификациям. Объявления фактически расширяют интерфейсы которые они
объявляют::
>>> class Baz(object):
... zope.interface.implements(IBaz)
>>> baz_implements = zope.interface.implementedBy(Baz)
>>> baz_implements.__bases__
(<InterfaceClass __main__.IBaz>, <implementedBy ...object>)
>>> baz_implements.extends(IFoo)
True
>>> baz_implements.isOrExtends(IFoo)
True
>>> baz_implements.isOrExtends(baz_implements)
True
Спецификации (интерфейсы и объявления) предоставляют атрибут `__sro__`
который описывает спецификацию и всех ее предков::
>>> baz_implements.__sro__
(<implementedBy __main__.Baz>,
<InterfaceClass __main__.IBaz>,
<InterfaceClass __main__.IFoo>,
<InterfaceClass __main__.IBlat>,
<InterfaceClass zope.interface.Interface>,
<implementedBy ...object>)
Помеченные значения
===================
Интерфейсы и описания атрибутов поддерживают механизм расширения
заимствованный из UML и называемый "помеченные значения" который позволяет
сохранять дополнительные данные::
>>> IFoo.setTaggedValue('date-modified', '2004-04-01')
>>> IFoo.setTaggedValue('author', 'Jim Fulton')
>>> IFoo.getTaggedValue('date-modified')
'2004-04-01'
>>> IFoo.queryTaggedValue('date-modified')
'2004-04-01'
>>> IFoo.queryTaggedValue('datemodified')
>>> tags = list(IFoo.getTaggedValueTags())
>>> tags.sort()
>>> tags
['author', 'date-modified']
Атрибуты функций конвертируются в помеченные значения когда создаются
определения атрибутов метода::
>>> class IBazFactory(zope.interface.Interface):
... def __call__():
... "create one"
... __call__.return_type = IBaz
>>> IBazFactory['__call__'].getTaggedValue('return_type')
<InterfaceClass __main__.IBaz>
Помеченные значения также могут быть определены внутри определения
интерфейса::
>>> class IWithTaggedValues(zope.interface.Interface):
... zope.interface.taggedValue('squish', 'squash')
>>> IWithTaggedValues.getTaggedValue('squish')
'squash'
Инварианты
==========
Интерфейсы могут описывать условия которые должны быть соблюдены для объектов
которые их предоставляют. Эти условия описываются используя один или более
инвариантов. Инварианты - это вызываемые объекты которые будут вызваны
с объектом предоставляющим интерфейс в качестве параметра. Инвариант
должен выкинуть исключение `Invalid` если условие не соблюдено. Например::
>>> class RangeError(zope.interface.Invalid):
... """A range has invalid limits"""
... def __repr__(self):
... return "RangeError(%r)" % self.args
>>> def range_invariant(ob):
... if ob.max < ob.min:
... raise RangeError(ob)
Определив этот инвариант мы можем использовать его в определении интерфейсов::
>>> class IRange(zope.interface.Interface):
... min = zope.interface.Attribute("Lower bound")
... max = zope.interface.Attribute("Upper bound")
...
... zope.interface.invariant(range_invariant)
Интерфейсы имеют метод для проверки своих инвариантов::
>>> class Range(object):
... zope.interface.implements(IRange)
...
... def __init__(self, min, max):
... self.min, self.max = min, max
...
... def __repr__(self):
... return "Range(%s, %s)" % (self.min, self.max)
>>> IRange.validateInvariants(Range(1,2))
>>> IRange.validateInvariants(Range(1,1))
>>> IRange.validateInvariants(Range(2,1))
Traceback (most recent call last):
...
RangeError: Range(2, 1)
В случае нескольких инвариантов мы можем захотеть остановить проверку после
первой ошибки. Если мы передадим в `validateInvariants` пустой список тогда
будет выкинуто единственное исключение `Invalid` со списком исключений
как аргументом::
>>> from zope.interface.exceptions import Invalid
>>> errors = []
>>> try:
... IRange.validateInvariants(Range(2,1), errors)
... except Invalid, e:
... str(e)
'[RangeError(Range(2, 1))]'
И список будет заполнен индивидуальными исключениями::
>>> errors
[RangeError(Range(2, 1))]
>>> del errors[:]
Адаптация
=========
Интерфейсы могут быть вызваны для осуществления адаптации. Эта семантика
основана на функции adapt из PEP 246. Если объект не может быть адаптирован
будет выкинут TypeError::
>>> class I(zope.interface.Interface):
... pass
>>> I(0)
Traceback (most recent call last):
...
TypeError: ('Could not adapt', 0, <InterfaceClass __main__.I>)
только если альтернативное значение не передано как второй аргумент::
>>> I(0, 'bob')
'bob'
Если объект уже реализует нужный интерфейс он будет возвращен::
>>> class C(object):
... zope.interface.implements(I)
>>> obj = C()
>>> I(obj) is obj
True
Если объект реализует __conform__, тогда она будет использована::
>>> class C(object):
... zope.interface.implements(I)
... def __conform__(self, proto):
... return 0
>>> I(C())
0
Также если присутствуют функции для вызова адаптации (см. __adapt__) они будут
использованы::
>>> from zope.interface.interface import adapter_hooks
>>> def adapt_0_to_42(iface, obj):
... if obj == 0:
... return 42
>>> adapter_hooks.append(adapt_0_to_42)
>>> I(0)
42
>>> adapter_hooks.remove(adapt_0_to_42)
>>> I(0)
Traceback (most recent call last):
...
TypeError: ('Could not adapt', 0, <InterfaceClass __main__.I>)
__adapt__
---------
>>> class I(zope.interface.Interface):
... pass
Интерфейсы реализуют метод __adapt__ из PEP 246. Этот метод обычно не
вызывается напрямую. Он вызывается архитектурой адаптации из PEP 246 и методом
__call__ интерфейсов. Метод адаптации отвечает за адаптацию объекта к
получателю. Версия по умолчанию возвращает None::
>>> I.__adapt__(0)
если только переданный объект не предоставляет нужный интерфейс::
>>> class C(object):
... zope.interface.implements(I)
>>> obj = C()
>>> I.__adapt__(obj) is obj
True
Функции для вызова адаптации могут быть добавлены (или удалены) для
предоставления адаптации "на заказ". Мы установим глупую функцию которая
адаптирует 0 к 42. Мы устанавливаем функцию просто добавляя ее к списку
adapter_hooks::
>>> from zope.interface.interface import adapter_hooks
>>> def adapt_0_to_42(iface, obj):
... if obj == 0:
... return 42
>>> adapter_hooks.append(adapt_0_to_42)
>>> I.__adapt__(0)
42
Функции должны возвращать либо адаптер, либо None если адаптер не найден.
Функции могут быть удалены удалением их из списка::
>>> adapter_hooks.remove(adapt_0_to_42)
>>> I.__adapt__(0)
.. [#create] Основная причина по которой мы наследуемся от `Interface` - это
что бы быть уверенными в том, что ключевое слово class будет
создавать интерфейс, а не класс.
Есть возможность создать интерфейсы вызвав специальный
класс интерфейса напрямую. Делая это, возможно (и в редких
случаях полезно) создать интерфейсы которые не наследуются
от `Interface`. Однако использование этой техники выходит
за рамки данного документа.
.. [#factory] Классы - это фабрики. Они могут быть вызваны для создания
своих экземпляров. Мы ожидаем что в итоге мы расширим
концепцию реализации на другие типы фабрик, таким образом
мы сможем объявлять интерфейсы предоставляемые созданными
фабриками объектами.
.. [#compat] Цель - заменяемость. Объект который предоставляет расширенный
интерфейс должен быть заменяем в качестве объектов которые
предоставляют расширяемый интерфейс. В нашем примере объект
который предоставляет IBaz должен быть используемым и
в случае если ожидается объект который предоставляет IBlat.
Реализация интерфейса не требует этого. Но возможно в дальнейшем
она должна будет делать какие-либо проверки.
|