endpoint() — flask Function Reference

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

Function python ApplicationCore Scaffolding calls 1 called by 1

Entity Profile

ApplicationCore→ Scaffolding→ endpoint() — flask Function Reference

Dependency Diagram

graph TD
  22be24c3_a691_fecd_0255_dd39f9f3f245["endpoint()"]
  a813bd5c_bf41_d926_8dde_6a113d5e0018["Scaffold"]
  22be24c3_a691_fecd_0255_dd39f9f3f245 -->|defined in| a813bd5c_bf41_d926_8dde_6a113d5e0018
  878f8299_c5bc_f34c_67ae_8bae8fd95fa0["add_url_rule()"]
  878f8299_c5bc_f34c_67ae_8bae8fd95fa0 -->|calls| 22be24c3_a691_fecd_0255_dd39f9f3f245
  878f8299_c5bc_f34c_67ae_8bae8fd95fa0["add_url_rule()"]
  22be24c3_a691_fecd_0255_dd39f9f3f245 -->|calls| 878f8299_c5bc_f34c_67ae_8bae8fd95fa0
  style 22be24c3_a691_fecd_0255_dd39f9f3f245 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/flask/sansio/scaffold.py lines 436–457

    def endpoint(self, endpoint: str) -> t.Callable[[F], F]:
        """Decorate a view function to register it for the given
        endpoint. Used if a rule is added without a ``view_func`` with
        :meth:`add_url_rule`.

        .. code-block:: python

            app.add_url_rule("/ex", endpoint="example")

            @app.endpoint("example")
            def example():
                ...

        :param endpoint: The endpoint name to associate with the view
            function.
        """

        def decorator(f: F) -> F:
            self.view_functions[endpoint] = f
            return f

        return decorator