3
[e{ @ s d Z dZddlZddlmZ ddlmZ ddlmZ ddlZddlm Z ddl
m Z dd l
m Z dd
l
m
Z
dd lmZ dd lmZ i Zd
ZdZG dd deZG dd de
ZG dd deZdd Zdd ZeZdd Z dd Z d d Z G d d d eZ G d!d" d"eZ d#d$ Z!d%d& Z"d'd( Z#G d)d* d*eZ$e$Z%ej& Z'd+d* Z$d,e$_(d-d. Z)d/d0 Z*d1d2 Z+G d3d4 d4eZ,e,Z-e,Z.y ddl/Z0W n e1k
r Y nX dd5l/m.Z. G d6d7 d7ee.Z2d8d9 Z3d:d; Z4dd? d?eZ6d@dA Z7dBdC Z8dDdE Z9e9Z:dFdG Z;e;ZdPdJdKZ?e Z@y ddl/Z0W n e1k
rV Y n2X ddLl/mZ ddMl/mZ> e> ZAdS )Qa Implementation of interface declarations
There are three flavors of declarations:
- Declarations are used to simply name declared interfaces.
- ImplementsDeclarations are used to express the interfaces that a
class implements (that instances of the class provides).
Implements specifications support inheriting interfaces.
- ProvidesDeclarations are used to express interfaces directly
provided by objects.
Zrestructuredtext N) FunctionType)
MethodType)
ModuleType)addClassAdvisor)InterfaceClass)SpecificationBase)
Specification) CLASS_TYPES)PYTHON3zIClass advice impossible in Python3. Use the @%s class decorator instead.z\The %s API is deprecated, and will not work in Python3 Use the @%s class decorator instead.c @ s e Zd Zdd Zdd ZdS )namedc C s
|| _ d S )N)name)selfr r $/usr/lib64/python3.6/declarations.py__init__5 s znamed.__init__c C s | j |_|S )N)r Z__component_name__)r
obr r r __call__8 s znamed.__call__N)__name__
__module__ __qualname__r r r r r r r 3 s r c @ sL e Zd ZdZdd Zdd Zdd Zdd Zd
d Zd d
Z dd Z
e
Z dS ) DeclarationzInterface declarationsc G s t j| t| d S )N)r r _normalizeargs)r
interfacesr r r r ? s zDeclaration.__init__c C s. t j| | y| `W n tk
r( Y nX d S )N)r changedZ_v_attrsAttributeError)r
Zoriginally_changedr r r r B s
zDeclaration.changedc C s | j |o|| j kS )z:Test whether an interface is in the specification
)extendsr )r
interfacer r r __contains__I s zDeclaration.__contains__c C s | j S )zCReturn an iterator for the interfaces in the specification
)r )r
r r r __iter__O s zDeclaration.__iter__c C s
t | jS )zCReturn an iterator of all included and extended interfaces
)iterZ__iro__)r
r r r flattenedT s zDeclaration.flattenedc s t fdd| j D S )z/Remove interfaces from a specification
c s& g | ] fd dj D s qS )c s g | ]} j |d r|qS )r )r ).0j)ir r
^ s z2Declaration.__sub__...)r )r! )other)r# r r$ ] s z'Declaration.__sub__..)r r )r
r% r )r% r __sub__Y s zDeclaration.__sub__c C s` i }g }x"| j D ]}d||< |j| qW x*|j D ] }||kr6d||< |j| q6W t| S )zCAdd two specifications or a specification and an interface
)r appendr )r
r% seenresultr# r r r __add__c s zDeclaration.__add__N) r r r __doc__r r r r r r& r+ __radd__r r r r r < s
r c @ sd e Zd ZdZf ZdZ edd Zdd Zdd Zd d
Z d d Z
d
d Z dd Z dd Z
dd ZdS )
ImplementsN?c G s | j | }||_|j| |S )N)__new__r r )clsr r instr r r r s
zImplements.namedc C s
d| j S )Nz)r )r
r r r __repr__ s zImplements.__repr__c C s t | jffS )N)
implementedByinherit)r
r r r
__reduce__ s zImplements.__reduce__c C s@ |d kr dS | j | jf}t|ddt|ddf}||k||k S )Nr' r r )r r getattr)r
r% Zn1Zn2r r r Z__cmp s
zImplements.__cmpc C s
t j| S )N)r __hash__)r
r r r r: s zImplements.__hash__c C s | j |}|dk S )Nr )_Implements__cmp)r
r% cr r r __lt__ s
zImplements.__lt__c C s | j |}|dkS )Nr )r; )r
r% r< r r r __le__ s
zImplements.__le__c C s | j |}|dkS )Nr )r; )r
r% r< r r r __gt__ s
zImplements.__gt__c C s | j |}|dkS )Nr )r; )r
r% r< r r r __ge__ s
zImplements.__ge__)r r r r5 declared classmethodr r3 r6 r; r: r= r> r? r@ r r r r r. { s
r. c C s$ t | ddpdd t | ddp d S )Nr r/ .r )r9 )r r r r _implements_name s
rD c C s y| j jd}W nZ tk
rj t| dd}|dkrNtj| }|dk rJ|S tS |jtkr\|S tt |f S X t
|trz|S |dkrtj| }|dk r|S t | }|dk r|f}tj |ft | }d|_
| `nZy
| j}W n. tk
r t| std| f }Y nX tj |fdd |D }| |_
yL|| _t| dsBt| _t
| trrd| j krrt| t| dt| | _W n4 tk
r t
| tstd | |t| < Y nX |S )
zReturn the interfaces implemented for a class' instances
The value returned is an `~zope.interface.interfaces.IDeclaration`.
__implemented__Nz$ImplementedBy called for non-factoryc S s g | ] }t |qS r )r4 )r! r< r r r r$ s z)implementedByFallback..__providedBy__ __provides__ __class__z!ImplementedBy called for non-type)__dict__getr r9 #BuiltinImplementationSpecifications_emptyrH r. r r
isinstancerD r r5 rE __bases__callable TypeErrorhasattr objectSpecificationDescriptorrF DescriptorAwareMetaClasses
ClassProvidestyperG )r1 spec spec_namebasesr r r implementedByFallback s\
rY c G s& t | }f |_d|_t| f| dS )aQ Declare the only interfaces implemented by instances of a class
The arguments after the class are one or more interfaces or interface
specifications (`~zope.interface.interfaces.IDeclaration` objects).
The interfaces given (including the interfaces in the specifications)
replace any previous declarations.
N)r4 rA r5 classImplements)r1 r rV r r r classImplementsOnly- s r[ c G s t | }| jtt|7 _g }i }x(|jD ] }||kr.d||< |j| q.W |jdk rx2|jjD ]&}t |}||krdd||< |j| qdW t||_dS )ab Declare additional interfaces implemented for instances of a class
The arguments after the class are one or more interfaces or
interface specifications (`~zope.interface.interfaces.IDeclaration` objects).
The interfaces given (including the interfaces in the specifications)
are added to any interfaces previously declared.
r' N)r4 rA tupler r( r5 rN )r1 r rV rX r) br< r r r rZ ; s
rZ c C s$ | j d \}}| `|| f| | S )N__implements_advice_data__)rI r^ )r1 r rZ r r r _implements_adviceY s r_ c @ s e Zd ZdZdd Zdd ZdS ) implementera# Declare the interfaces implemented by instances of a class.
This function is called as a class decorator.
The arguments are one or more interfaces or interface
specifications (`~zope.interface.interfaces.IDeclaration` objects).
The interfaces given (including the interfaces in the
specifications) are added to any interfaces previously
declared.
Previous declarations include declarations for base classes
unless implementsOnly was used.
This function is provided for convenience. It provides a more
convenient way to call `classImplements`. For example::
@implementer(I1)
class C(object):
pass
is equivalent to calling::
classImplements(C, I1)
after the class has been created.
c G s
|| _ d S )N)r )r
r r r r r } s zimplementer.__init__c C sf t |tr t|f| j |S t|}tj|f| j }y
||_W n tk
r` t d|Y nX |S )NzCan't declare implements)
rM rS rZ r rD r. r rE r rP )r
r rW rV r r r r s
zimplementer.__call__N)r r r r, r r r r r r r` ` s r` c @ s e Zd ZdZdd Zdd ZdS )implementer_onlya Declare the only interfaces implemented by instances of a class
This function is called as a class decorator.
The arguments are one or more interfaces or interface
specifications (`~zope.interface.interfaces.IDeclaration` objects).
Previous declarations including declarations for base classes
are overridden.
This function is provided for convenience. It provides a more
convenient way to call `classImplementsOnly`. For example::
@implementer_only(I1)
class C(object): pass
is equivalent to calling::
classImplementsOnly(I1)
after the class has been created.
c G s
|| _ d S )N)r )r
r r r r r s zimplementer_only.__init__c C s0 t |ttfrtdnt|f| j |S d S )NzIThe implementer_only decorator is not supported for methods or functions.)rM r r
ValueErrorr[ r )r
r r r r r s
zimplementer_only.__call__N)r r r r, r r r r r r ra s ra c C s^ t jd}|j}||jks"d|kr.t| d d|krBt| d ||f|d< ttdd d S )N r z* can be used only from a class definition.r^ z- can be used only once in a class definition. )depth)sys _getframef_locals f_globalsrP r r_ )r r rZ framelocalsr r r _implements s
rl c G s t rttd td| t dS )a Declare interfaces implemented by instances of a class
This function is called in a class definition.
The arguments are one or more interfaces or interface
specifications (`~zope.interface.interfaces.IDeclaration` objects).
The interfaces given (including the interfaces in the
specifications) are added to any interfaces previously
declared.
Previous declarations include declarations for base classes
unless `implementsOnly` was used.
This function is provided for convenience. It provides a more
convenient way to call `classImplements`. For example::
implements(I1)
is equivalent to calling::
classImplements(C, I1)
after the class has been created.
r`
implementsN)r
rP
_ADVICE_ERRORrl rZ )r r r r rm s rm c G s t rttd td| t dS )ak Declare the only interfaces implemented by instances of a class
This function is called in a class definition.
The arguments are one or more interfaces or interface
specifications (`~zope.interface.interfaces.IDeclaration` objects).
Previous declarations including declarations for base classes
are overridden.
This function is provided for convenience. It provides a more
convenient way to call `classImplementsOnly`. For example::
implementsOnly(I1)
is equivalent to calling::
classImplementsOnly(I1)
after the class has been created.
ra implementsOnlyN)r
rP rn rl r[ )r r r r ro s ro c @ s, e Zd ZdZdd Zdd ZdZdd Zd S )
ProvideszImplement ``__provides__``, the instance-specific specification
When an object is pickled, we pickle the interfaces that it implements.
c G s0 |f| | _ || _tj| f|t|f d S )N)_Provides__args_clsr r r4 )r
r1 r r r r r s zProvides.__init__c C s
t | jfS )N)rp rq )r
r r r r6 s zProvides.__reduce__zzope.interfacec C s" |dkr|| j kr| S tddS )zHMake sure that a class __provides__ doesn't leak to an instance
NrG )rr r )r
r2 r1 r r r __get__ s zProvides.__get__N)r r r r, r r6 rs r r r r rp s
rp c G s& t j| }|dkr"t| }|t | < |S )zCache instance declarations
Instance declarations are shared among instances that have the same
declaration. The declarations are cached in a weak value dictionary.
N)InstanceDeclarationsrJ
ProvidesClass)r rV r r r rp ' s
Tc G s t | dd}|dk r6t |dd|kr6t| ts6tdt|}|dkrNt| }d}x tD ]}t||rXd}P qXW |rt| |f| | _nt |f| | _dS )aY Declare interfaces declared directly for an object
The arguments after the object are one or more interfaces or interface
specifications (`~zope.interface.interfaces.IDeclaration` objects).
The interfaces given (including the interfaces in the specifications)
replace interfaces previously declared for the object.
rH NzHAttempt to make an interface declaration on a non-descriptor-aware classFT)
r9 rM rS rP r rU
issubclassrT rG rp )objectr r1 ZissubZdamcr r r directlyProvides7 s
rx c G s t | t| f| dS )aZ Declare interfaces declared directly for an object
The arguments after the object are one or more interfaces or interface
specifications (`~zope.interface.interfaces.IDeclaration` objects).
The interfaces given (including the interfaces in the specifications) are
added to the interfaces previously declared for the object.
N)rx directlyProvidedBy)rw r r r r alsoProvides[ s rz c C s( t | t| | |j| r$tddS )z; Removes a directly provided interface from an object.
z-Can only remove directly provided interfaces.N)rx ry
providedByrb )rw r r r r noLongerProvidesf s
r| c @ s e Zd Zdd ZdS )ClassProvidesBaseFallbackc C s( || j kr |d kr| S | jS tdd S )NrG )rr rl r )r
r2 r1 r r r rs o s
z!ClassProvidesBaseFallback.__get__N)r r r rs r r r r r} m s r} )ClassProvidesBasec @ s& e Zd ZdZdd Zdd ZejZdS )rT zSpecial descriptor for class ``__provides__``
The descriptor caches the implementedBy info, so that
we can get declarations for objects without instance-specific
interfaces a bit quicker.
c G s< || _ t|| _||f| | _tj| f|t|f d S )N)rr r4 rl _ClassProvides__argsr r )r
r1 metaclsr r r r r s
zClassProvides.__init__c C s | j | jfS )N)rH r )r
r r r r6 s zClassProvides.__reduce__N)r r r r, r r6 r~ rs r r r r rT s rT c C s4 t | dd}|dks t|tr"tS t|jdd S )zReturn the interfaces directly provided by the given object
The value returned is an `~zope.interface.interfaces.IDeclaration`.
rG Nr' r8 )r9 rM r. rL r rN )rw providesr r r ry s
ry c G sf t rttd tjd}|j}||jks2d|kr:tdd|krJtdt| |d< tt dd d S )
a Declare interfaces provided directly by a class
This function is called in a class definition.
The arguments are one or more interfaces or interface specifications
(`~zope.interface.interfaces.IDeclaration` objects).
The given interfaces (including the interfaces in the specifications)
are used to create the class's direct-object interface specification.
An error will be raised if the module class has an direct interface
specification. In other words, it is an error to call this function more
than once in a class definition.
Note that the given interfaces have nothing to do with the interfaces
implemented by instances of the class.
This function is provided for convenience. It provides a more convenient
way to call `directlyProvides` for a class. For example::
classProvides(I1)
is equivalent to calling::
directlyProvides(theclass, I1)
after the class has been created.
providerr' r z7classProvides can be used only from a class definition.rG z:classProvides can only be used once in a class definition.rc )re N)
r
rP rn rf rg rh ri r r _classProvides_advice)r rj rk r r r
classProvides s
r c C s | j d }| `t| f| | S )NrG )rI rG rx )r1 r r r r r s
r c @ s e Zd ZdZdd Zdd ZdS )r z(Class decorator version of classProvidesc G s
|| _ d S )N)r )r
r r r r r s zprovider.__init__c C s t |f| j |S )N)rx r )r
r r r r r s zprovider.__call__N)r r r r, r r r r r r r s r c G sT t jd}|j}||jk s"d|kr*tdd|kr:tdttft| |d< dS )a Declare interfaces provided by a module
This function is used in a module definition.
The arguments are one or more interfaces or interface specifications
(`~zope.interface.interfaces.IDeclaration` objects).
The given interfaces (including the interfaces in the specifications) are
used to create the module's direct-object interface specification. An
error will be raised if the module already has an interface specification.
In other words, it is an error to call this function more than once in a
module definition.
This function is provided for convenience. It provides a more convenient
way to call directlyProvides. For example::
moduleImplements(I1)
is equivalent to::
directlyProvides(sys.modules[__name__], I1)
r' r z9moduleProvides can only be used from a module definition.rG z s ?O U -'
$ 2
,1