Eine Liste aller Routen definiert, die in der Kolben-app

Ich habe eine komplexe Kolben-basierte web-app. Es gibt viele separate Dateien mit view-Funktionen. Ihre URLs sind definiert mit der @app.route('/...') Dekorateur. Gibt es eine Möglichkeit, um eine Liste aller Routen, die erklärt wurden, während meine app? Vielleicht gibt es eine Methode, die ich aufrufen kann, auf der app Objekt?

InformationsquelleAutor J-bob | 2012-11-09

flask python

122

Alle Routen für eine Anwendung gespeichert sind, auf app.url_map eine Instanz von werkzeug.routing.Map. Sie können Durchlaufen die Regeln Instanzen mit dem iter_rules Methode:
```
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
```
Sehen Die Anzeige links auf neue Webseiten erstellt für ein bisschen mehr Informationen.
- Süß! Außer ich hatte ein Problem mit der Zeile url = url_for(rule.endpoint). Ich habe gerade diesen Fehler BuildError: ('DeleteEvent', {}, None). Stattdessen, um die url habe ich nur url = rule.rule. Jede Idee, warum deine Methode bei mir nicht funktioniert?
- wahrscheinlich ist der Leitweg, der mit DeleteEvent hat ein erforderlich - parameter können Sie entweder den speziellen Fall, dass eine oder filter alle Regeln, wo len(rule.arguments) > len(rule.defaults)
- Oh ich denke ich bekomme es. url_for können nicht generieren die URL für diese methid, ohne parameter, richtig? OK, aber wie es aussieht, funktioniert meine Methode sowieso, es hält nur den Teil falls eine URL als parameter. Danke!
- Dies ist hilfreich!!! Sie können ganz einfach überprüfen, indem python REPL-Umgebung, laden des Haupt-Kolben-Anwendung, e.g import main und direkt mit seinen url_map, main.app.url_map. Es gibt dir die Liste aller definierten Routen
- Das ist ein großartiger start. Irgendwelche Vorschläge, wie man erstellen Sie eine vollständig selbst dokumentieren Kolben-basierte web-service, wo alle Parameter (wie ?spam="Eier") aufgelistet sind? Vielleicht ist diese info kann extrahiert werden aus einer docstring der Umsetzung einer Methode.
- Anstelle der Verwendung url_for(rule.endpoint) verwenden rule.rule das ist viel besser, weil Fälle lösen, in denen Sie mehr als eine route für die gleiche Methode.
InformationsquelleAutor Sean Vieira
54

Traf ich gerade die gleiche Frage. Diese Lösung oben ist zu Komplex.
Öffnen Sie einfach eine neue shell unter Ihrem Projekt:
```
    python
    >>> from app import app
    >>> app.url_map
```
Den ersten " app' ist mein Projekt Skript: app.py,
ein anderes ist mein web-name.

(diese Lösung ist für blechern web mit ein wenig route)
- Dies ist wahrscheinlich die Antwort auf die Frage nicht direkt. Aber es sicher verdient viele mehr upvotes.
- Diese Antwort ist für die große nicht, die Sie zum hinzufügen von code für Ihre Anwendung. Ich benutzte es, um die Antwort zu bekommen, die ich wollte in Sekunden ohne Umbau meines code.
- "Gibt es einen Weg, um eine Liste aller Routen, die erklärt wurden, während meine app?" Ich denke, das beantwortet die Frage nicht direkt und sollte die akzeptierte Antwort. So einfach. Danke.
- Ich weiß nicht wirklich sehen, wie diese einfacher oder klarer als die akzeptierte Antwort. Es schlug den gleichen Ansatz, aber es dauert länger, bis man zu dem Punkt und nicht zeigen, wie man die Iteration über die Map Instanz oder den Zugriff auf die Eigenschaften der Rules, die es enthält, ohne die Sie nicht können wirklich etwas tun, nützlich ist.
InformationsquelleAutor Vi.Ci

Ich eine helper-Methode auf meine 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

Er löst das das fehlende argument, durch den Bau einer dummy-set von Optionen. Die Ausgabe sieht so aus:

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

Dann, um es auszuführen:

python manage.py list_routes

Mehr auf manage.py Kasse: http://flask-script.readthedocs.org/en/latest/

Das oben funktioniert auch sehr gut. Ändern Sie einfach urllib.unquote zu urllib.parse.unquote und print line zu print(line) und es funktioniert auch in python 3.x als gut.
Dies funktioniert nicht für nicht-string-Argumente, empfehle ich die Nutzung von John Jiang Antwort statt.

InformationsquelleAutor Jonathan

Ähnlich zu Jonathan ' s Antwort, die ich entschied sich stattdessen dazu. Ich sehe nicht den Punkt der Anwendung der url_for, wie es brechen wird, wenn Ihre Argumente sind nicht als string, z.B. 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)

InformationsquelleAutor John Jiang

14

Offenbar seit version 0.11, Flasche hat eine integrierte CLI. Eines der built-in-Befehle sind die Strecken:
```
FLASK_APP='my_project.app' flask routes
```
- Das ist absolut genial!
- flask urls für mich (0.12.1). Sah, dass Sie in flask --help aber ich sehe keine Routen oder urls auf die CLI Seite
InformationsquelleAutor theY4Kman
2

Da Sie nicht angeben, dass es laufen muss, wird die Befehlszeile, die der folgenden konnte problemlos zurückgegeben werden in json für ein Armaturenbrett oder eine andere non-command-line-interface. Das Ergebnis und die Ausgabe sollte wirklich nicht sein, vermischt aus einer design-Perspektive jedenfalls. Es ist schlimm, Programm-design, auch wenn es nur ein kleines Programm. Das untenstehende Ergebnis könnte dann in einer web-Anwendung, command-line, oder irgendetwas anderes, das sich nimmt, json.

Du auch nicht angegeben, dass Sie gebraucht werden, um die python-Funktion in Verbindung mit jeder route, so dass dies genauer Antworten zu deiner ursprünglichen Frage.

Ich unten verwenden, um die Ausgabe an ein monitoring-dashboard selbst. Wenn Sie möchten, dass die route Methoden (GET, POST, PUT, etc.), müssten Sie kombinieren es mit anderen Antworten.

Regel repr() übernimmt die Konvertierung der Parameter in der route.
```
def list_routes():
    routes = []

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

    return routes
```
Die gleiche Sache mit Hilfe einer list comprehension:
```
def list_routes():
    return ['%s' % rule for rule in app.url_map.iter_rules()]
```
Beispiel-Ausgabe:
```
{
  "routes": [
    "/endpoint1", 
    "/nested/service/endpoint2", 
    "/favicon.ico", 
    "/static/<path:filename>"
  ]
}
```
InformationsquelleAutor postal

Wenn Sie brauchen, um den Zugriff auf die view-Funktionen selbst dann statt app.url_map verwenden app.view_functions.

Beispiel-Skript:

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

Ausgabe von der Skript-Ausführung oben:

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

route1
<function route1 at 0x128f1b9d8>

route2
<function route2 at 0x128f1ba60>

(Hinweis: die Aufnahme des "static" - route, die erstellt wird, automatisch durch Glaskolben.)

InformationsquelleAutor Mark Amery

Schreibe einen Kommentar

Du musst angemeldet sein, um einen Kommentar abzugeben.