1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
from argparse import ArgumentParser
from pathlib import Path
import re
import sys
from tempfile import NamedTemporaryFile
import textwrap
from mako.pygen import PythonPrinter
sys.path.append(str(Path(__file__).parent.parent))
if True: # avoid flake/zimports messing with the order
from alembic.operations.base import Operations
from alembic.runtime.environment import EnvironmentContext
from alembic.script.write_hooks import console_scripts
from alembic.util.compat import inspect_formatargspec
from alembic.util.compat import inspect_getfullargspec
IGNORE_ITEMS = {
"op": {"context", "create_module_class_proxy"},
"context": {
"create_module_class_proxy",
"get_impl",
"requires_connection",
},
}
def generate_pyi_for_proxy(
cls: type,
progname: str,
source_path: Path,
destination_path: Path,
ignore_output: bool,
ignore_items: set,
):
if sys.version_info < (3, 9):
raise RuntimeError("This script must be run with Python 3.9 or higher")
# When using an absolute path on windows, this will generate the correct
# relative path that shall be written to the top comment of the pyi file.
if Path(progname).is_absolute():
progname = Path(progname).relative_to(Path().cwd()).as_posix()
imports = []
read_imports = False
with open(source_path) as read_file:
for line in read_file:
if line.startswith("# ### this file stubs are generated by"):
read_imports = True
elif line.startswith("### end imports ###"):
read_imports = False
break
elif read_imports:
imports.append(line.rstrip())
with open(destination_path, "w") as buf:
printer = PythonPrinter(buf)
printer.writeline(
f"# ### this file stubs are generated by {progname} "
"- do not edit ###"
)
for line in imports:
buf.write(line + "\n")
printer.writeline("### end imports ###")
buf.write("\n\n")
for name in dir(cls):
if name.startswith("_") or name in ignore_items:
continue
meth = getattr(cls, name)
if callable(meth):
_generate_stub_for_meth(cls, name, printer)
else:
_generate_stub_for_attr(cls, name, printer)
printer.close()
console_scripts(
str(destination_path),
{"entrypoint": "zimports", "options": "-e"},
ignore_output=ignore_output,
)
# note that we do not distribute pyproject.toml with the distribution
# right now due to user complaints, so we can't refer to it here because
# this all has to run as part of the test suite
console_scripts(
str(destination_path),
{"entrypoint": "black", "options": "-l79"},
ignore_output=ignore_output,
)
def _generate_stub_for_attr(cls, name, printer):
type_ = cls.__annotations__.get(name, "Any")
printer.writeline(f"{name}: {type_}")
def _generate_stub_for_meth(cls, name, printer):
fn = getattr(cls, name)
while hasattr(fn, "__wrapped__"):
fn = fn.__wrapped__
spec = inspect_getfullargspec(fn)
name_args = spec[0]
assert name_args[0:1] == ["self"] or name_args[0:1] == ["cls"]
name_args[0:1] = []
def _formatannotation(annotation, base_module=None):
if getattr(annotation, "__module__", None) == "typing":
retval = repr(annotation).replace("typing.", "")
elif isinstance(annotation, type):
if annotation.__module__ in ("builtins", base_module):
retval = annotation.__qualname__
else:
retval = annotation.__module__ + "." + annotation.__qualname__
else:
retval = repr(annotation)
retval = re.sub(
r'ForwardRef\(([\'"].+?[\'"])\)', lambda m: m.group(1), retval
)
retval = re.sub("NoneType", "None", retval)
return retval
argspec = inspect_formatargspec(*spec, formatannotation=_formatannotation)
func_text = textwrap.dedent(
"""\
def %(name)s%(argspec)s:
'''%(doc)s'''
"""
% {
"name": name,
"argspec": argspec,
"doc": fn.__doc__,
}
)
printer.write_indented_block(func_text)
def run_file(
source_path: Path, cls_to_generate: type, stdout: bool, ignore_items: set
):
progname = Path(sys.argv[0]).as_posix()
if not stdout:
generate_pyi_for_proxy(
cls_to_generate,
progname,
source_path=source_path,
destination_path=source_path,
ignore_output=False,
ignore_items=ignore_items,
)
else:
with NamedTemporaryFile(delete=False, suffix=".pyi") as f:
f.close()
f_path = Path(f.name)
generate_pyi_for_proxy(
cls_to_generate,
progname,
source_path=source_path,
destination_path=f_path,
ignore_output=True,
ignore_items=ignore_items,
)
sys.stdout.write(f_path.read_text())
f_path.unlink()
def main(args):
location = Path(__file__).parent.parent / "alembic"
if args.file in {"all", "op"}:
run_file(
location / "op.pyi", Operations, args.stdout, IGNORE_ITEMS["op"]
)
if args.file in {"all", "context"}:
run_file(
location / "context.pyi",
EnvironmentContext,
args.stdout,
IGNORE_ITEMS["context"],
)
if __name__ == "__main__":
parser = ArgumentParser()
parser.add_argument(
"--file",
choices={"op", "context", "all"},
default="all",
help="Which file to generate. Default is to regenerate all files",
)
parser.add_argument(
"--stdout",
action="store_true",
help="Write to stdout instead of saving to file",
)
args = parser.parse_args()
main(args)
|
