Obter lista de todas as rotas definidas no aplicativo Flask

Eu tenho um aplicativo Web complexo baseado em Flask. Existem muitos arquivos separados com funções de visualização. Seus URLs são definidos com o @app.route('/...')decorador. Existe uma maneira de obter uma lista de todas as rotas que foram declaradas em todo o meu aplicativo? Talvez haja algum método que eu possa chamar no appobjeto?

Todas as rotas para um aplicativo são armazenadas nas app.url_mapquais é uma instância werkzeug.routing.Map. Você pode iterar sobre as Ruleinstâncias usando o 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 Exibir links para novas páginas da web criadas para um pouco mais de informação.

Acabei de encontrar a mesma pergunta. A solução acima é muito complexa. Basta abrir um novo shell no seu projeto:

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

O primeiro ' app ' é o script do meu projeto: app.py , outro é o nome da minha web.

(esta solução é para web pequena com uma pequena rota)

Eu faço um método auxiliar no meu 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

Ele resolve o argumento que falta, criando um conjunto fictício de opções. A saída se parece com:

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

Então, para executá-lo:

python manage.py list_routes

Para mais informações sobre o checkout manage.py: http://flask-script.readthedocs.org/en/latest/

Semelhante à resposta de Jonathan, optei por fazer isso. Eu não vejo o ponto de usar url_for, pois ele será interrompido se seus argumentos não forem string, por exemplo, float

@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 a versão 0.11, o Flask possui uma CLI integrada . Um dos comandos internos lista as rotas:

FLASK_APP='my_project.app' flask routes

Como você não especificou que ele deve ser executado na linha de comandos, o seguinte poderia ser facilmente retornado em json para um painel ou outra interface que não seja da linha de comandos. O resultado e a saída realmente não devem ser misturados da perspectiva do design. É um design de programa ruim, mesmo que seja um programa minúsculo. O resultado abaixo pode ser usado em um aplicativo Web, linha de comando ou qualquer outra coisa que ingira json.

Você também não especificou que precisava conhecer a função python associada a cada rota, portanto, isso responde com mais precisão à sua pergunta original.

Eu uso abaixo para adicionar a saída a um painel de monitoramento. Se você quiser os métodos de rota disponíveis (GET, POST, PUT etc.), será necessário combiná-lo com outras respostas acima.

O repr () da regra cuida da conversão dos argumentos necessários na rota.

def list_routes():
    routes = []

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

    return routes

A mesma coisa usando uma compreensão de lista:

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

Saída de amostra:

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

Se você precisar acessar as funções de exibição, então, em vez de app.url_map, use app.view_functions.

Script de exemplo:

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()

Saída da execução do script acima:

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

route1
<function route1 at 0x128f1b9d8>

route2
<function route2 at 0x128f1ba60>

(Observe a inclusão da rota "estática", criada automaticamente pelo Flask.)

Você pode visualizar todas as rotas através do shell do balão executando os seguintes comandos após exportar ou definir a variável de ambiente FLASK_APP. flask shell app.url_map

dentro do seu aplicativo de balão, faça:

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