U c6{i @sdZddlmZGdddeZGdddZGdddZGd d d ZGd d d eZ Gd ddeZ Gddde Z Gddde Z dS)zf Twisted Python Roots: an abstract hierarchy representation for Twisted. Maintainer: Glyph Lefkowitz )reflectc@seZdZdZdS)NotSupportedErrorzv An exception meaning that the tree-manipulation operation you're attempting to perform is not supported. N__name__ __module__ __qualname____doc__r r 8/tmp/pip-unpacked-wheel-hfbvu0bz/twisted/python/roots.pyrsrc@s$eZdZdZdZddZddZdS)RequestzI am an abstract representation of a request for an entity. I also function as the response. The request is responded to by calling self.write(data) until there is no data left and then calling self.finish(). NcCstdt|jdS)z.Add some data to the response to this request.z%s.writeNNotImplementedErrorrqual __class__)selfdatar r r write"sz Request.writecCstdt|jdS)zOThe response to this request is finished; flush all data to the network stream.z %s.finishNr rr r r finish&szRequest.finish)rrrrZ wireProtocolrrr r r r r s r c@seZdZdZddZdS)EntityaZI am a terminal object in a hierarchy, with no children. I represent a null interface; certain non-instance objects (strings and integers, notably) are Entities. Methods on this class are suggested to be implemented, but are not required, and will be emulated on a per-protocol basis for types which do not handle them. cCstdt|jdS)zw I produce a stream of bytes for the request, by calling request.write() and request.finish(). z %s.renderNr rrequestr r r render6sz Entity.renderN)rrrrrr r r r r+s rc@seZdZdZdddZddZddZd d Zd d Zd dZ ddZ ddZ ddZ ddZ ddZddZddZddZdS) CollectionzI represent a static collection of entities. I contain methods designed to represent collections that can be dynamically created. NcCs|dk r||_ni|_dS)zInitialize me.Nentities)rrr r r __init__EszCollection.__init__cCs |j|S)zqGet an entity that was added to me using putEntity. This method will return 'None' if it fails. )rgetrnamer r r getStaticEntityLszCollection.getStaticEntitycCsdS)znSubclass this to generate an entity on demand. This method should return 'None' if it fails. Nr rrrr r r getDynamicEntitySszCollection.getDynamicEntitycCs2||}|dk r|S|||}|dk r.|SdS)aRetrieve an entity from me. I will first attempt to retrieve an entity statically; static entities will obscure dynamic ones. If that fails, I will retrieve the entity dynamically. If I cannot retrieve an entity, I will return 'None'. N)r r")rrrentr r r getEntityYs  zCollection.getEntitycCs||j|<dS)zlStore a static reference on 'name' for 'entity'. Raises a KeyError if the operation fails. Nrrrentityr r r putEntityjszCollection.putEntitycCs |j|=dS)zaRemove a static reference for 'name'. Raises a KeyError if the operation fails. Nrrr r r delEntityqszCollection.delEntitycCstdt|jdS)z>Store an entity for 'name', based on the content of 'request'.z%s.storeEntityNrrrrr!r r r storeEntityxszCollection.storeEntitycCstdt|jdS)z?Remove an entity for 'name', based on the content of 'request'.z%s.removeEntityNr)r!r r r removeEntity|szCollection.removeEntitycCs |jS)zlRetrieve a list of all name, entity pairs that I store references to. See getStaticEntity. )ritemsrr r r listStaticEntitiesszCollection.listStaticEntitiescCsgS)zaA list of all name, entity that I can generate on demand. See getDynamicEntity. r rr r r listDynamicEntitiesszCollection.listDynamicEntitiescCs|||S)zURetrieve a list of all name, entity pairs I contain. See getEntity. )r-r.rr r r listEntitiesszCollection.listEntitiescCs |jS)zkRetrieve a list of the names of entities that I store references to. See getStaticEntity. )rkeysrr r r listStaticNamesszCollection.listStaticNamescCsgS)zlRetrieve a list of the names of entities that I store references to. See getDynamicEntity. r rr r r listDynamicNamesszCollection.listDynamicNamescCs|S)zZRetrieve a list of all names for entities that I contain. See getEntity. )r1rr r r listNamesszCollection.listNames)N)rrrrrr r"r$r'r(r*r+r-r.r/r1r2r3r r r r r>s rc@seZdZdZdS)ConstraintViolationz2An exception raised when a constraint is violated.Nrr r r r r4sr4c@s0eZdZdZddZddZddZdd Zd S) Constrainedz?A collection that has constraints on its names and/or entities.cCsdS)zA method that determines whether an entity may be added to me with a given name. If the constraint is satisfied, return 1; if the constraint is not satisfied, either return 0 or raise a descriptive ConstraintViolation. r rr r r nameConstraintszConstrained.nameConstraintcCsdS)zA method that determines whether an entity may be added to me. If the constraint is satisfied, return 1; if the constraint is not satisfied, either return 0 or raise a descriptive ConstraintViolation. r6r rr&r r r entityConstraintszConstrained.entityConstraintcCst|||dSN)rr'r%r r r reallyPutEntityszConstrained.reallyPutEntitycCs8||r,||r"|||q4tdntddS)zfStore an entity if it meets both constraints. Otherwise raise a ConstraintViolation. zEntity constraint violated.zName constraint violated.N)r7r9r;r4r%r r r r's    zConstrained.putEntityN)rrrrr7r9r;r'r r r r r5s r5c@s$eZdZdZdZddZddZdS)Lockedz5A collection that can be locked from adding entities.rcCs d|_dS)Nr6lockedrr r r locksz Locked.lockcCs|j Sr:r=r8r r r r9szLocked.entityConstraintN)rrrrr>r?r9r r r r r<sr<c@s,eZdZdZeZddZddZddZdS) HomogenouszA homogenous collection of entities. I will only contain entities that are an instance of the class or type specified by my 'entityType' attribute. cCs*t||jrdSt|d|jddS)Nr6z of incorrect type ()) isinstance entityTyper4r8r r r r9s zHomogenous.entityConstraintcCsdS)NNamer rr r r getNameTypeszHomogenous.getNameTypecCs|jjSr:)rCrrr r r getEntityTypeszHomogenous.getEntityTypeN) rrrrobjectrCr9rErFr r r r r@s r@N) rZtwisted.pythonrr rr rr Exceptionr4r5r<r@r r r r s m$