add_app_template_test() — flask Function Reference

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

Function python ApplicationCore Scaffolding calls 2 called by 1

Entity Profile

ApplicationCore→ Scaffolding→ add_app_template_test() — flask Function Reference

Dependency Diagram

graph TD
  c7990db6_32eb_56c3_6c6d_cf5cd0dbb933["add_app_template_test()"]
  0c59fa87_9a90_f011_4207_98ae96479921["Blueprint"]
  c7990db6_32eb_56c3_6c6d_cf5cd0dbb933 -->|defined in| 0c59fa87_9a90_f011_4207_98ae96479921
  6d40b5cc_a5e0_8bf9_3d39_282523ec52cb["app_template_test()"]
  6d40b5cc_a5e0_8bf9_3d39_282523ec52cb -->|calls| c7990db6_32eb_56c3_6c6d_cf5cd0dbb933
  0085606d_b5d3_d0dc_0155_6135d079c059["record_once()"]
  c7990db6_32eb_56c3_6c6d_cf5cd0dbb933 -->|calls| 0085606d_b5d3_d0dc_0155_6135d079c059
  4ff26b2e_bdce_e714_cd23_c358a75d12cb["add_template_test()"]
  c7990db6_32eb_56c3_6c6d_cf5cd0dbb933 -->|calls| 4ff26b2e_bdce_e714_cd23_c358a75d12cb
  style c7990db6_32eb_56c3_6c6d_cf5cd0dbb933 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/flask/sansio/blueprints.py lines 532–553

    def add_app_template_test(
        self, f: ft.TemplateTestCallable, name: str | None = None
    ) -> None:
        """Register a function to use as a custom Jinja test.

        The :meth:`app_template_test` decorator can be used to register a
        function by decorating instead.

        The test is available in all templates, not only those under this
        blueprint. Equivalent to :meth:`.Flask.add_template_test`.

        :param f: The function to register.
        :param name: The name to register the test as. If not given, uses the
            function's name.

        .. versionadded:: 0.10
        """

        def register_template_test(state: BlueprintSetupState) -> None:
            state.app.add_template_test(f, name=name)

        self.record_once(register_template_test)