Obtenga una lista de todas las rutas definidas en la aplicación Flask

Tengo una aplicación web compleja basada en Flask. Hay muchos archivos separados con funciones de visualización. Sus URL se definen con el @app.route('/...')decorador. ¿Hay alguna forma de obtener una lista de todas las rutas que se han declarado en mi aplicación? ¿Quizás hay algún método que pueda invocar en el appobjeto?

Todas las rutas para una aplicación se almacenan en lo app.url_mapque es una instancia de werkzeug.routing.Map. Puede iterar sobre las Ruleinstancias utilizando el iter_rulesmétodo:

from flask import Flask, url_for

app = Flask(__name__)

def has_no_empty_params(rule):
    defaults = rule.defaults if rule.defaults is not None else ()
    arguments = rule.arguments if rule.arguments is not None else ()
    return len(defaults) >= len(arguments)


@app.route("/site-map")
def site_map():
    links = []
    for rule in app.url_map.iter_rules():
        # Filter out rules we can't navigate to in a browser
        # and rules that require parameters
        if "GET" in rule.methods and has_no_empty_params(rule):
            url = url_for(rule.endpoint, **(rule.defaults or {}))
            links.append((url, rule.endpoint))
    # links is now a list of url, endpoint tuples

Consulte Mostrar enlaces a nuevas páginas web creadas para obtener un poco más de información.

Acabo de encontrar la misma pregunta. Las soluciones anteriores son demasiado complejas. Simplemente abra un nuevo shell debajo de su proyecto:

    python
    >>> from app import app
    >>> app.url_map

La primera ' aplicación ' es mi script de proyecto: app.py , otra es el nombre de mi web.

(esta solución es para web pequeña con una pequeña ruta)

Hago un método auxiliar en mi manage.py:

@manager.command
def list_routes():
    import urllib
    output = []
    for rule in app.url_map.iter_rules():

        options = {}
        for arg in rule.arguments:
            options[arg] = "[{0}]".format(arg)

        methods = ','.join(rule.methods)
        url = url_for(rule.endpoint, **options)
        line = urllib.unquote("{:50s} {:20s} {}".format(rule.endpoint, methods, url))
        output.append(line)

    for line in sorted(output):
        print line

Resuelve el argumento que falta al construir un conjunto ficticio de opciones. El resultado se ve así:

CampaignView:edit              HEAD,OPTIONS,GET     /account/[account_id]/campaigns/[campaign_id]/edit
CampaignView:get               HEAD,OPTIONS,GET     /account/[account_id]/campaign/[campaign_id]
CampaignView:new               HEAD,OPTIONS,GET     /account/[account_id]/new

Luego para ejecutarlo:

python manage.py list_routes

Para más información sobre la gestión de manage.py: http://flask-script.readthedocs.org/en/latest/

Similar a la respuesta de Jonathan, opté por hacer esto en su lugar. No veo el punto de usar url_for ya que se romperá si sus argumentos no son una cadena, por ejemplo, flotante

@manager.command
def list_routes():
    import urllib

    output = []
    for rule in app.url_map.iter_rules():
        methods = ','.join(rule.methods)
        line = urllib.unquote("{:50s} {:20s} {}".format(rule.endpoint, methods, rule))
        output.append(line)

    for line in sorted(output):
        print(line)

Aparentemente, desde la versión 0.11, Flask tiene una CLI incorporada . Uno de los comandos integrados enumera las rutas:

FLASK_APP='my_project.app' flask routes

Como no especificó que debe ejecutarse en la línea de comandos, lo siguiente podría devolverse fácilmente en json para un tablero u otra interfaz que no sea de línea de comandos. El resultado y el resultado realmente no deberían mezclarse desde una perspectiva de diseño de todos modos. Es un mal diseño del programa, incluso si es un programa pequeño. El resultado a continuación podría usarse en una aplicación web, línea de comandos o cualquier otra cosa que ingiera json.

Tampoco especificó que necesitaba conocer la función de Python asociada con cada ruta, por lo que esto responde con mayor precisión a su pregunta original.

Yo uso a continuación para agregar la salida a un panel de monitoreo yo mismo. Si desea los métodos de ruta disponibles (GET, POST, PUT, etc.), deberá combinarlo con otras respuestas anteriores.

La regla repr () se encarga de convertir los argumentos necesarios en la ruta.

def list_routes():
    routes = []

    for rule in app.url_map.iter_rules():
        routes.append('%s' % rule)

    return routes

Lo mismo usando una lista de comprensión:

def list_routes():
    return ['%s' % rule for rule in app.url_map.iter_rules()]

Salida de muestra:

{
  "routes": [
    "/endpoint1", 
    "/nested/service/endpoint2", 
    "/favicon.ico", 
    "/static/<path:filename>"
  ]
}

Si necesita acceder a las funciones de vista, entonces, en lugar de app.url_mapusarlas app.view_functions.

Script de ejemplo:

from flask import Flask

app = Flask(__name__)

@app.route('/foo/bar')
def route1():
    pass

@app.route('/qux/baz')
def route2():
    pass

for name, func in app.view_functions.items():
    print(name)
    print(func)
    print()

Salida de ejecutar el script anterior:

static
<bound method _PackageBoundObject.send_static_file of <Flask '__main__'>>

route1
<function route1 at 0x128f1b9d8>

route2
<function route2 at 0x128f1ba60>

(Tenga en cuenta la inclusión de la ruta "estática", que Flask crea automáticamente).

Puede ver todas las rutas a través del matraz ejecutando los siguientes comandos después de exportar o configurar la variable de entorno FLASK_APP. flask shell app.url_map

dentro de su aplicación de matraz:

flask shell
>>> app.url_map
Map([<Rule '/' (OPTIONS, HEAD, GET) -> helloworld>,
 <Rule '/static/<filename>' (OPTIONS, HEAD, GET) -> static>])