twisted.python.roots.Collection class documentation

Part of twisted.python.roots (View In Hierarchy)

Known subclasses: twisted.python.roots.Constrained

I represent a static collection of entities.

I contain methods designed to represent collections that can be dynamically created.

Method __init__ Initialize me.
Method getStaticEntity Get an entity that was added to me using putEntity.
Method getDynamicEntity Subclass this to generate an entity on demand.
Method getEntity Retrieve an entity from me.
Method putEntity Store a static reference on 'name' for 'entity'.
Method delEntity Remove a static reference for 'name'.
Method storeEntity Store an entity for 'name', based on the content of 'request'.
Method removeEntity Remove an entity for 'name', based on the content of 'request'.
Method listStaticEntities Retrieve a list of all name, entity pairs that I store references to.
Method listDynamicEntities A list of all name, entity that I can generate on demand.
Method listEntities Retrieve a list of all name, entity pairs I contain.
Method listStaticNames Retrieve a list of the names of entities that I store references to.
Method listDynamicNames Retrieve a list of the names of entities that I store references to.
Method listNames Retrieve a list of all names for entities that I contain.
def __init__(self, entities=None):
overridden in twisted.web.vhost.VirtualHostCollection

Initialize me.

def getStaticEntity(self, name):
overridden in twisted.web.vhost.VirtualHostCollection

Get an entity that was added to me using putEntity.

This method will return 'None' if it fails.

def getDynamicEntity(self, name, request):

Subclass this to generate an entity on demand.

This method should return 'None' if it fails.

def getEntity(self, name, request):

Retrieve 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'.

def putEntity(self, name, entity):
overridden in twisted.python.roots.Constrained

Store a static reference on 'name' for 'entity'.

Raises a KeyError if the operation fails.

def delEntity(self, name):
overridden in twisted.web.vhost.VirtualHostCollection

Remove a static reference for 'name'.

Raises a KeyError if the operation fails.

def storeEntity(self, name, request):

Store an entity for 'name', based on the content of 'request'.

def removeEntity(self, name, request):

Remove an entity for 'name', based on the content of 'request'.

def listStaticEntities(self):
overridden in twisted.web.vhost.VirtualHostCollection

Retrieve a list of all name, entity pairs that I store references to.

See getStaticEntity.

def listDynamicEntities(self, request):

A list of all name, entity that I can generate on demand.

See getDynamicEntity.

def listEntities(self, request):

Retrieve a list of all name, entity pairs I contain.

See getEntity.

def listStaticNames(self):

Retrieve a list of the names of entities that I store references to.

See getStaticEntity.

def listDynamicNames(self):

Retrieve a list of the names of entities that I store references to.

See getDynamicEntity.

def listNames(self, request):

Retrieve a list of all names for entities that I contain.

See getEntity.

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.