Skip to content
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

Jump to bottom

Add version number to Python code comments #1511

Merged
merged 2 commits into from Mar 28, 2022
Merged

Add version number to Python code comments #1511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c46c90e
feat: Add sqlc version to generated Python code
kyleconroy Mar 28, 2022
e900343
feat: Add source file to Python code comments
kyleconroy Mar 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions examples/python/src/authors/models.py
View file
Open in desktop
@@ -1,4 +1,6 @@
# Code generated by sqlc. DO NOT EDIT.
# versions:
# sqlc v1.12.0
import dataclasses
from typing import Optional

Expand Down
3 changes: 3 additions & 0 deletions examples/python/src/authors/query.py
View file
Open in desktop
@@ -1,4 +1,7 @@
# Code generated by sqlc. DO NOT EDIT.
# versions:
# sqlc v1.12.0
# source: query.sql
from typing import AsyncIterator, Iterator, Optional

import sqlalchemy
Expand Down
2 changes: 2 additions & 0 deletions examples/python/src/booktest/models.py
View file
Open in desktop
@@ -1,4 +1,6 @@
# Code generated by sqlc. DO NOT EDIT.
# versions:
# sqlc v1.12.0
import dataclasses
import datetime
import enum
Expand Down
3 changes: 3 additions & 0 deletions examples/python/src/booktest/query.py
View file
Open in desktop
@@ -1,4 +1,7 @@
# Code generated by sqlc. DO NOT EDIT.
# versions:
# sqlc v1.12.0
# source: query.sql
import dataclasses
import datetime
from typing import AsyncIterator, List, Optional
Expand Down
2 changes: 2 additions & 0 deletions examples/python/src/jets/models.py
View file
Open in desktop
@@ -1,4 +1,6 @@
# Code generated by sqlc. DO NOT EDIT.
# versions:
# sqlc v1.12.0
import dataclasses


Expand Down
3 changes: 3 additions & 0 deletions examples/python/src/jets/query-building.py
View file
Open in desktop
@@ -1,4 +1,7 @@
# Code generated by sqlc. DO NOT EDIT.
# versions:
# sqlc v1.12.0
# source: query-building.sql
from typing import AsyncIterator, Optional

import sqlalchemy
Expand Down
3 changes: 3 additions & 0 deletions examples/python/src/ondeck/city.py
View file
Open in desktop
@@ -1,4 +1,7 @@
# Code generated by sqlc. DO NOT EDIT.
# versions:
# sqlc v1.12.0
# source: city.sql
from typing import AsyncIterator, Optional

import sqlalchemy
Expand Down
2 changes: 2 additions & 0 deletions examples/python/src/ondeck/models.py
View file
Open in desktop
@@ -1,4 +1,6 @@
# Code generated by sqlc. DO NOT EDIT.
# versions:
# sqlc v1.12.0
import dataclasses
import datetime
import enum
Expand Down
3 changes: 3 additions & 0 deletions examples/python/src/ondeck/venue.py
View file
Open in desktop
@@ -1,4 +1,7 @@
# Code generated by sqlc. DO NOT EDIT.
# versions:
# sqlc v1.12.0
# source: venue.sql
import dataclasses
from typing import AsyncIterator, List, Optional

Expand Down
47 changes: 27 additions & 20 deletions internal/codegen/python/gen.go
View file
Open in desktop
Expand Up @@ -10,6 +10,7 @@ import (

"github.com/kyleconroy/sqlc/internal/codegen/sdk"
"github.com/kyleconroy/sqlc/internal/inflection"
"github.com/kyleconroy/sqlc/internal/info"
"github.com/kyleconroy/sqlc/internal/metadata"
"github.com/kyleconroy/sqlc/internal/plugin"
pyast "github.com/kyleconroy/sqlc/internal/python/ast"
Expand Down Expand Up @@ -481,6 +482,30 @@ func buildQueries(req *plugin.CodeGenRequest, structs []Struct) ([]Query, error)
return qs, nil
}

func moduleNode(source string) *pyast.Module {
mod := &pyast.Module{
Body: []*pyast.Node{
poet.Comment(
"Code generated by sqlc. DO NOT EDIT.",
),
poet.Comment(
"versions:",
),
poet.Comment(
" sqlc " + info.Version,
),
},
}
if source != "" {
mod.Body = append(mod.Body,
poet.Comment(
"source: "+source,
),
)
}
return mod
}

func importNode(name string) *pyast.Node {
return &pyast.Node{
Node: &pyast.Node_Import{
Expand Down Expand Up @@ -636,18 +661,7 @@ func buildImportGroup(specs map[string]importSpec) *pyast.Node {
}

func buildModelsTree(ctx *pyTmplCtx, i *importer) *pyast.Node {
mod := &pyast.Module{
Body: []*pyast.Node{
{
Node: &pyast.Node_Comment{
Comment: &pyast.Comment{
Text: "Code generated by sqlc. DO NOT EDIT.",
},
},
},
},
}

mod := moduleNode("")
std, pkg := i.modelImportSpecs()
mod.Body = append(mod.Body, buildImportGroup(std), buildImportGroup(pkg))

Expand Down Expand Up @@ -779,14 +793,7 @@ func asyncQuerierClassDef() *pyast.ClassDef {
}

func buildQueryTree(ctx *pyTmplCtx, i *importer, source string) *pyast.Node {
mod := &pyast.Module{
Body: []*pyast.Node{
poet.Comment(
"Code generated by sqlc. DO NOT EDIT.",
),
},
}

mod := moduleNode(source)
std, pkg := i.queryImportSpecs(source)
mod.Body = append(mod.Body, buildImportGroup(std), buildImportGroup(pkg))
mod.Body = append(mod.Body, &pyast.Node{
Expand Down
2 changes: 2 additions & 0 deletions internal/endtoend/testdata/exec_result/python_postgresql/python/models.py
View file
Open in desktop
@@ -1,4 +1,6 @@
# Code generated by sqlc. DO NOT EDIT.
# versions:
# sqlc v1.12.0
import dataclasses


Expand Down
3 changes: 3 additions & 0 deletions internal/endtoend/testdata/exec_result/python_postgresql/python/query.py
View file
Open in desktop
@@ -1,4 +1,7 @@
# Code generated by sqlc. DO NOT EDIT.
# versions:
# sqlc v1.12.0
# source: query.sql
import sqlalchemy
import sqlalchemy.ext.asyncio

Expand Down
2 changes: 2 additions & 0 deletions internal/endtoend/testdata/exec_rows/python_postgresql/python/models.py
View file
Open in desktop
@@ -1,4 +1,6 @@
# Code generated by sqlc. DO NOT EDIT.
# versions:
# sqlc v1.12.0
import dataclasses


Expand Down
3 changes: 3 additions & 0 deletions internal/endtoend/testdata/exec_rows/python_postgresql/python/query.py
View file
Open in desktop
@@ -1,4 +1,7 @@
# Code generated by sqlc. DO NOT EDIT.
# versions:
# sqlc v1.12.0
# source: query.sql
import sqlalchemy
import sqlalchemy.ext.asyncio

Expand Down