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 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
|
from __future__ import annotations
import dataclasses
import sys
from pybind11_stubgen.structs import (
Alias,
Annotation,
Argument,
Attribute,
Class,
Docstring,
Field,
Function,
Identifier,
Import,
InvalidExpression,
Method,
Modifier,
Module,
Property,
ResolvedType,
TypeVar_,
Value,
)
def indent_lines(lines: list[str], by=4) -> list[str]:
return [" " * by + line for line in lines]
class Printer:
def __init__(self, invalid_expr_as_ellipses: bool):
self.invalid_expr_as_ellipses = invalid_expr_as_ellipses
def print_alias(self, alias: Alias) -> list[str]:
return [f"{alias.name} = {alias.origin}"]
def print_attribute(self, attr: Attribute) -> list[str]:
parts = [
f"{attr.name}",
]
if attr.annotation is not None:
parts.append(f": {self.print_annotation(attr.annotation)}")
if attr.value is not None and attr.value.is_print_safe:
parts.append(f" = {self.print_value(attr.value)}")
else:
if attr.annotation is None:
parts.append(" = ...")
if attr.value is not None:
parts.append(f" # value = {self.print_value(attr.value)}")
return ["".join(parts)]
def print_argument(self, arg: Argument) -> str:
parts = []
if arg.variadic:
parts += ["*"]
if arg.kw_variadic:
parts += ["**"]
parts.append(f"{arg.name}")
if arg.annotation is not None:
parts.append(f": {self.print_annotation(arg.annotation)}")
if isinstance(arg.default, Value):
if arg.default.is_print_safe:
parts.append(f" = {self.print_value(arg.default)}")
else:
parts.append(" = ...")
elif isinstance(arg.default, InvalidExpression):
parts.append(f" = {self.print_invalid_exp(arg.default)}")
return "".join(parts)
def print_class(self, class_: Class) -> list[str]:
if class_.bases:
base_list = "(" + ", ".join(str(base) for base in class_.bases) + ")"
else:
base_list = ""
return [
f"class {class_.name}{base_list}:",
*indent_lines(self.print_class_body(class_)),
]
def print_type_var(self, type_var: TypeVar_) -> list[str]:
return [str(type_var)]
def print_class_body(self, class_: Class) -> list[str]:
result = []
if class_.doc is not None:
result.extend(self.print_docstring(class_.doc))
for sub_class in sorted(class_.classes, key=lambda c: c.name):
result.extend(self.print_class(sub_class))
modifier_order: dict[Modifier, int] = {
"static": 0,
"class": 1,
None: 2,
}
for field in sorted(
class_.fields, key=lambda f: (modifier_order[f.modifier], f.attribute.name)
):
result.extend(self.print_field(field))
for alias in sorted(class_.aliases, key=lambda a: a.name):
result.extend(self.print_alias(alias))
for method in sorted(
class_.methods, key=lambda m: (modifier_order[m.modifier], m.function.name)
):
result.extend(self.print_method(method))
for prop in sorted(class_.properties, key=lambda p: p.name):
result.extend(self.print_property(prop))
if not result:
result = ["pass"]
return result
def print_docstring(self, doc: Docstring) -> list[str]:
return [
'"""',
*(
line.replace("\\", r"\\").replace('"""', r"\"\"\"")
for line in doc.splitlines()
),
'"""',
]
def print_field(self, field: Field) -> list[str]:
return self.print_attribute(field.attribute) # FIXME: modifier
def print_function(self, func: Function) -> list[str]:
pos_only = False
kw_only = False
args = []
for arg in func.args:
if arg.variadic:
pos_only = True
kw_only = True
if not pos_only and not arg.pos_only:
pos_only = True
if sys.version_info >= (3, 8):
args.append("/")
if not kw_only and arg.kw_only:
kw_only = True
args.append("*")
args.append(self.print_argument(arg))
if len(args) > 0 and args[0] == "/":
args = args[1:]
signature = [
f"def {func.name}(",
", ".join(args),
")",
]
if func.returns is not None:
signature.append(f" -> {self.print_annotation(func.returns)}")
signature.append(":")
result: list[str] = [
*(f"@{decorator}" for decorator in func.decorators),
"".join(signature),
]
if func.doc is not None:
body = self.print_docstring(func.doc)
else:
body = ["..."]
result.extend(indent_lines(body))
return result
def print_submodule_import(self, name: Identifier) -> list[str]:
return [f"from . import {name}"]
def print_import(self, import_: Import) -> list[str]:
parent = str(import_.origin.parent)
if import_.name is None:
return [f"import {import_.origin}"]
if len(parent) == 0:
return [f"import {import_.origin} as {import_.name}"]
result = f"from {parent} import {import_.origin[-1]}"
if import_.name != import_.origin[-1]:
result += f" as {import_.name}"
return [result]
def print_method(self, method: Method) -> list[str]:
result = []
if method.modifier == "static":
result += ["@staticmethod"]
elif method.modifier == "class":
result += ["@classmethod"]
elif method.modifier is None:
pass
else:
raise RuntimeError()
result.extend(self.print_function(method.function))
return result
def print_module(self, module: Module) -> list[str]:
result = []
if module.doc is not None:
result.extend(self.print_docstring(module.doc))
for import_ in sorted(module.imports, key=lambda x: x.origin):
result.extend(self.print_import(import_))
for sub_module in module.sub_modules:
result.extend(self.print_submodule_import(sub_module.name))
# Place __all__ above everything
for attr in sorted(module.attributes, key=lambda a: a.name):
if attr.name == "__all__":
result.extend(self.print_attribute(attr))
break
for type_var in sorted(module.type_vars, key=lambda t: t.name):
result.extend(self.print_type_var(type_var))
for class_ in sorted(module.classes, key=lambda c: c.name):
result.extend(self.print_class(class_))
for func in sorted(module.functions, key=lambda f: f.name):
result.extend(self.print_function(func))
for attr in sorted(module.attributes, key=lambda a: a.name):
if attr.name != "__all__":
result.extend(self.print_attribute(attr))
for alias in module.aliases:
result.extend(self.print_alias(alias))
return result
def print_property(self, prop: Property) -> list[str]:
if not prop.getter:
# FIXME: support setter-only props
return []
# FIXME: add modifier
result = []
result.extend(
[
"@property",
*self.print_function(
dataclasses.replace(
prop.getter,
name=prop.name,
# replace getter docstring if prop.doc exists
doc=prop.doc if prop.doc is not None else prop.getter.doc,
)
),
]
)
if prop.setter:
result.extend(
[
f"@{prop.name}.setter",
*self.print_function(
dataclasses.replace(
prop.setter,
name=prop.name,
# remove setter docstring if prop.doc exists
doc=None if prop.doc is not None else prop.setter.doc,
)
),
]
)
return result
def print_value(self, value: Value) -> str:
split = value.repr.split("\n", 1)
if len(split) == 1:
return split[0]
else:
return split[0] + "..."
def print_type(self, type_: ResolvedType) -> str:
if (
str(type_.name) == "typing.Optional"
and type_.parameters is not None
and len(type_.parameters) == 1
):
return f"{self.print_annotation(type_.parameters[0])} | None"
if str(type_.name) == "typing.Union" and type_.parameters is not None:
return " | ".join(self.print_annotation(p) for p in type_.parameters)
if type_.parameters:
param_str = (
"["
+ ", ".join(self.print_annotation(p) for p in type_.parameters)
+ "]"
)
else:
param_str = ""
return f"{type_.name}{param_str}"
def print_annotation(self, annotation: Annotation) -> str:
if isinstance(annotation, ResolvedType):
return self.print_type(annotation)
elif isinstance(annotation, Value):
return self.print_value(annotation)
elif isinstance(annotation, InvalidExpression):
return self.print_invalid_exp(annotation)
else:
raise AssertionError()
def print_invalid_exp(self, invalid_expr: InvalidExpression) -> str:
if self.invalid_expr_as_ellipses:
return "..."
return invalid_expr.text
|