From 3d9143323019e0793451eac60eef8e55c09f6c47 Mon Sep 17 00:00:00 2001 From: Elrond Date: Sun, 16 Dec 2012 00:50:20 +0100 Subject: [PATCH] Move things from routing.py to tools/routing.py This stops a cyclic import. Move add_route, mount and endpoint_to_controller into tools/routing.py and change all callers. --- mediagoblin/app.py | 3 +- mediagoblin/edit/routing.py | 2 +- mediagoblin/listings/routing.py | 2 +- mediagoblin/routing.py | 43 +-------------------- mediagoblin/submit/routing.py | 2 +- mediagoblin/tools/routing.py | 63 +++++++++++++++++++++++++++++++ mediagoblin/user_pages/routing.py | 2 +- mediagoblin/webfinger/routing.py | 2 +- 8 files changed, 71 insertions(+), 48 deletions(-) create mode 100644 mediagoblin/tools/routing.py diff --git a/mediagoblin/app.py b/mediagoblin/app.py index 207e9d2c..ff64f65c 100644 --- a/mediagoblin/app.py +++ b/mediagoblin/app.py @@ -17,7 +17,8 @@ import os import logging -from mediagoblin.routing import get_url_map, endpoint_to_controller +from mediagoblin.routing import get_url_map +from mediagoblin.tools.routing import endpoint_to_controller from werkzeug.wrappers import Request from werkzeug.exceptions import HTTPException, NotFound diff --git a/mediagoblin/edit/routing.py b/mediagoblin/edit/routing.py index 28b73d1e..3e6787d2 100644 --- a/mediagoblin/edit/routing.py +++ b/mediagoblin/edit/routing.py @@ -14,7 +14,7 @@ # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . -from mediagoblin.routing import add_route +from mediagoblin.tools.routing import add_route add_route('mediagoblin.edit.profile', '/edit/profile/', 'mediagoblin.edit.views:edit_profile') diff --git a/mediagoblin/listings/routing.py b/mediagoblin/listings/routing.py index d25f1c8c..e5683168 100644 --- a/mediagoblin/listings/routing.py +++ b/mediagoblin/listings/routing.py @@ -14,7 +14,7 @@ # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . -from mediagoblin.routing import add_route +from mediagoblin.tools.routing import add_route add_route('mediagoblin.listings.tags_listing', "/tag//", diff --git a/mediagoblin/routing.py b/mediagoblin/routing.py index dc22ba09..1cf82a02 100644 --- a/mediagoblin/routing.py +++ b/mediagoblin/routing.py @@ -16,53 +16,12 @@ import logging -from werkzeug.routing import Map, Rule -from mediagoblin.tools.common import import_component +from mediagoblin.tools.routing import add_route, mount, url_map from mediagoblin.tools.pluginapi import PluginManager _log = logging.getLogger(__name__) -url_map = Map() - -view_functions = {} - - -def endpoint_to_controller(endpoint): - view_func = view_functions[endpoint] - - _log.debug('endpoint: {0} view_func: {1}'.format(endpoint, view_func)) - - # import the endpoint, or if it's already a callable, call that - if isinstance(view_func, basestring): - view_func = import_component(view_func) - view_functions[endpoint] = view_func - - return view_func - - -def add_route(endpoint, url, controller): - """ - Add a route to the url mapping - """ - # XXX: We cannot use this, since running tests means that the plugin - # routes will be populated over and over over the same session. - # - # assert endpoint not in view_functions.keys(), 'Trying to overwrite a rule' - - view_functions.update({endpoint: controller}) - - url_map.add(Rule(url, endpoint=endpoint)) - - -def mount(mountpoint, routes): - """ - Mount a bunch of routes to this mountpoint - """ - for endpoint, url, controller in routes: - url = "%s/%s" % (mountpoint.rstrip('/'), url.lstrip('/')) - add_route(endpoint, url, controller) - def get_url_map(): for route in PluginManager().get_routes(): diff --git a/mediagoblin/submit/routing.py b/mediagoblin/submit/routing.py index fbe3c39c..085344fd 100644 --- a/mediagoblin/submit/routing.py +++ b/mediagoblin/submit/routing.py @@ -14,7 +14,7 @@ # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . -from mediagoblin.routing import add_route +from mediagoblin.tools.routing import add_route add_route('mediagoblin.submit.start', '/submit/', 'mediagoblin.submit.views:submit_start') diff --git a/mediagoblin/tools/routing.py b/mediagoblin/tools/routing.py new file mode 100644 index 00000000..6c5acbec --- /dev/null +++ b/mediagoblin/tools/routing.py @@ -0,0 +1,63 @@ +# GNU MediaGoblin -- federated, autonomous media hosting +# Copyright (C) 2011, 2012 MediaGoblin contributors. See AUTHORS. +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + +import logging + +from werkzeug.routing import Map, Rule +from mediagoblin.tools.common import import_component + + +_log = logging.getLogger(__name__) + +url_map = Map() + +view_functions = {} + + +def endpoint_to_controller(endpoint): + view_func = view_functions[endpoint] + + _log.debug('endpoint: {0} view_func: {1}'.format(endpoint, view_func)) + + # import the endpoint, or if it's already a callable, call that + if isinstance(view_func, basestring): + view_func = import_component(view_func) + view_functions[endpoint] = view_func + + return view_func + + +def add_route(endpoint, url, controller): + """ + Add a route to the url mapping + """ + # XXX: We cannot use this, since running tests means that the plugin + # routes will be populated over and over over the same session. + # + # assert endpoint not in view_functions.keys(), 'Trying to overwrite a rule' + + view_functions.update({endpoint: controller}) + + url_map.add(Rule(url, endpoint=endpoint)) + + +def mount(mountpoint, routes): + """ + Mount a bunch of routes to this mountpoint + """ + for endpoint, url, controller in routes: + url = "%s/%s" % (mountpoint.rstrip('/'), url.lstrip('/')) + add_route(endpoint, url, controller) diff --git a/mediagoblin/user_pages/routing.py b/mediagoblin/user_pages/routing.py index 22d7f9b8..63bf5c2a 100644 --- a/mediagoblin/user_pages/routing.py +++ b/mediagoblin/user_pages/routing.py @@ -14,7 +14,7 @@ # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . -from mediagoblin.routing import add_route +from mediagoblin.tools.routing import add_route add_route('mediagoblin.user_pages.user_home', '/u//', 'mediagoblin.user_pages.views:user_home') diff --git a/mediagoblin/webfinger/routing.py b/mediagoblin/webfinger/routing.py index 18f9eb02..eb10509f 100644 --- a/mediagoblin/webfinger/routing.py +++ b/mediagoblin/webfinger/routing.py @@ -14,7 +14,7 @@ # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . -from mediagoblin.routing import add_route +from mediagoblin.tools.routing import add_route add_route('mediagoblin.webfinger.host_meta', '/.well-known/host-meta', 'mediagoblin.webfinger.views:host_meta') -- 2.25.1