Issue number: #5098

Summary

Changes

This pull request add tests to make sure that OpenAPI is working when data validation feature of event resolvers and the use of from __future__ import annotations, as introduced by PEP 563 (Postponed Evaluation of Annotations).

Some additional information

1. This PR fix a bug when getting types from __globals__.
2. Runtime Optimization: There was a need to import annotations to ensure type definitions are ignored at runtime, aligning with PEP 563's goals.
3. We advice to use Pydantic 2.10+ at least.

While this PR make sure this is working, I'm working in additional PR's to make sure Powertools is full compatible with Pydantic 2.10+.

User experience

Before this PR the following code could fail with:

pydantic.errors.PydanticUserError: `TypeAdapter[typing.Annotated[ForwardRef('Input'), Query(PydanticUndefined)]]` is not fully defined; you should define `typing.Annotated[ForwardRef('Input'), Query(PydanticUndefined)]` and all referenced types, then call `.rebuild()` on the instance.

from __future__ import annotations

import json
from typing import TYPE_CHECKING

from aws_lambda_powertools.event_handler import APIGatewayRestResolver
from pydantic import BaseModel

if TYPE_CHECKING:
    # Actual use case imports boto stubs
    # These are giant pyi files that shouldn't be shipped at runtime
    from typing import Iterable


class Input(BaseModel):
    email: str

class Output(BaseModel):
    response: str

app = APIGatewayRestResolver(enable_validation=True)


@app.post("/hello")
def hello(event: Input) -> Output:
    return Output(response=f"Hello {event.email}")


def func(a: Iterable[int]): ...


event = {
    "path": "/hello",
    "httpMethod": "POST",
    "requestContext": {
        "requestId": "227b78aa-779d-47d4-a48e-ce62120393b8",
    },
    "body": json.dumps(
        {
            "email": "hello@test.com",
        }
    ),
}

print(app.resolve(event, {}))

Checklist

If your change doesn't seem to apply, please leave them unchecked.

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.