Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

feat: add emit_str_enum config option#66

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.

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

Already on GitHub?Sign in to your account

Merged
devstein merged 7 commits intosqlc-dev:mainfromdosu-ai:main
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
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
87 changes: 72 additions & 15 deletionsREADME.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,78 @@
## Usage

```yaml
version:'2'
version:"2"
plugins:
- name: py
wasm:
url: https://downloads.sqlc.dev/plugin/sqlc-gen-python_1.2.0.wasm
sha256: a6c5d174c407007c3717eea36ff0882744346e6ba991f92f71d6ab2895204c0e
- name: py
wasm:
url: https://downloads.sqlc.dev/plugin/sqlc-gen-python_1.2.0.wasm
sha256: a6c5d174c407007c3717eea36ff0882744346e6ba991f92f71d6ab2895204c0e
sql:
- schema: "schema.sql"
queries: "query.sql"
engine: postgresql
codegen:
- out: src/authors
plugin: py
options:
package: authors
emit_sync_querier: true
emit_async_querier: true
- schema: "schema.sql"
queries: "query.sql"
engine: postgresql
codegen:
- out: src/authors
plugin: py
options:
package: authors
emit_sync_querier: true
emit_async_querier: true
```

### Emit Pydantic Models instead of `dataclasses`

Option: `emit_pydantic_models`

