Skip to content

fix(typegen): accept deserialized json/jsonb values in generated types for Python #1129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
h-zahar wants to merge 1 commit into from
+19 −19
Closed

fix(typegen): accept deserialized json/jsonb values in generated types for Python #1129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/server/templates/python.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ from typing import (
TypedDict,
)

from pydantic import BaseModel, Field, Json
from pydantic import BaseModel, Field, JsonValue

${concatLines(Object.values(ctx.user_enums))}

Expand Down Expand Up @@ -351,8 +351,8 @@ const PY_TYPE_MAP: Record<string, string> = {
interval: 'str',

// JSON
json: 'Json[Any]',
jsonb: 'Json[Any]',
json: 'JsonValue',
jsonb: 'JsonValue',

// Range types (can be adjusted to more complex types if needed)
int4range: 'str',
Expand Down
32 changes: 16 additions & 16 deletions test/server/typegen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6672,7 +6672,7 @@ test('typegen: python', async () => {
TypedDict,
)

from pydantic import BaseModel, Field, Json
from pydantic import BaseModel, Field, JsonValue

PublicUserStatus: TypeAlias = Literal["ACTIVE", "INACTIVE"]

Expand Down Expand Up @@ -6717,19 +6717,19 @@ test('typegen: python', async () => {
class PublicUsersAudit(BaseModel):
created_at: Optional[datetime.datetime] = Field(alias="created_at")
id: int = Field(alias="id")
previous_value: Optional[Json[Any]] = Field(alias="previous_value")
previous_value: Optional[JsonValue] = Field(alias="previous_value")
user_id: Optional[int] = Field(alias="user_id")

class PublicUsersAuditInsert(TypedDict):
created_at: NotRequired[Annotated[Optional[datetime.datetime], Field(alias="created_at")]]
id: NotRequired[Annotated[int, Field(alias="id")]]
previous_value: NotRequired[Annotated[Optional[Json[Any]], Field(alias="previous_value")]]
previous_value: NotRequired[Annotated[Optional[JsonValue], Field(alias="previous_value")]]
user_id: NotRequired[Annotated[Optional[int], Field(alias="user_id")]]

class PublicUsersAuditUpdate(TypedDict):
created_at: NotRequired[Annotated[Optional[datetime.datetime], Field(alias="created_at")]]
id: NotRequired[Annotated[int, Field(alias="id")]]
previous_value: NotRequired[Annotated[Optional[Json[Any]], Field(alias="previous_value")]]
previous_value: NotRequired[Annotated[Optional[JsonValue], Field(alias="previous_value")]]
user_id: NotRequired[Annotated[Optional[int], Field(alias="user_id")]]

class PublicUserDetails(BaseModel):
Expand Down Expand Up @@ -6779,55 +6779,55 @@ test('typegen: python', async () => {

class PublicEvents(BaseModel):
created_at: datetime.datetime = Field(alias="created_at")
data: Optional[Json[Any]] = Field(alias="data")
data: Optional[JsonValue] = Field(alias="data")
event_type: Optional[str] = Field(alias="event_type")
id: int = Field(alias="id")

class PublicEventsInsert(TypedDict):
created_at: NotRequired[Annotated[datetime.datetime, Field(alias="created_at")]]
data: NotRequired[Annotated[Optional[Json[Any]], Field(alias="data")]]
data: NotRequired[Annotated[Optional[JsonValue], Field(alias="data")]]
event_type: NotRequired[Annotated[Optional[str], Field(alias="event_type")]]
id: NotRequired[Annotated[int, Field(alias="id")]]

class PublicEventsUpdate(TypedDict):
created_at: NotRequired[Annotated[datetime.datetime, Field(alias="created_at")]]
data: NotRequired[Annotated[Optional[Json[Any]], Field(alias="data")]]
data: NotRequired[Annotated[Optional[JsonValue], Field(alias="data")]]
event_type: NotRequired[Annotated[Optional[str], Field(alias="event_type")]]
id: NotRequired[Annotated[int, Field(alias="id")]]

class PublicEvents2024(BaseModel):
created_at: datetime.datetime = Field(alias="created_at")
data: Optional[Json[Any]] = Field(alias="data")
data: Optional[JsonValue] = Field(alias="data")
event_type: Optional[str] = Field(alias="event_type")
id: int = Field(alias="id")

class PublicEvents2024Insert(TypedDict):
created_at: NotRequired[Annotated[datetime.datetime, Field(alias="created_at")]]
data: NotRequired[Annotated[Optional[Json[Any]], Field(alias="data")]]
data: NotRequired[Annotated[Optional[JsonValue], Field(alias="data")]]
event_type: NotRequired[Annotated[Optional[str], Field(alias="event_type")]]
id: Annotated[int, Field(alias="id")]

class PublicEvents2024Update(TypedDict):
created_at: NotRequired[Annotated[datetime.datetime, Field(alias="created_at")]]
data: NotRequired[Annotated[Optional[Json[Any]], Field(alias="data")]]
data: NotRequired[Annotated[Optional[JsonValue], Field(alias="data")]]
event_type: NotRequired[Annotated[Optional[str], Field(alias="event_type")]]
id: NotRequired[Annotated[int, Field(alias="id")]]

class PublicEvents2025(BaseModel):
created_at: datetime.datetime = Field(alias="created_at")
data: Optional[Json[Any]] = Field(alias="data")
data: Optional[JsonValue] = Field(alias="data")
event_type: Optional[str] = Field(alias="event_type")
id: int = Field(alias="id")

class PublicEvents2025Insert(TypedDict):
created_at: NotRequired[Annotated[datetime.datetime, Field(alias="created_at")]]
data: NotRequired[Annotated[Optional[Json[Any]], Field(alias="data")]]
data: NotRequired[Annotated[Optional[JsonValue], Field(alias="data")]]
event_type: NotRequired[Annotated[Optional[str], Field(alias="event_type")]]
id: Annotated[int, Field(alias="id")]

class PublicEvents2025Update(TypedDict):
created_at: NotRequired[Annotated[datetime.datetime, Field(alias="created_at")]]
data: NotRequired[Annotated[Optional[Json[Any]], Field(alias="data")]]
data: NotRequired[Annotated[Optional[JsonValue], Field(alias="data")]]
event_type: NotRequired[Annotated[Optional[str], Field(alias="event_type")]]
id: NotRequired[Annotated[int, Field(alias="id")]]

Expand Down Expand Up @@ -6862,23 +6862,23 @@ test('typegen: python', async () => {
category: Optional[int] = Field(alias="category")
created_at: datetime.datetime = Field(alias="created_at")
id: int = Field(alias="id")
metadata: Optional[Json[Any]] = Field(alias="metadata")
metadata: Optional[JsonValue] = Field(alias="metadata")
name: str = Field(alias="name")
status: Optional[PublicMemeStatus] = Field(alias="status")

class PublicMemesInsert(TypedDict):
category: NotRequired[Annotated[Optional[int], Field(alias="category")]]
created_at: Annotated[datetime.datetime, Field(alias="created_at")]
id: NotRequired[Annotated[int, Field(alias="id")]]
metadata: NotRequired[Annotated[Optional[Json[Any]], Field(alias="metadata")]]
metadata: NotRequired[Annotated[Optional[JsonValue], Field(alias="metadata")]]
name: Annotated[str, Field(alias="name")]
status: NotRequired[Annotated[Optional[PublicMemeStatus], Field(alias="status")]]

class PublicMemesUpdate(TypedDict):
category: NotRequired[Annotated[Optional[int], Field(alias="category")]]
created_at: NotRequired[Annotated[datetime.datetime, Field(alias="created_at")]]
id: NotRequired[Annotated[int, Field(alias="id")]]
metadata: NotRequired[Annotated[Optional[Json[Any]], Field(alias="metadata")]]
metadata: NotRequired[Annotated[Optional[JsonValue], Field(alias="metadata")]]
name: NotRequired[Annotated[str, Field(alias="name")]]
status: NotRequired[Annotated[Optional[PublicMemeStatus], Field(alias="status")]]

Expand Down