Bug: pydantic PrivateAttr fields are inspected for type hints

[mike0sv]

Bug: pydantic PrivateAttr fields are inspected for type hints

[provinzkraut]

Okay so I think the issue here is that we don't respect the Config.underscore_attrs_are_private. IMO we simply shouldn't touch the underscore fields at all if this is set. @litestar-org/maintainers?

We actually do. This is a different issue.

[provinzkraut]

Issue here is that while we do exclude those fields from the schema, we still try to extract their type annotations.

[provinzkraut]

@mike0sv There's a fix in #3151. Can you give it a try and confirm that it solve the issue for you?

[github-actions]

This issue has been closed in #3151. The change will be included in the upcoming patch release.

[mike0sv]

I tested it and it works for MCVE, but it still fails for evidently codebase. I narrowed it down to the fact that our "Model" class is actually a generic. Here is the new MCVE

from typing import Generic, Optional, TYPE_CHECKING, TypeVar

from litestar import Litestar, post
from litestar._openapi.plugin import OpenAPIPlugin
from pydantic import BaseModel

if TYPE_CHECKING:
    from typing import Any

T = TypeVar("T")


class Model(BaseModel, Generic[T]):
    class Config:
        underscore_attrs_are_private = True

    _value: Optional["Any"]


@post("/")
def hello_world(data: Model) -> dict[str, str]:
    """Keeping the tradition alive with hello world."""
    return {"hello": "world"}


def main():
    app = Litestar(route_handlers=[hello_world], )

    app.plugins.get(OpenAPIPlugin).provide_openapi()


if __name__ == '__main__':
    main()

[provinzkraut]

This seems to be exclusive to Pydantic V1 though; I couldn't reproduce with V2.

[provinzkraut]

@mike0sv I've created a follow-up here: #3161, which seems to fix your most recent MCVE as well. Let me know if this works for you.

[github-actions]

This issue has been closed in #3161. The change will be included in the upcoming patch release.

[mike0sv]

Yes! Thanks!

[github-actions]

A fix for this issue has been released in v2.6.3