websauna.system.core.interfaces module

interface websauna.system.core.interfaces.IContainer

Bases: pyramid.interfaces.ILocation

Marker interface telling that Resource class is iterable.

Database loading example implementation:

@implementer(IContainer)
class AssetFolder(Resource):

    def __getitem__(self, slug: str) -> AssetDescription:

        for asset in self.request.dbsession.query(Asset).filter(Asset.network_id==self.get_network().id):
            if asset.slug == slug:
                return self.get_description(asset)

        raise KeyError()

    def items(self):
        for asset_resource in self.get_public_assets():
            yield asset_resource.__name__, asset_resource

    def get_public_assets(self) -> Iterable[AssetDescription]:
        network = self.get_network()
        dbsession = self.request.dbsession
        for asset in dbsession.query(Asset).filter_by(network=network, state=AssetState.public).order_by(Asset.name.asc()):
            yield self.get_description(asset)

Static child example implementation:

@implementer(IContainer)
class NetworkDescription(Resource):

    def items(self):
        yield "assets", self.asset_folder

    def __getitem__(self, item):
        if item == "assets":
            return self.asset_folder
        raise KeyError()

For more example implementation see websauna.tests.sitemapsamples.

TODO: Not sure if items() is the best way to do the child discovery. All ideas accepted.

items()

Return children in this container as (id, Resource instance) tuples.

This usually dynamically populates from the database when this is called and there is no caching. The result is iterable only once.

Returns

Iterable (URL id, child object). Child objects can be any Python objects with __parent__ pointer set as described by a generic interface pyramid.interfaces.ILocation.

interface websauna.system.core.interfaces.IRoot

Bases: zope.interface.Interface

Market interface for the root object.

Used e.g. breadcrumbs and traversing are we in root tests.

interface websauna.system.core.interfaces.ISecrets

Bases: zope.interface.Interface

Utility marker interface which gives us our secrets.

Secrets is a dictionary which hold sensitive deployment data.