class documentation

class Requirer: (source)

View In Hierarchy

Dependency injection for required parameters.

Method prerequisite Specify a component that is a pre-requisite of every request routed through this requirer's require method. Used like so:
Method require Inject the given dependencies while running the given route.
Instance Variable _prerequisites Undocumented
def prerequisite(self, providesComponents, requiresComponents=()): (source)

Specify a component that is a pre-requisite of every request routed through this requirer's require method. Used like so:

    requirer = Requirer()

    @requirer.prerequisite([IFoo])
    @inlineCallbacks
    def fooForRequest(request):
        request.setComponent(IFoo, someFooComponent)
Parameters
providesComponents:Sequence[Type[Interface]]Undocumented
requiresComponents:Sequence[Type[Interface]]Undocumented
Returns
Callable[[Callable], Callable]Undocumented
Note
requiresComponents is, at this point, for the reader's interest only, the framework will not topologically sort dependencies; you must presently register prerequisites in the order you want them to be called.
def require(self, routeDecorator, **requiredParameters): (source)

Inject the given dependencies while running the given route.

Parameters
routeDecorator:_routeTUndocumented
**requiredParameters:IRequiredParameterUndocumented
Returns
_routeDecoratorUndocumented
_prerequisites: List[_prerequisiteCallback] = (source)

Undocumented