Get list of all routes defined in the Flask app

by

All the routes for an application are stored on app.url_map which is an instance of werkzeug.routing.Map. You can iterate over the Rule instances by using the iter_rules method:

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

See Display links to new webpages created for a bit more information.

More Related Contents:

  1. How to return a dict as a JSON response from a Flask view?
  2. How to get POSTed JSON in Flask?
  3. How many concurrent requests does a single Flask process receive?
  4. Saving upload in Flask only saves to project root
  5. What is the purpose of Flask’s context stacks?
  6. error: [Errno 10053]
  7. Why does the session cookie work when serving from a domain but not when using an IP?
  8. Running a Dash app within a Flask app
  9. Debugging a Flask app running in Gunicorn
  10. Passing a matplotlib figure to HTML (flask)
  11. How do I set response headers in Flask?
  12. Restrict static file access to logged in users
  13. Flask sqlalchemy many-to-many insert data
  14. How to send image generated by PIL to browser?
  15. How to schedule a function to run every hour on Flask?
  16. Method Not Allowed flask error 405
  17. Extending Flask class as main App
  18. CSS Problems with Flask Web App
  19. Python Flask, how to set content type
  20. Flask URL Route: Route Several URLs to the same function
  21. how to get access to error message from abort command when using custom error handler
  22. Gunicorn can’t find app when name changed from “application”
  23. Flask(‘application’) versus Flask(__name__)
  24. How do I get the user agent with Flask?
  25. Flask css not updating [closed]
  26. flask socketio emit to specific user
  27. Delete an uploaded file after downloading it from Flask
  28. Dynamic choices WTForms Flask SelectField
  29. Static files in Flask – robot.txt, sitemap.xml (mod_wsgi)
  30. flask sqlalchemy query with keyword as variable

Leave a Comment