Nhận danh sách tất cả các tuyến đường được xác định trong ứng dụng Flask

Tôi có một ứng dụng web dựa trên Flask phức tạp. Có rất nhiều tập tin riêng biệt với chức năng xem. URL của họ được xác định với @app.route('/...')trang trí. Có cách nào để có được danh sách tất cả các tuyến đường đã được khai báo trong ứng dụng của tôi không? Có lẽ có một số phương pháp tôi có thể gọi trên appđối tượng?

Tất cả các tuyến đường cho một ứng dụng được lưu trữ trên app.url_mapđó là một thể hiện của werkzeug.routing.Map. Bạn có thể lặp lại qua các Rulethể hiện bằng cách sử dụng iter_rulesphương thức:

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

Xem Hiển thị liên kết đến các trang web mới được tạo để biết thêm một chút thông tin.

Tôi chỉ gặp câu hỏi tương tự. Những giải pháp trên quá phức tạp. Chỉ cần mở một shell mới trong dự án của bạn:

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

' Ứng dụng ' đầu tiên là tập lệnh dự án của tôi: app.py , một ứng dụng khác là tên web của tôi.

(giải pháp này dành cho web nhỏ với một tuyến đường nhỏ)

Tôi thực hiện một phương thức trợ giúp trên 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

Nó giải quyết các đối số còn thiếu bằng cách xây dựng một tập hợp các tùy chọn giả. Đầu ra trông như sau:

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

Sau đó để chạy nó:

python manage.py list_routes

Để biết thêm về kiểm tra quản lý: http://flask-script.readthedocs.org/en/latest/

Tương tự như câu trả lời của Jonathan, tôi đã chọn làm điều này thay vào đó. Tôi không thấy điểm sử dụng url_for vì nó sẽ bị hỏng nếu đối số của bạn không phải là chuỗi, ví dụ: 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)

Rõ ràng, kể từ phiên bản 0.11, Flask có CLI tích hợp . Một trong các lệnh tích hợp liệt kê các tuyến:

FLASK_APP='my_project.app' flask routes

Vì bạn không chỉ định rằng nó phải được chạy dòng lệnh, nên những điều sau đây có thể dễ dàng được trả về trong json cho bảng điều khiển hoặc giao diện không phải dòng lệnh khác. Dù sao, kết quả và đầu ra thực sự không nên được xử lý theo quan điểm thiết kế. Đó là thiết kế chương trình tồi, ngay cả khi đó là một chương trình nhỏ. Kết quả dưới đây sau đó có thể được sử dụng trong một ứng dụng web, dòng lệnh hoặc bất cứ thứ gì khác ăn vào json.

Bạn cũng không xác định rằng bạn cần biết chức năng python liên quan đến từng tuyến đường, vì vậy điều này trả lời chính xác hơn câu hỏi ban đầu của bạn.

Tôi sử dụng bên dưới để thêm đầu ra vào bảng điều khiển giám sát. Nếu bạn muốn các phương thức định tuyến khả dụng (GET, POST, PUT, v.v.), bạn sẽ cần kết hợp nó với các câu trả lời khác ở trên.

Quy tắc repr () đảm nhiệm việc chuyển đổi các đối số cần thiết trong tuyến đường.

def list_routes():
    routes = []

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

    return routes

Điều tương tự bằng cách sử dụng một danh sách hiểu:

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

Đầu ra mẫu:

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

Nếu bạn cần truy cập vào các chức năng xem, sau đó thay vì app.url_mapsử dụngapp.view_functions .

Kịch bản ví dụ:

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

Đầu ra từ việc chạy đoạn script trên:

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

route1
<function route1 at 0x128f1b9d8>

route2
<function route2 at 0x128f1ba60>

(Lưu ý việc bao gồm tuyến "tĩnh", được tạo tự động bởi Flask.)

Bạn có thể xem tất cả các Tuyến thông qua vỏ bình bằng cách chạy các lệnh sau sau khi xuất hoặc đặt biến môi trường FLASK_APP. flask shell app.url_map

trong ứng dụng bình của bạn làm:

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