Application factory pattern preview in Flask - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the Application Factory pattern in Flask?

It is a way to create Flask app instances inside a function. This helps to configure and initialize the app only when needed, making the app more flexible and testable.

beginner

Why use the Application Factory pattern instead of creating a Flask app directly?

It allows you to create multiple app instances with different settings, helps with testing by creating fresh apps, and supports extensions that need to be initialized with the app later.

beginner

Which Flask function is commonly used to create an app in the Application Factory pattern?

The function is usually named create_app(). It returns a new Flask app instance configured inside the function.

intermediate

How do you register blueprints in the Application Factory pattern?

Inside the create_app() function, after creating the app instance, you call app.register_blueprint() for each blueprint you want to add.

intermediate

What is one key advantage of delaying app creation until runtime in Flask?

It allows you to pass different configurations or environment variables when creating the app, making your app adaptable to different situations like testing or production.

What does the Application Factory pattern in Flask primarily help with?

A Creating app instances only when needed

B Automatically generating HTML templates

C Replacing Flask's routing system

D Managing database migrations

The Application Factory pattern helps by creating Flask app instances inside a function only when needed.

Where do you usually register blueprints in the Application Factory pattern?

A Inside the create_app() function

B In the main.py file outside any function

C In the blueprint's __init__.py only

D In the config.py file

Blueprints are registered inside the create_app() function after the app instance is created.

Which of these is a benefit of using the Application Factory pattern?

A Automatic user authentication

B Faster HTML rendering

C Easier testing with fresh app instances

D Built-in CSS styling

The pattern allows creating fresh app instances for testing, improving test isolation.

What is the typical name of the function that creates the Flask app in this pattern?

A start_flask

B create_app

C init_blueprints

D run_server

The function is commonly named create_app() to create and return the Flask app instance.

How does the Application Factory pattern help with configuration?

A It removes the need for environment variables

B It disables configuration files

C It hardcodes settings in the app

D It allows passing different configs when creating the app

You can pass different configurations or environment variables to the create_app() function to customize the app.

Explain the Application Factory pattern in Flask and why it is useful.

Think about how creating the app inside a function helps with flexibility and testing.

Describe how you would organize a Flask app using the Application Factory pattern.

Focus on what happens inside the create_app function.

Practice

1. What is the main purpose of the application factory pattern in Flask?

easy

A. To avoid using blueprints and extensions

B. To write all routes directly in the main script without functions

C. To automatically generate HTML templates

D. To create the Flask app inside a function for better configuration and testing

Solution

1. Step 1: Understand the pattern's purpose

   The application factory pattern creates the Flask app inside a function instead of a global variable.

2. Step 2: Benefits of this approach

   This allows flexible configuration, easier testing, and clean registration of extensions and blueprints.

3. Final Answer:

   To create the Flask app inside a function for better configuration and testing -> Option D

4. Quick Check:

   Application factory = create app in function [OK]

Hint: Remember: factory means 'make inside a function' [OK]

Common Mistakes:

• Thinking app is created globally
• Confusing with blueprint usage
• Assuming it auto-generates templates

2. Which of the following is the correct way to define an application factory function in Flask?

easy

A. def create_app():\n app = Flask\n return app

B. app = Flask(__name__)\ndef create_app():\n return app

C. def create_app():\n app = Flask(__name__)\n return app

D. def create_app():\n return Flask

Solution

1. Step 1: Check function definition and app creation

   The factory function must create a Flask instance inside it using Flask(__name__)

2. Step 2: Verify return of the app instance

   The function should return the created app instance, not the class or a global variable.

3. Final Answer:

   def create_app():\n app = Flask(__name__)\n return app -> Option C

4. Quick Check:

   Factory returns new Flask instance [OK]

Hint: Create and return app inside function with Flask(__name__) [OK]

Common Mistakes:

• Returning Flask class instead of instance
• Using global app outside function
• Not calling Flask with parentheses

3. Given this code snippet, what will print(app.config['DEBUG']) output?

def create_app():
    app = Flask(__name__)
    app.config['DEBUG'] = True
    return app

app = create_app()
print(app.config['DEBUG'])

medium

A. True

B. False

C. None

D. KeyError

Solution

1. Step 1: Analyze config setting inside factory

   The factory sets app.config['DEBUG'] = True before returning the app.

2. Step 2: Check printed value after app creation

   After calling create_app(), app.config['DEBUG'] is True, so printing it outputs True.

3. Final Answer:

   True -> Option A

4. Quick Check:

   Config set to True inside factory [OK]

Hint: Config set inside factory is available after app creation [OK]

Common Mistakes:

• Assuming default DEBUG is False
• Expecting KeyError for missing key
• Confusing config with environment variables

4. Identify the error in this application factory code:

def create_app():
    app = Flask(__name__)
    app.register_blueprint(main)
    return app

app = create_app()

Assume main is a blueprint imported correctly.

medium

A. No error, code is correct

B. Missing app context push before registering blueprint

C. Blueprint must be registered before app creation

D. Blueprint registration should happen inside a separate function

Solution

1. Step 1: Check blueprint registration timing

   Blueprints are registered on the app instance inside the factory function, which is correct.

2. Step 2: Verify app context and function structure

   No app context push is needed for registration; the code is valid and follows the pattern.

3. Final Answer:

   No error, code is correct -> Option A

4. Quick Check:

   Blueprint registered inside factory is valid [OK]

Hint: Register blueprints inside factory before returning app [OK]

Common Mistakes:

• Thinking app context is needed for registration
• Trying to register blueprint before app exists
• Separating registration unnecessarily

5. You want to add a Flask extension (e.g., Flask-Migrate) using the application factory pattern. Which approach is correct?

hard

A. Create the extension instance inside the factory function only

B. Initialize the extension globally, then call init_app(app) inside the factory

C. Initialize the extension after app creation outside the factory

D. Pass the app instance as a parameter to the extension constructor inside the factory

Solution

1. Step 1: Understand extension initialization pattern

   Extensions are usually created globally without app, then initialized with app inside the factory using init_app(app).

2. Step 2: Why not create inside factory?

   Creating inside factory loses global access; initializing outside factory after app creation breaks pattern.

3. Final Answer:

   Initialize the extension globally, then call init_app(app) inside the factory -> Option B

4. Quick Check:

   Global extension + init_app(app) inside factory [OK]

Hint: Create extension globally, init inside factory [OK]

Common Mistakes:

• Creating extension instance inside factory only
• Initializing extension outside factory after app creation
• Passing app to extension constructor inside factory