By default, `sqlc-gen-python` will emit `dataclasses` for the models. If you prefer to use [`pydantic`](https://docs.pydantic.dev/latest/) models, you can enable this option.

with `emit_pydantic_models`

```py
from pydantic import BaseModel

class Author(pydantic.BaseModel):
id: int
name: str
```

without `emit_pydantic_models`

```py
import dataclasses

@dataclasses.dataclass()
class Author:
id: int
name: str
```

### Use `enum.StrEnum` for Enums

Option: `emit_str_enum`

`enum.StrEnum` was introduce in Python 3.11.

`enum.StrEnum` is a subclass of `str` that is also a subclass of `Enum`. This allows for the use of `Enum` values as strings, compared to strings, or compared to other `enum.StrEnum` types.

This is convenient for type checking and validation, as well as for serialization and deserialization.

By default, `sqlc-gen-python` will emit `(str, enum.Enum)` for the enum classes. If you prefer to use `enum.StrEnum`, you can enable this option.

with `emit_str_enum`

```py
class Status(enum.StrEnum):
"""Venues can be either open or closed"""
OPEN = "op!en"
CLOSED = "clo@sed"
```

without `emit_str_enum` (current behavior)

```py
class Status(str, enum.Enum):
"""Venues can be either open or closed"""
OPEN = "op!en"
CLOSED = "clo@sed"
```
1 change: 1 addition & 0 deletionsinternal/config.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,6 +7,7 @@ type Config struct {
Package string `json:"package"`
Out string `json:"out"`
EmitPydanticModels bool `json:"emit_pydantic_models"`
EmitStrEnum bool `json:"emit_str_enum"`
QueryParameterLimit *int32 `json:"query_parameter_limit"`
InflectionExcludeTableNames []string `json:"inflection_exclude_table_names"`
}
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ plugins:
- name: py
wasm:
url: file://../../../../bin/sqlc-gen-python.wasm
sha256: "a6c5d174c407007c3717eea36ff0882744346e6ba991f92f71d6ab2895204c0e"
sha256: "d6846ffad948181e611e883cedd2d2be66e091edc1273a0abc6c9da18399e0ca"
sql:
- schema: schema.sql
queries: query.sql
Expand Down
19 changes: 19 additions & 0 deletionsinternal/endtoend/testdata/emit_str_enum/db/models.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
# Code generated by sqlc. DO NOT EDIT.
# versions:
# sqlc v1.27.0
import dataclasses
import enum
from typing import Optional


class BookStatus(enum.StrEnum):
AVAILABLE = "available"
CHECKED_OUT = "checked_out"
OVERDUE = "overdue"


@dataclasses.dataclass()
class Book:
id: int
title: str
status: Optional[BookStatus]
111 changes: 111 additions & 0 deletionsinternal/endtoend/testdata/emit_str_enum/db/query.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
# Code generated by sqlc. DO NOT EDIT.
# versions:
# sqlc v1.27.0
# source: query.sql
from typing import AsyncIterator, Iterator, Optional

import sqlalchemy
import sqlalchemy.ext.asyncio

from db import models


CREATE_BOOK = """-- name: create_book \\:one
INSERT INTO books (
title, status
) VALUES (
:p1, :p2
) RETURNING id, title, status
"""


DELETE_BOOK = """-- name: delete_book \\:exec
DELETE FROM books
WHERE id = :p1
"""


GET_BOOK = """-- name: get_book \\:one
SELECT id, title, status FROM books
WHERE id = :p1 LIMIT 1
"""


LIST_BOOKS = """-- name: list_books \\:many
SELECT id, title, status FROM books
ORDER BY title
"""


class Querier:
def __init__(self, conn: sqlalchemy.engine.Connection):
self._conn = conn

def create_book(self, *, title: str, status: Optional[models.BookStatus]) -> Optional[models.Book]:
row = self._conn.execute(sqlalchemy.text(CREATE_BOOK), {"p1": title, "p2": status}).first()
if row is None:
return None
return models.Book(
id=row[0],
title=row[1],
status=row[2],
)

def delete_book(self, *, id: int) -> None:
self._conn.execute(sqlalchemy.text(DELETE_BOOK), {"p1": id})

def get_book(self, *, id: int) -> Optional[models.Book]:
row = self._conn.execute(sqlalchemy.text(GET_BOOK), {"p1": id}).first()
if row is None:
return None
return models.Book(
id=row[0],
title=row[1],
status=row[2],
)

def list_books(self) -> Iterator[models.Book]:
result = self._conn.execute(sqlalchemy.text(LIST_BOOKS))
for row in result:
yield models.Book(
id=row[0],
title=row[1],
status=row[2],
)


class AsyncQuerier:
def __init__(self, conn: sqlalchemy.ext.asyncio.AsyncConnection):
self._conn = conn

async def create_book(self, *, title: str, status: Optional[models.BookStatus]) -> Optional[models.Book]:
row = (await self._conn.execute(sqlalchemy.text(CREATE_BOOK), {"p1": title, "p2": status})).first()
if row is None:
return None
return models.Book(
id=row[0],
title=row[1],
status=row[2],
)

async def delete_book(self, *, id: int) -> None:
await self._conn.execute(sqlalchemy.text(DELETE_BOOK), {"p1": id})

async def get_book(self, *, id: int) -> Optional[models.Book]:
row = (await self._conn.execute(sqlalchemy.text(GET_BOOK), {"p1": id})).first()
if row is None:
return None
return models.Book(
id=row[0],
title=row[1],
status=row[2],
)

async def list_books(self) -> AsyncIterator[models.Book]:
result = await self._conn.stream(sqlalchemy.text(LIST_BOOKS))
async for row in result:
yield models.Book(
id=row[0],
title=row[1],
status=row[2],
)
18 changes: 18 additions & 0 deletionsinternal/endtoend/testdata/emit_str_enum/query.sql
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
-- name: GetBook :one
SELECT * FROM books
WHERE id = $1 LIMIT 1;

-- name: ListBooks :many
SELECT * FROM books
ORDER BY title;

-- name: CreateBook :one
INSERT INTO books (
title, status
) VALUES (
$1, $2
) RETURNING *;

-- name: DeleteBook :exec
DELETE FROM books
WHERE id = $1;
8 changes: 8 additions & 0 deletionsinternal/endtoend/testdata/emit_str_enum/schema.sql
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
CREATE TYPE book_status AS ENUM ('available', 'checked_out', 'overdue');


CREATE TABLE books (
id BIGSERIAL PRIMARY KEY,
title text NOT NULL,
status book_status DEFAULT 'available'
);
19 changes: 19 additions & 0 deletionsinternal/endtoend/testdata/emit_str_enum/sqlc.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
version: "2"
plugins:
- name: py
wasm:
url: file://../../../../bin/sqlc-gen-python.wasm
sha256: "d6846ffad948181e611e883cedd2d2be66e091edc1273a0abc6c9da18399e0ca"
sql:
- schema: schema.sql
queries: query.sql
engine: postgresql
codegen:
- plugin: py
out: db
options:
package: db
emit_sync_querier: true
emit_async_querier: true
emit_str_enum: true

2 changes: 1 addition & 1 deletioninternal/endtoend/testdata/exec_result/sqlc.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ plugins:
- name: py
wasm:
url: file://../../../../bin/sqlc-gen-python.wasm
sha256: "a6c5d174c407007c3717eea36ff0882744346e6ba991f92f71d6ab2895204c0e"
sha256: "d6846ffad948181e611e883cedd2d2be66e091edc1273a0abc6c9da18399e0ca"
sql:
- schema: schema.sql
queries: query.sql
Expand Down
2 changes: 1 addition & 1 deletioninternal/endtoend/testdata/exec_rows/sqlc.yaml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ plugins:
- name: py
wasm:
url: file://../../../../bin/sqlc-gen-python.wasm
sha256: "a6c5d174c407007c3717eea36ff0882744346e6ba991f92f71d6ab2895204c0e"
sha256: "d6846ffad948181e611e883cedd2d2be66e091edc1273a0abc6c9da18399e0ca"
sql:
- schema: schema.sql
queries: query.sql
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ plugins:
- name: py
wasm:
url: file://../../../../bin/sqlc-gen-python.wasm
sha256: "a6c5d174c407007c3717eea36ff0882744346e6ba991f92f71d6ab2895204c0e"
sha256: "d6846ffad948181e611e883cedd2d2be66e091edc1273a0abc6c9da18399e0ca"
sql:
- schema: schema.sql
queries: query.sql
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ plugins:
- name: py
wasm:
url: file://../../../../bin/sqlc-gen-python.wasm
sha256: "a6c5d174c407007c3717eea36ff0882744346e6ba991f92f71d6ab2895204c0e"
sha256: "d6846ffad948181e611e883cedd2d2be66e091edc1273a0abc6c9da18399e0ca"
sql:
- schema: schema.sql
queries: query.sql
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ plugins:
- name: py
wasm:
url: file://../../../../bin/sqlc-gen-python.wasm
sha256: "a6c5d174c407007c3717eea36ff0882744346e6ba991f92f71d6ab2895204c0e"
sha256: "d6846ffad948181e611e883cedd2d2be66e091edc1273a0abc6c9da18399e0ca"
sql:
- schema: schema.sql
queries: query.sql
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ plugins:
- name: py
wasm:
url: file://../../../../bin/sqlc-gen-python.wasm
sha256: "a6c5d174c407007c3717eea36ff0882744346e6ba991f92f71d6ab2895204c0e"
sha256: "d6846ffad948181e611e883cedd2d2be66e091edc1273a0abc6c9da18399e0ca"
sql:
- schema: schema.sql
queries: query.sql
Expand Down
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,7 @@ plugins:
- name: py
wasm:
url: file://../../../../bin/sqlc-gen-python.wasm
sha256: "a6c5d174c407007c3717eea36ff0882744346e6ba991f92f71d6ab2895204c0e"
sha256: "d6846ffad948181e611e883cedd2d2be66e091edc1273a0abc6c9da18399e0ca"
sql:
- schema: schema.sql
queries: query.sql
Expand Down
17 changes: 12 additions & 5 deletionsinternal/gen.go
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -681,12 +681,19 @@ func buildModelsTree(ctx *pyTmplCtx, i *importer) *pyast.Node {
mod.Body = append(mod.Body, buildImportGroup(std), buildImportGroup(pkg))

for _, e := range ctx.Enums {
bases := []*pyast.Node{
poet.Name("str"),
poet.Attribute(poet.Name("enum"), "Enum"),
}
if i.C.EmitStrEnum {
// override the bases to emit enum.StrEnum (only support in Python >=3.11)
bases = []*pyast.Node{
poet.Attribute(poet.Name("enum"), "StrEnum"),
}
}
def := &pyast.ClassDef{
Name: e.Name,
Bases: []*pyast.Node{
poet.Name("str"),
poet.Attribute(poet.Name("enum"), "Enum"),
},
Name: e.Name,
Bases: bases,
}
if e.Comment != "" {
def.Body = append(def.Body, &pyast.Node{
Expand Down
Loading
[8]ページ先頭
©2009-2025 Movatter.jp