Dapatkan daftar semua rute yang ditentukan dalam aplikasi Flask

Saya memiliki aplikasi web berbasis Flask yang kompleks. Ada banyak file terpisah dengan fungsi tampilan. URL mereka didefinisikan dengan @app.route('/...')dekorator. Apakah ada cara untuk mendapatkan daftar semua rute yang telah dinyatakan di seluruh aplikasi saya? Mungkin ada beberapa metode yang bisa saya panggil pada appobjek?

Semua rute untuk aplikasi disimpan di app.url_mapmana merupakan instance dari werkzeug.routing.Map. Anda dapat mengulangi Ruleinstance dengan menggunakan iter_rulesmetode:

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

Lihat Menampilkan tautan ke halaman web baru yang dibuat untuk informasi lebih lanjut.

Saya baru saja bertemu pertanyaan yang sama. Solusi di atas terlalu kompleks. Cukup buka shell baru di bawah proyek Anda:

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

' Aplikasi ' pertama adalah skrip proyek saya: app.py , yang lain adalah nama web saya.

(solusi ini untuk web kecil dengan rute kecil)

Saya membuat metode pembantu pada 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

Ini memecahkan argumen yang hilang dengan membangun serangkaian opsi boneka. Outputnya terlihat seperti:

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

Kemudian untuk menjalankannya:

python manage.py list_routes

Untuk lebih lanjut tentang checkout manage.py: http://flask-script.readthedocs.org/en/latest/

Mirip dengan jawaban Jonathan saya memilih untuk melakukan ini sebagai gantinya. Saya tidak melihat gunanya menggunakan url_for karena akan rusak jika argumen Anda bukan string misalnya 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)

Rupanya, sejak versi 0.11, Flask memiliki CLI bawaan . Salah satu perintah bawaan mencantumkan rute:

FLASK_APP='my_project.app' flask routes

Karena Anda tidak menentukan bahwa itu harus dijalankan command-line, berikut ini dapat dengan mudah dikembalikan di json untuk dasbor atau antarmuka non-command-line lainnya. Bagaimanapun juga, hasil dan keluarannya seharusnya tidak disatukan dari perspektif desain. Ini desain program yang buruk, bahkan jika itu adalah program kecil. Hasil di bawah ini kemudian dapat digunakan dalam aplikasi web, command-line, atau apa pun yang menelan json.

Anda juga tidak menentukan bahwa Anda perlu mengetahui fungsi python yang terkait dengan setiap rute, jadi ini lebih tepat menjawab pertanyaan awal Anda.

Saya menggunakan di bawah ini untuk menambahkan output ke dashboard pemantauan sendiri. Jika Anda ingin metode rute yang tersedia (DAPATKAN, POST, PUT, dll.), Anda harus menggabungkannya dengan jawaban lain di atas.

Repr () aturan mengatur konversi argumen yang diperlukan dalam rute.

def list_routes():
    routes = []

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

    return routes

Hal yang sama menggunakan pemahaman daftar:

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

Output sampel:

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

Jika Anda perlu mengakses fungsi tampilan itu sendiri, maka alih-alih app.url_map, gunakan app.view_functions.

Skrip contoh:

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

Output dari menjalankan skrip di atas:

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

route1
<function route1 at 0x128f1b9d8>

route2
<function route2 at 0x128f1ba60>

(Perhatikan penyertaan rute "statis", yang dibuat secara otomatis oleh Flask.)

Anda dapat melihat semua Rute melalui flask shell dengan menjalankan perintah berikut setelah mengekspor atau mengatur variabel lingkungan FLASK_APP. flask shell app.url_map

di dalam aplikasi labu Anda lakukan:

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