Skip to content

Commit 28bbdd8

Browse files
vpetrovykhvpetrovykh
committed
Consolidate CLI.
Combine all the various code generators into a single CLI tool: gel-gen. It now has a required positional argument which determines the specific mode for the genrators: `edgeql`, `pydantic`, `sqlalchemy`, `sqlmodel`, `django`.
1 parent d4a1d20 commit 28bbdd8

File tree

49 files changed

+214
-137
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+214
-137
lines changed

‎gel/_testbase.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
import gel
3939
from gel import asyncio_client
4040
from gel import blocking_client
41-
from gel.orm.introspection import get_schema_json, GelORMWarning
41+
from gel.compatibility.introspection import get_schema_json, GelORMWarning
4242
from gel.orm.sqla import ModelGenerator as SQLAModGen
4343
from gel.orm.sqlmodel import ModelGenerator as SQLModGen
4444
from gel.orm.django.generator import ModelGenerator as DjangoModGen

‎gel/codegen/cli.py‎

Lines changed: 80 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,16 @@
1919

2020
import argparse
2121
import sys
22+
import warnings
2223

23-
from . import generator, models
24+
import gel
25+
26+
from gel.codegen import generator, models
27+
from gel.compatibility.introspection import get_schema_json, GelORMWarning
28+
from gel.compatibility.clihelper import _get_conn_args
29+
from gel.orm.sqla import ModelGenerator as SQLAModGen
30+
from gel.orm.sqlmodel import ModelGenerator as SQLModGen
31+
from gel.orm.django.generator import ModelGenerator as DjangoModGen
2432

2533

2634
class ColoredArgumentParser(argparse.ArgumentParser):
@@ -34,7 +42,15 @@ def error(self, message):
3442

3543

