add_url_rule() — flask Function Reference

Architecture documentation for the add_url_rule() function in blueprints.py from the flask codebase.

Function python ApplicationCore Scaffolding calls 2 called by 1

Entity Profile

ApplicationCore→ Scaffolding→ add_url_rule() — flask Function Reference

Dependency Diagram

graph TD
  674e773f_4d02_61b4_8703_b931fcae73d7["add_url_rule()"]
  0c59fa87_9a90_f011_4207_98ae96479921["Blueprint"]
  674e773f_4d02_61b4_8703_b931fcae73d7 -->|defined in| 0c59fa87_9a90_f011_4207_98ae96479921
  a095b8ad_24db_e31f_c7dd_d94b4dc565d0["add_url_rule()"]
  a095b8ad_24db_e31f_c7dd_d94b4dc565d0 -->|calls| 674e773f_4d02_61b4_8703_b931fcae73d7
  0b82c064_d082_834e_b86a_ea458a961988["record()"]
  674e773f_4d02_61b4_8703_b931fcae73d7 -->|calls| 0b82c064_d082_834e_b86a_ea458a961988
  a095b8ad_24db_e31f_c7dd_d94b4dc565d0["add_url_rule()"]
  674e773f_4d02_61b4_8703_b931fcae73d7 -->|calls| a095b8ad_24db_e31f_c7dd_d94b4dc565d0
  style 674e773f_4d02_61b4_8703_b931fcae73d7 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/flask/sansio/blueprints.py lines 413–441

    def add_url_rule(
        self,
        rule: str,
        endpoint: str | None = None,
        view_func: ft.RouteCallable | None = None,
        provide_automatic_options: bool | None = None,
        **options: t.Any,
    ) -> None:
        """Register a URL rule with the blueprint. See :meth:`.Flask.add_url_rule` for
        full documentation.

        The URL rule is prefixed with the blueprint's URL prefix. The endpoint name,
        used with :func:`url_for`, is prefixed with the blueprint's name.
        """
        if endpoint and "." in endpoint:
            raise ValueError("'endpoint' may not contain a dot '.' character.")

        if view_func and hasattr(view_func, "__name__") and "." in view_func.__name__:
            raise ValueError("'view_func' name may not contain a dot '.' character.")

        self.record(
            lambda s: s.add_url_rule(
                rule,
                endpoint,
                view_func,
                provide_automatic_options=provide_automatic_options,
                **options,
            )
        )