useblocks / groundwork-web

groundwork_web/patterns/gw_web_pattern/route.py

import os
import logging

from groundwork.util import gw_get


class RouteManagerPlugin:
    def __init__(self, plugin):
        self.plugin = plugin
        self.log = plugin.log
        self.app = plugin.app

    def register(self, url, methods, endpoint, context=None, name=None, description=None):
        return self.app.web.routes.register(url, methods, endpoint, self.plugin, context, name, description)


class RouteManagerApplication:
    def __init__(self, app):
        self._routes = {}
        self.app = app
        self.log = logging.getLogger(__name__)
        self.blueprints = {}

    def register(self, url, methods, endpoint, plugin, context=None, name=None, description=None, ):

        if context is None and self.app.web.contexts.default_context is None:
            self.log.warning("Context not given and no default context is available. Basic context will be created")
            basic_context = self.app.web.contexts.register("basic",
                                                           os.path.join(self.app.path, "template"),
                                                           os.path.join(self.app.path, "static"),
                                                           "/",
                                                           "basic context, which was created automatically due the "
                                                           "miss of an available context during first route "
                                                           "registration.",
                                                           plugin)
            context = basic_context.name
            context_obj = basic_context

        if context is None:
            context_obj = self.app.web.contexts.default_context
        else:
            context_obj = self.app.web.contexts.get(context)

        if name not in self._routes.keys():
            self._routes[name] = Route(url, methods, endpoint, context_obj, name, description, plugin, self.app)

    def get(self, name=None, plugin=None):
        return gw_get(self._routes, name, plugin)


class Route:

This code seems to be duplicated in your project.

    """
    """

    def __init__(self, url, methods, endpoint, context, name, description, plugin, app):
        self.url = url
        self.methods = methods
        self.endpoint = endpoint
        self.context = context
        self.name = name
        self.description = description
        self.plugin = plugin
        self.app = app
        self.log = logging.getLogger(__name__)

        blueprint = self.context.blueprint
        blueprint.add_url_rule(url, methods=methods, endpoint=endpoint.__name__, view_func=endpoint)
        # We have to (re-)register our blueprint to activate the route
        self.app.web.flask.register_blueprint(blueprint)

        self.log.info("Route registered:  %s for context %s (%s)" % (self.url, self.context.name,
                                                                     self.context.url_prefix))