Macros for reusable components in Flask

Introduction

Macros help you write small reusable pieces of HTML code once and use them many times. This saves time and keeps your templates clean.

When you have a button style used in many places on your website.

When you want to create a common form input that repeats in different pages.

When you need to show a user profile card in multiple templates.

When you want to keep your HTML templates organized and avoid repeating code.

Syntax

Flask

{% macro macro_name(parameters) %}
  <!-- HTML code here -->
{% endmacro %}

{{ macro_name(arguments) }}

Macros are defined inside Jinja2 templates using {% macro %} and {% endmacro %}.

You call a macro by writing {{ macro_name() }} with any needed arguments.

Examples

This macro creates a simple button with the text you provide.

Flask

{% macro button(text) %}
  <button>{{ text }}</button>
{% endmacro %}

{{ button('Click me') }}

This macro creates a colored alert box. You can change the alert type like 'success' or 'error'.

Flask

{% macro alert(message, type='info') %}
  <div class="alert alert-{{ type }}">{{ message }}</div>
{% endmacro %}

{{ alert('Success!', 'success') }}

Sample Program

This example shows how to define a card macro in one template file and import it in another. Then you use the macro to create multiple cards with different content.

Flask

{# templates/macros.html #}
{% macro card(title, content) %}
  <div class="card">
    <h2>{{ title }}</h2>
    <p>{{ content }}</p>
  </div>
{% endmacro %}

{# templates/index.html #}
{% import 'macros.html' as ui %}

<html lang="en">
<head><title>Macro Example</title></head>
<body>
  {{ ui.card('Welcome', 'This is a reusable card component.') }}
  {{ ui.card('Note', 'You can reuse this card anywhere.') }}
</body>
</html>

Important Notes

Always import macros with a name to avoid conflicts.

Macros can accept default values for parameters to make them flexible.

Use macros to keep your templates DRY (Don't Repeat Yourself).

Summary

Macros let you write reusable HTML blocks in Flask templates.

Define macros with {% macro %} and call them with {{ macro_name() }}.

Import macros from other templates to organize your code better.

Practice

1. What is the main purpose of using {% macro %} in Flask templates?

easy

A. To create reusable blocks of HTML code

B. To define Python functions inside templates

C. To import external CSS files

D. To handle form submissions

Solution

1. Step 1: Understand what macros do in Flask templates

   Macros are used to write reusable HTML blocks that can be called multiple times to avoid repetition.

2. Step 2: Compare options with macro purpose

   Only To create reusable blocks of HTML code correctly describes macros as reusable HTML blocks. Other options describe unrelated tasks.

3. Final Answer:

   To create reusable blocks of HTML code -> Option A

4. Quick Check:

   Macros = reusable HTML blocks [OK]

Hint: Macros create reusable HTML snippets in templates [OK]

Common Mistakes:

• Thinking macros define Python functions
• Confusing macros with CSS imports
• Assuming macros handle form data

2. Which of the following is the correct syntax to define a macro named button that takes a parameter label?

easy

A. {% define button(label) %} {{ label }} {% enddefine %}

B. {% macro button(label) %} {{ label }} {% endmacro %}

C. {{ macro button(label) }} {{ label }} {{ endmacro }}

D. <% macro button(label) %> {{ label }} <% endmacro %>

Solution

1. Step 1: Recall correct macro syntax in Flask Jinja templates

   Macros are defined with {% macro name(params) %} ... {% endmacro %} tags.

2. Step 2: Check each option's syntax

   {% macro button(label) %} {{ label }} {% endmacro %} uses correct {% %} tags and endmacro. Others use wrong delimiters or keywords.

3. Final Answer:

   {% macro button(label) %} <button>{{ label }}</button> {% endmacro %} -> Option B

4. Quick Check:

   Macro syntax = {% macro %} ... {% endmacro %} [OK]

Hint: Use {% macro %} and {% endmacro %} to define macros [OK]

Common Mistakes:

• Using {{ }} instead of {% %} for macro definition
• Using incorrect keywords like define or <% %>
• Forgetting the endmacro tag

3. Given the macro defined in macros.html as:

{% raw %}{% macro greet(name) %}Hello, {{ name }}!{% endmacro %}{% endraw %}

And imported in index.html with:

{% raw %}{% import 'macros.html' as m %}{% endraw %}

What will be the output of {{ m.greet('Alice') }} in index.html?

medium

A. Error: macro not found

B. {{ m.greet('Alice') }}

C. greet('Alice')

D. Hello, Alice!

Solution

1. Step 1: Understand macro import and usage

   The macro greet(name) returns 'Hello, {{ name }}!'. Importing as m allows calling m.greet('Alice').

2. Step 2: Evaluate the macro call output

   Calling m.greet('Alice') replaces {{ name }} with 'Alice', so output is 'Hello, Alice!'.

3. Final Answer:

   Hello, Alice! -> Option D

4. Quick Check:

   Macro call with parameter = rendered string [OK]

Hint: Imported macros called with alias render output [OK]

Common Mistakes:

• Expecting literal macro call text instead of rendered output
• Forgetting to import macros before use
• Confusing macro call syntax with variable output

4. What is wrong with this macro usage in a Flask template?

{% raw %}{% macro card(title) %}
{{ title }}
{% endmacro %}{% endraw %}
{{ card() }}

medium

A. The macro is not properly closed with {% endmacro %}

B. Macros cannot return HTML elements

C. The macro is called without the required parameter

D. The macro name is invalid

Solution

1. Step 1: Check macro definition and parameters

   The macro card requires one parameter: title.

2. Step 2: Check macro call

   The call {{ card() }} provides no argument, causing an error due to missing parameter.

3. Final Answer:

   The macro is called without the required parameter -> Option C

4. Quick Check:

   Missing macro argument = error [OK]

Hint: Always pass required parameters when calling macros [OK]

Common Mistakes:

• Calling macros without required arguments
• Thinking macros must return plain text only
• Missing endmacro tag (not the case here)

5. You want to create a reusable navigation bar macro that highlights the current page. Which approach correctly uses macros and parameters to achieve this?

hard

A. {% raw %}{% macro navbar(current) %}HomeAbout{% endmacro %}{% endraw %} Then call with {{ navbar('about') }}

B. {% raw %}{% macro navbar() %}HomeAbout{% endmacro %}{% endraw %} Then call with {{ navbar() }}

C. {% raw %}{% macro navbar(current) %}HomeAbout{% endmacro %}{% endraw %} Then call with {{ navbar('home') }}

D. {% raw %}{% macro navbar(current) %}HomeAbout{% endmacro %}{% endraw %} Then call with {{ navbar('home') }}

Solution

1. Step 1: Understand the need for dynamic class assignment

   The macro should accept a parameter to know which page is current and add 'active' class accordingly.

2. Step 2: Analyze each option's approach

   {% raw %}{% macro navbar(current) %}
   HomeAbout
   {% endmacro %}{% endraw %} Then call with {{ navbar('about') }} uses a parameter and conditional expression to add 'active' class only to the current page link. Others either hardcode classes or ignore the parameter.

3. Final Answer:

   Uses parameters and conditional logic to highlight current page -> Option A

4. Quick Check:

   Dynamic class with parameter = correct navbar macro [OK]

Hint: Use macro parameters with conditionals for dynamic HTML [OK]

Common Mistakes:

• Hardcoding active class without parameters
• Ignoring the current page parameter
• Assigning 'current' class to all links