3644
parser = ColoredArgumentParser(
37-
description="Generate Python code for .edgeql files."
45+
description="Generate Python code for various Gel interfaces."
46+
)
47+
parser.add_argument(
48+
"mode",
49+
choices=['edgeql', 'pydantic', 'sqlalchemy', 'sqlmodel', 'django'],
50+
help="Pick which mode to generate code for: "
51+
"`edgeql` makes Python code for .edgeql files; "
52+
"`pydantic` makes Pydantic models based on the database schema; "
53+
"`sqlalchemy`, `sqlmodel`, `django` makes Python ORM code for a database",
3854
)
3955
parser.add_argument("--dsn")
4056
parser.add_argument("--credentials-file", metavar="PATH")
@@ -69,11 +85,13 @@ def error(self, message):
6985
help="Choose one or more targets to generate code (default is async)."
7086
)
7187
parser.add_argument(
72-
"--models",
73-
action="store_true",
74-
default=False,
75-
help="Using the schema generate Pydantic models that can be used for "
76-
"bulk inserts.",
88+
"--out",
89+
help="The output directory for the generated files.",
90+
)
91+
parser.add_argument(
92+
"--mod",
93+
help="The fullname of the Python module corresponding to the output "
94+
"directory.",
7795
)
7896
if sys.version_info[:2] >= (3, 9):
7997
parser.add_argument(
@@ -101,10 +119,59 @@ def error(self, message):
101119

102120
def main():
103121
args = parser.parse_args()
104-
if args.models:
105-
models.Generator(args).run()
106-
return
107122

108-
if not hasattr(args, "skip_pydantic_validation"):
109-
args.skip_pydantic_validation = True
110-
generator.Generator(args).run()
123+
match args.mode:
124+
case 'edgeql':
125+
if not hasattr(args, "skip_pydantic_validation"):
126+
args.skip_pydantic_validation = True
127+
generator.Generator(args).run()
128+
129+
case 'pydantic':
130+
models.Generator(args).run()
131+
132+
case 'sqlalchemy':
133+
if args.mod is None:
134+
parser.error('sqlalchemy requires to specify --mod')
135+
136+
with warnings.catch_warnings(record=True) as wlist:
137+
warnings.simplefilter("always", GelORMWarning)
138+
spec = get_schema_json(
139+
gel.create_client(**generator._get_conn_args(args)))
140+
gen = SQLAModGen(
141+
outdir=args.out,
142+
basemodule=args.mod,
143+
)
144+
gen.render_models(spec)
145+
146+
for w in wlist:
147+
print(w.message)
148+
149+
case 'sqlmodel':
150+
if args.mod is None:
151+
parser.error('sqlmodel requires to specify --mod')
152+
153+
with warnings.catch_warnings(record=True) as wlist:
154+
warnings.simplefilter("always", GelORMWarning)
155+
spec = get_schema_json(
156+
gel.create_client(**_get_conn_args(args)))
157+
gen = SQLModGen(
158+
outdir=args.out,
159+
basemodule=args.mod,
160+
)
161+
gen.render_models(spec)
162+
163+
for w in wlist:
164+
print(w.message)
165+
166+
case 'django':
167+
with warnings.catch_warnings(record=True) as wlist:
168+
warnings.simplefilter("always", GelORMWarning)
169+
spec = get_schema_json(
170+
gel.create_client(**_get_conn_args(args)))
171+
gen = DjangoModGen(
172+
out=args.out,
173+
)
174+
gen.render_models(spec)
175+
176+
for w in wlist:
177+
print(w.message)

‎gel/codegen/generator.py‎

Lines changed: 1 addition & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
#
1818

1919
import argparse
20-
import getpass
2120
import io
2221
import os
2322
import pathlib
@@ -30,6 +29,7 @@
3029
from gel import describe
3130
from gel.con_utils import find_gel_project_dir
3231
from gel.color import get_color
32+
from gel.compatibility.clihelper import print_msg, print_error, _get_conn_args
3333

3434

3535
C = get_color()
@@ -113,44 +113,6 @@ def __get_validators__(cls):
113113
"""
114114

115115

116-
def print_msg(msg):
117-
print(msg, file=sys.stderr)
118-
119-
120-
def print_error(msg):
121-
print_msg(f"{C.BOLD}{C.FAIL}error: {C.ENDC}{C.BOLD}{msg}{C.ENDC}")
122-
123-
124-
def _get_conn_args(args: argparse.Namespace):
125-
if args.password_from_stdin:
126-
if args.password:
127-
print_error(
128-
"--password and --password-from-stdin are "
129-
"mutually exclusive",
130-
)
131-
sys.exit(22)
132-
if sys.stdin.isatty():
133-
password = getpass.getpass()
134-
else:
135-
password = sys.stdin.read().strip()
136-
else:
137-
password = args.password
138-
if args.dsn and args.instance:
139-
print_error("--dsn and --instance are mutually exclusive")
140-
sys.exit(22)
141-
return dict(
142-
dsn=args.dsn or args.instance,
143-
credentials_file=args.credentials_file,
144-
host=args.host,
145-
port=args.port,
146-
database=args.database,
147-
user=args.user,
148-
password=password,
149-
tls_ca_file=args.tls_ca_file,
150-
tls_security=args.tls_security,
151-
)
152-
153-
154116
class Generator:
155117
def __init__(self, args: argparse.Namespace):
156118
self._default_module = "default"

‎gel/codegen/models.py‎

Lines changed: 2 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
#
1818

1919
import argparse
20-
import getpass
2120
import io
2221
import os
2322
import pathlib
@@ -35,7 +34,8 @@
3534
from gel.con_utils import find_gel_project_dir
3635
from gel.color import get_color
3736

38-
from gel.orm.introspection import FilePrinter, get_mod_and_name
37+
from gel.compatibility.introspection import FilePrinter, get_mod_and_name
38+
from gel.compatibility.clihelper import print_msg, print_error, _get_conn_args
3939

4040

4141
C = get_color()
@@ -95,43 +95,6 @@
9595
)
9696

9797

98-
def print_msg(msg):
99-
print(msg, file=sys.stderr)
100-
101-
102-
def print_error(msg):
103-
print_msg(f"{C.BOLD}{C.FAIL}error: {C.ENDC}{C.BOLD}{msg}{C.ENDC}")
104-
105-
106-
def _get_conn_args(args: argparse.Namespace):
107-
if args.password_from_stdin:
108-
if args.password:
109-
print_error(
110-
"--password and --password-from-stdin are "
111-
"mutually exclusive",
112-
)
113-
sys.exit(22)
114-
if sys.stdin.isatty():
115-
password = getpass.getpass()
116-
else:
117-
password = sys.stdin.read().strip()
118-
else:
119-
password = args.password
120-
if args.dsn and args.instance:
121-
print_error("--dsn and --instance are mutually exclusive")
122-
sys.exit(22)
123-
return dict(
124-
dsn=args.dsn or args.instance,
125-
credentials_file=args.credentials_file,
126-
host=args.host,
127-
port=args.port,
128-
database=args.database,
129-
user=args.user,
130-
password=password,
131-
tls_ca_file=args.tls_ca_file,
132-
tls_security=args.tls_security,
133-
)
134-
13598
INTRO_QUERY = '''
13699
with module schema
137100
select ObjectType {

‎gel/compatibility/__init__.py‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#
2+
# This source file is part of the EdgeDB open source project.
3+
#
4+
# Copyright 2025-present MagicStack Inc. and the EdgeDB authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#

‎gel/compatibility/clihelper.py‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
#
2+
# This source file is part of the EdgeDB open source project.
3+
#
4+
# Copyright 2025-present MagicStack Inc. and the EdgeDB authors.
5+
#
6+
# Licensed under the Apache License, Version 2.0 (the "License");
7+
# you may not use this file except in compliance with the License.
8+
# You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#
18+
19+
import argparse
20+
import getpass
21+
import sys
22+
23+
from gel.color import get_color
24+
25+
26+
C = get_color()
27+
28+
29+
def print_msg(msg):
30+
print(msg, file=sys.stderr)
31+
32+
33+
def print_error(msg):
34+
print_msg(f"{C.BOLD}{C.FAIL}error: {C.ENDC}{C.BOLD}{msg}{C.ENDC}")
35+
36+
37+
def _get_conn_args(args: argparse.Namespace):
38+
if args.password_from_stdin:
39+
if args.password:
40+
print_error(
41+
"--password and --password-from-stdin are "
42+
"mutually exclusive",
43+
)
44+
sys.exit(22)
45+
if sys.stdin.isatty():
46+
password = getpass.getpass()
47+
else:
48+
password = sys.stdin.read().strip()
49+
else:
50+
password = args.password
51+
if args.dsn and args.instance:
52+
print_error("--dsn and --instance are mutually exclusive")
53+
sys.exit(22)
54+
return dict(
55+
dsn=args.dsn or args.instance,
56+
credentials_file=args.credentials_file,
57+
host=args.host,
58+
port=args.port,
59+
database=args.database,
60+
user=args.user,
61+
password=password,
62+
tls_ca_file=args.tls_ca_file,
63+
tls_security=args.tls_security,
64+
)

‎gel/orm/introspection.py‎ renamed to ‎gel/compatibility/introspection.py‎

File renamed without changes.

‎gel/compatibility/pydmodels.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626
import gel
2727

28-
from gel.orm.introspection import FilePrinter, get_mod_and_name
28+
from gel.compatibility.introspection import FilePrinter, get_mod_and_name
2929

3030

3131
# FIXME: this should be replaced with a special Annotated value using the

‎gel/orm/cli.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222

2323
import gel
2424

25-
from gel.codegen.generator import _get_conn_args
26-
from .introspection import get_schema_json, GelORMWarning
25+
from gel.compatibility.introspection import get_schema_json, GelORMWarning
26+
from gel.compatibility.clihelper import _get_conn_args
2727
from .sqla import ModelGenerator as SQLAModGen
2828
from .sqlmodel import ModelGenerator as SQLModGen
2929
from .django.generator import ModelGenerator as DjangoModGen

‎gel/orm/django/generator.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
import re
33
import warnings
44

5-
from ..introspection import get_mod_and_name, GelORMWarning, FilePrinter
5+
from gel.compatibility.introspection import get_mod_and_name
6+
from gel.compatibility.introspection import GelORMWarning, FilePrinter
67

78

89
GEL_SCALAR_MAP = {

0 commit comments

Comments
 (0)