context_processor() — flask Function Reference

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

Function python ApplicationCore Scaffolding

Entity Profile

ApplicationCore→ Scaffolding→ context_processor() — flask Function Reference

Dependency Diagram

graph TD
  b0edb052_a1a0_9684_0e5d_11990bb97f08["context_processor()"]
  a813bd5c_bf41_d926_8dde_6a113d5e0018["Scaffold"]
  b0edb052_a1a0_9684_0e5d_11990bb97f08 -->|defined in| a813bd5c_bf41_d926_8dde_6a113d5e0018
  style b0edb052_a1a0_9684_0e5d_11990bb97f08 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/flask/sansio/scaffold.py lines 542–556

    def context_processor(
        self,
        f: T_template_context_processor,
    ) -> T_template_context_processor:
        """Registers a template context processor function. These functions run before
        rendering a template. The keys of the returned dict are added as variables
        available in the template.

        This is available on both app and blueprint objects. When used on an app, this
        is called for every rendered template. When used on a blueprint, this is called
        for templates rendered from the blueprint's views. To register with a blueprint
        and affect every template, use :meth:`.Blueprint.app_context_processor`.
        """
        self.template_context_processors[None].append(f)
        return f