route() — flask Function Reference

Architecture documentation for the route() function in scaffold.py from the flask codebase.

Function python ApplicationCore Scaffolding calls 1 called by 3

Entity Profile

ApplicationCore→ Scaffolding→ route() — flask Function Reference

Dependency Diagram

graph TD
  7889a405_44a8_098c_785b_8fb560b8ae6b["route()"]
  a813bd5c_bf41_d926_8dde_6a113d5e0018["Scaffold"]
  7889a405_44a8_098c_785b_8fb560b8ae6b -->|defined in| a813bd5c_bf41_d926_8dde_6a113d5e0018
  4a067460_947c_1e17_83f2_27f565351cdb["add_url_rule()"]
  4a067460_947c_1e17_83f2_27f565351cdb -->|calls| 7889a405_44a8_098c_785b_8fb560b8ae6b
  dd7bc248_9018_29f8_7780_802bd55191fc["_method_route()"]
  dd7bc248_9018_29f8_7780_802bd55191fc -->|calls| 7889a405_44a8_098c_785b_8fb560b8ae6b
  878f8299_c5bc_f34c_67ae_8bae8fd95fa0["add_url_rule()"]
  878f8299_c5bc_f34c_67ae_8bae8fd95fa0 -->|calls| 7889a405_44a8_098c_785b_8fb560b8ae6b
  878f8299_c5bc_f34c_67ae_8bae8fd95fa0["add_url_rule()"]
  7889a405_44a8_098c_785b_8fb560b8ae6b -->|calls| 878f8299_c5bc_f34c_67ae_8bae8fd95fa0
  style 7889a405_44a8_098c_785b_8fb560b8ae6b fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/flask/sansio/scaffold.py lines 336–365

    def route(self, rule: str, **options: t.Any) -> t.Callable[[T_route], T_route]:
        """Decorate a view function to register it with the given URL
        rule and options. Calls :meth:`add_url_rule`, which has more
        details about the implementation.

        .. code-block:: python

            @app.route("/")
            def index():
                return "Hello, World!"

        See :ref:`url-route-registrations`.

        The endpoint name for the route defaults to the name of the view
        function if the ``endpoint`` parameter isn't passed.

        The ``methods`` parameter defaults to ``["GET"]``. ``HEAD`` and
        ``OPTIONS`` are added automatically.

        :param rule: The URL rule string.
        :param options: Extra options passed to the
            :class:`~werkzeug.routing.Rule` object.
        """

        def decorator(f: T_route) -> T_route:
            endpoint = options.pop("endpoint", None)
            self.add_url_rule(rule, endpoint, f, **options)
            return f

        return decorator