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 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
|
"""Generate inline stubs for generic functions on func"""
# mypy: ignore-errors
from __future__ import annotations
import inspect
import re
from tempfile import NamedTemporaryFile
import textwrap
import typing
import typing_extensions
from sqlalchemy.sql.functions import _registry
from sqlalchemy.sql.functions import ReturnTypeFromArgs
from sqlalchemy.types import TypeEngine
from sqlalchemy.util.tool_support import code_writer_cmd
def _fns_in_deterministic_order():
reg = _registry["_default"]
for key in sorted(reg):
cls = reg[key]
if cls is ReturnTypeFromArgs:
continue
yield key, cls
def process_functions(filename: str, cmd: code_writer_cmd) -> str:
with (
NamedTemporaryFile(
mode="w",
delete=False,
suffix=".py",
) as buf,
open(filename) as orig_py,
):
indent = ""
in_block = False
for line in orig_py:
m = re.match(
r"^( *)# START GENERATED FUNCTION ACCESSORS",
line,
)
if m:
in_block = True
buf.write(line)
indent = m.group(1)
buf.write(
textwrap.indent(
"""
# code within this block is **programmatically,
# statically generated** by tools/generate_sql_functions.py
""",
indent,
)
)
builtins = set(dir(__builtins__))
for key, fn_class in _fns_in_deterministic_order():
is_reserved_word = key in builtins
if issubclass(fn_class, ReturnTypeFromArgs):
buf.write(
textwrap.indent(
f"""
# set ColumnElement[_T] as a separate overload, to appease mypy
# which seems to not want to accept _T from _ColumnExpressionArgument.
# this is even if all non-generic types are removed from it, so
# reasons remain unclear for why this does not work
@overload
def {key}( {' # noqa: A001' if is_reserved_word else ''}
self,
col: ColumnElement[_T],
*args: _ColumnExpressionOrLiteralArgument[Any],
**kwargs: Any,
) -> {fn_class.__name__}[_T]:
...
@overload
def {key}( {' # noqa: A001' if is_reserved_word else ''}
self,
col: _ColumnExpressionArgument[_T],
*args: _ColumnExpressionOrLiteralArgument[Any],
**kwargs: Any,
) -> {fn_class.__name__}[_T]:
...
@overload
def {key}( {' # noqa: A001' if is_reserved_word else ''}
self,
col: _ColumnExpressionOrLiteralArgument[_T],
*args: _ColumnExpressionOrLiteralArgument[Any],
**kwargs: Any,
) -> {fn_class.__name__}[_T]:
...
def {key}( {' # noqa: A001' if is_reserved_word else ''}
self,
col: _ColumnExpressionOrLiteralArgument[_T],
*args: _ColumnExpressionOrLiteralArgument[Any],
**kwargs: Any,
) -> {fn_class.__name__}[_T]:
...
""",
indent,
)
)
else:
guess_its_generic = bool(fn_class.__parameters__)
# the latest flake8 is quite broken here:
# 1. it insists on linting f-strings, no option
# to turn it off
# 2. the f-string indentation rules are either broken
# or completely impossible to figure out
# 3. there's no way to E501 a too-long f-string,
# so I can't even put the expressions all one line
# to get around the indentation errors
# 4. Therefore here I have to concat part of the
# string outside of the f-string
_type = fn_class.__name__
_type += "[Any]" if guess_its_generic else ""
_reserved_word = (
" # noqa: A001" if is_reserved_word else ""
)
# now the f-string
buf.write(
textwrap.indent(
f"""
@property
def {key}(self) -> Type[{_type}]:{_reserved_word}
...
""",
indent,
)
)
m = re.match(
r"^( *)# START GENERATED FUNCTION TYPING TESTS",
line,
)
if m:
in_block = True
buf.write(line)
indent = m.group(1)
buf.write(
textwrap.indent(
"""
# code within this block is **programmatically,
# statically generated** by tools/generate_sql_functions.py
""",
indent,
)
)
count = 0
for key, fn_class in _fns_in_deterministic_order():
if issubclass(fn_class, ReturnTypeFromArgs):
count += 1
# Would be ReturnTypeFromArgs
(orig_base,) = typing_extensions.get_original_bases(
fn_class
)
# Type parameter of ReturnTypeFromArgs
(rtype,) = typing.get_args(orig_base)
# The origin type, if rtype is a generic
orig_type = typing.get_origin(rtype)
if orig_type is not None:
coltype = rf".*{orig_type.__name__}\[.*int\]"
else:
coltype = ".*int"
buf.write(
textwrap.indent(
rf"""
stmt{count} = select(func.{key}(column('x', Integer)))
# EXPECTED_RE_TYPE: .*Select\[Tuple\[{coltype}\]\]
reveal_type(stmt{count})
""",
indent,
)
)
elif fn_class.__name__ == "aggregate_strings":
count += 1
buf.write(
textwrap.indent(
rf"""
stmt{count} = select(func.{key}(column('x', String), ','))
# EXPECTED_RE_TYPE: .*Select\[Tuple\[.*str\]\]
reveal_type(stmt{count})
""",
indent,
)
)
elif hasattr(fn_class, "type") and isinstance(
fn_class.type, TypeEngine
):
python_type = fn_class.type.python_type
python_expr = rf"Tuple\[.*{python_type.__name__}\]"
argspec = inspect.getfullargspec(fn_class)
if fn_class.__name__ == "next_value":
args = "Sequence('x_seq')"
else:
args = ", ".join(
'column("x")' for elem in argspec.args[1:]
)
count += 1
buf.write(
textwrap.indent(
rf"""
stmt{count} = select(func.{key}({args}))
# EXPECTED_RE_TYPE: .*Select\[{python_expr}\]
reveal_type(stmt{count})
""",
indent,
)
)
if in_block and line.startswith(
f"{indent}# END GENERATED FUNCTION"
):
in_block = False
if not in_block:
buf.write(line)
return buf.name
def main(cmd: code_writer_cmd) -> None:
for path in [functions_py, test_functions_py]:
destination_path = path
tempfile = process_functions(destination_path, cmd)
cmd.run_zimports(tempfile)
cmd.run_black(tempfile)
cmd.write_output_file_from_tempfile(tempfile, destination_path)
functions_py = "lib/sqlalchemy/sql/functions.py"
test_functions_py = "test/typing/plain_files/sql/functions.py"
if __name__ == "__main__":
cmd = code_writer_cmd(__file__)
with cmd.run_program():
main(cmd)
|