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 2

Entity Profile

ApplicationCore→ Scaffolding→ add_url_rule() — flask Function Reference

Dependency Diagram

graph TD
  a095b8ad_24db_e31f_c7dd_d94b4dc565d0["add_url_rule()"]
  e57fb048_2e7e_7939_8012_b7bdd3145ba8["BlueprintSetupState"]
  a095b8ad_24db_e31f_c7dd_d94b4dc565d0 -->|defined in| e57fb048_2e7e_7939_8012_b7bdd3145ba8
  674e773f_4d02_61b4_8703_b931fcae73d7["add_url_rule()"]
  674e773f_4d02_61b4_8703_b931fcae73d7 -->|calls| a095b8ad_24db_e31f_c7dd_d94b4dc565d0
  ab08d213_c111_86c1_e5b9_dd3fd7770d86["register()"]
  ab08d213_c111_86c1_e5b9_dd3fd7770d86 -->|calls| a095b8ad_24db_e31f_c7dd_d94b4dc565d0
  674e773f_4d02_61b4_8703_b931fcae73d7["add_url_rule()"]
  a095b8ad_24db_e31f_c7dd_d94b4dc565d0 -->|calls| 674e773f_4d02_61b4_8703_b931fcae73d7
  dd1e88a5_022f_b7a5_beb9_d356fce722be["_endpoint_from_view_func()"]
  a095b8ad_24db_e31f_c7dd_d94b4dc565d0 -->|calls| dd1e88a5_022f_b7a5_beb9_d356fce722be
  style a095b8ad_24db_e31f_c7dd_d94b4dc565d0 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/flask/sansio/blueprints.py lines 87–116

    def add_url_rule(
        self,
        rule: str,
        endpoint: str | None = None,
        view_func: ft.RouteCallable | None = None,
        **options: t.Any,
    ) -> None:
        """A helper method to register a rule (and optionally a view function)
        to the application.  The endpoint is automatically prefixed with the
        blueprint's name.
        """
        if self.url_prefix is not None:
            if rule:
                rule = "/".join((self.url_prefix.rstrip("/"), rule.lstrip("/")))
            else:
                rule = self.url_prefix
        options.setdefault("subdomain", self.subdomain)
        if endpoint is None:
            endpoint = _endpoint_from_view_func(view_func)  # type: ignore
        defaults = self.url_defaults
        if "defaults" in options:
            defaults = dict(defaults, **options.pop("defaults"))

        self.app.add_url_rule(
            rule,
            f"{self.name_prefix}.{self.name}.{endpoint}".lstrip("."),
            view_func,
            defaults=defaults,
            **options,
        )