Class-based dependencies in FastAPI - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a class-based dependency in FastAPI?

A class-based dependency is a Python class used to define reusable logic that FastAPI can inject into path operations. It allows grouping related code and state in one place.

beginner

How do you make a class usable as a dependency in FastAPI?

You define a __call__ method inside the class. FastAPI treats instances of this class as callable dependencies.

intermediate

Why use class-based dependencies instead of functions in FastAPI?

Class-based dependencies help organize related logic and state together, making code cleaner and easier to maintain, especially when you need to share data or setup across multiple calls.

intermediate

How does FastAPI handle the lifecycle of class-based dependencies?

FastAPI creates a new instance of the class for each request by default, calling its __call__ method to resolve the dependency.

advanced

Can class-based dependencies have their own dependencies in FastAPI?

Yes, you can declare dependencies inside the __init__ method or __call__ method, allowing nested dependency injection.

What special method must a class have to be used as a FastAPI dependency?

A __str__

B __call__

C __init__

D __repr__

FastAPI uses the __call__ method to treat the class instance as a callable dependency.

How does FastAPI create instances of class-based dependencies by default?

A One instance per request

B It does not create instances automatically

C One instance per application startup

D One instance shared across all requests

FastAPI creates a new instance of the class for each request to keep dependencies isolated.

Where can you declare nested dependencies inside a class-based dependency?

A In both __init__ and __call__ methods

B Only in __init__ method

C Only in __call__ method

D Nested dependencies are not supported

You can declare nested dependencies in both __init__ and __call__ methods for flexibility.

What is a main benefit of using class-based dependencies?

A They avoid using async functions

B They run faster than function dependencies

C They require less code

D They allow grouping related logic and state

Class-based dependencies help organize related code and state together for cleaner design.

Which FastAPI feature allows injecting class-based dependencies into path operations?

A Request

B Response

C Depends

D Middleware

The Depends function is used to declare dependencies, including class-based ones.

Explain how to create and use a class-based dependency in FastAPI.

Think about how FastAPI treats callable classes as dependencies.

Describe the advantages of using class-based dependencies over function dependencies in FastAPI.

Consider how grouping logic and state helps in bigger projects.

Practice

1. What is the main purpose of using class-based dependencies in FastAPI?

easy

A. To automatically generate HTML forms

B. To replace all route functions with classes

C. To group related dependency logic in one reusable place

D. To handle database connections only

Solution

1. Step 1: Understand the role of class-based dependencies

   Class-based dependencies allow grouping related logic inside a class, making code cleaner and reusable.

2. Step 2: Compare options with this purpose

   Only To group related dependency logic in one reusable place correctly describes grouping related logic; others describe unrelated features.

3. Final Answer:

   To group related dependency logic in one reusable place -> Option C

4. Quick Check:

   Class-based dependencies = Group logic [OK]

Hint: Class-based dependencies group logic inside a class [OK]

Common Mistakes:

• Thinking class dependencies replace route functions
• Assuming they auto-generate HTML
• Believing they only handle databases

2. Which method must a class implement to be used as a dependency in FastAPI?

easy

A. __init__

B. __call__

C. dependency

D. run

Solution

1. Step 1: Recall FastAPI dependency requirements

   FastAPI requires the class to be callable, which means it must implement the __call__ method.

2. Step 2: Match method names to this requirement

   Only __call__ makes the class instance callable; __init__ is for initialization, others are invalid.

3. Final Answer:

   __call__ -> Option B

4. Quick Check:

   Callable class = __call__ method [OK]

Hint: Class must be callable via __call__ method [OK]

Common Mistakes:

• Choosing __init__ instead of __call__
• Using random method names like 'run'
• Confusing dependency with method name

3. Given this class-based dependency, what will be the output when accessing the endpoint?

from fastapi import FastAPI, Depends

app = FastAPI()

class Greeting:
    def __init__(self, name: str = "Guest"):
        self.name = name
    def __call__(self):
        return f"Hello, {self.name}!"

@app.get("/hello")
async def hello(greet: str = Depends(Greeting)):
    return {"message": greet}

medium

A. {"message": "Hello!"}

B. {"message": "Hello, name!"}

C. TypeError at runtime

D. {"message": "Hello, Guest!"}

Solution

1. Step 1: Analyze the Greeting class behavior

   The class sets name to "Guest" by default and __call__ returns "Hello, Guest!" string.

2. Step 2: Understand dependency injection in endpoint

   Depends(Greeting) creates an instance with default name, so greet is "Hello, Guest!" string.

3. Final Answer:

   {"message": "Hello, Guest!"} -> Option D

4. Quick Check:

   Default name used = Hello, Guest! [OK]

Hint: Default parameter used if no argument passed [OK]

Common Mistakes:

• Expecting 'name' literal instead of variable value
• Assuming runtime error without cause
• Ignoring default parameter in __init__

4. Identify the error in this class-based dependency usage:

class Counter:
    def __init__(self):
        self.count = 0

    def increment(self):
        self.count += 1

@app.get("/count")
async def get_count(counter: Counter = Depends(Counter)):
    counter.increment()
    return {"count": counter.count}

medium

A. count attribute should be a class variable

B. Counter class lacks a __call__ method

C. increment method should be async

D. Depends() cannot accept classes

Solution

1. Step 1: Trace the dependency execution flow

   Depends(Counter) creates a new instance each request; self.count = 0, increment() sets to 1, returns {"count": 1}. Count resets every request.

2. Step 2: Pinpoint the logical error

   self.count is an instance attribute (per-request); for persistent counting across requests, count must be a class attribute.

3. Final Answer:

   count attribute should be a class variable -> Option A

4. Quick Check:

   Instance attr = resets per request [OK]

Hint: Use class variables for shared state across requests [OK]

Common Mistakes:

• Thinking Depends can't accept classes
• Assuming async needed for increment
• Confusing instance and class variables

5. How can you modify this class-based dependency to accept a dynamic parameter from the request query?

class UserInfo:
    def __init__(self, user_id: int):
        self.user_id = user_id
    def __call__(self):
        return f"User ID is {self.user_id}"

@app.get("/user")
async def user(info: str = Depends(UserInfo)):
    return {"info": info}

Choose the correct way to pass user_id from query parameters.

hard

A. Use __init__(self, user_id: int = Query(...)) and import Query

B. Add user_id parameter to __call__ method instead

C. Pass user_id directly in Depends(UserInfo(user_id))

D. Use global variable for user_id inside UserInfo

Solution

1. Step 1: Understand how FastAPI injects parameters

   FastAPI injects parameters into __init__ if they have default values with Query or Body.

2. Step 2: Use Query to declare user_id in __init__

   Adding user_id: int = Query(...) in __init__ allows FastAPI to get it from query parameters.

3. Final Answer:

   Use __init__(self, user_id: int = Query(...)) and import Query -> Option A

4. Quick Check:

   Query param in __init__ = dynamic dependency [OK]

Hint: Use Query in __init__ to get query params [OK]

Common Mistakes:

• Trying to pass parameters in __call__
• Passing instance in Depends directly
• Using global variables instead of parameters