Skip to content

Flask

Flask provider example.

This modules defines a simple provider which will be tested with Pact in the provider test. As Pact is a consumer-driven framework, the consumer defines the contract which the provider must then satisfy.

The provider is the application which receives requests from another service (the consumer) and returns a response. In this example, we have a simple endpoint which returns a user's information from a (fake) database.

Note that the code in this module is agnostic of Pact. The pact-python dependency only appears in the tests. This is because the consumer is not concerned with Pact, only the tests are.

Attributes

FAKE_DB: Dict[int, Dict[str, Any]] = {} module-attribute

app = Flask(__name__) module-attribute

As this is a simple example, we'll use a simple dict to represent a database. This would be replaced with a real database in a real application.

When testing the provider in a real application, the calls to the database would be mocked out to avoid the need for a real database. An example of this can be found in the test suite.

Functions

get_user_by_id(uid: int) -> Union[Dict[str, Any], tuple[Dict[str, Any], int]]

Fetch a user by their ID.

PARAMETER DESCRIPTION
uid

The ID of the user to fetch

TYPE: int

RETURNS DESCRIPTION
Union[Dict[str, Any], tuple[Dict[str, Any], int]]

The user data if found, HTTP 404 if not
Source code in examples/src/flask.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
@app.route("/users/<uid>")
def get_user_by_id(uid: int) -> Union[Dict[str, Any], tuple[Dict[str, Any], int]]:
    """
    Fetch a user by their ID.

    Args:
        uid: The ID of the user to fetch

    Returns:
        The user data if found, HTTP 404 if not
    """
    user = FAKE_DB.get(uid)
    if not user:
        return {"error": "User not found"}, 404
    return user