summaryrefslogtreecommitdiff
path: root/sphinx/pycode/ast.py
diff options
context:
space:
mode:
Diffstat (limited to 'sphinx/pycode/ast.py')
-rw-r--r--sphinx/pycode/ast.py100
1 files changed, 99 insertions, 1 deletions
diff --git a/sphinx/pycode/ast.py b/sphinx/pycode/ast.py
index 22207b715..4d8aa8955 100644
--- a/sphinx/pycode/ast.py
+++ b/sphinx/pycode/ast.py
@@ -9,6 +9,7 @@
"""
import sys
+from typing import Dict, List, Type
if sys.version_info > (3, 8):
import ast
@@ -20,6 +21,29 @@ else:
import ast # type: ignore
+OPERATORS = {
+ ast.Add: "+",
+ ast.And: "and",
+ ast.BitAnd: "&",
+ ast.BitOr: "|",
+ ast.BitXor: "^",
+ ast.Div: "/",
+ ast.FloorDiv: "//",
+ ast.Invert: "~",
+ ast.LShift: "<<",
+ ast.MatMult: "@",
+ ast.Mult: "*",
+ ast.Mod: "%",
+ ast.Not: "not",
+ ast.Pow: "**",
+ ast.Or: "or",
+ ast.RShift: ">>",
+ ast.Sub: "-",
+ ast.UAdd: "+",
+ ast.USub: "-",
+} # type: Dict[Type[ast.AST], str]
+
+
def parse(code: str, mode: str = 'exec') -> "ast.AST":
"""Parse the *code* using built-in ast or typed_ast.
@@ -40,8 +64,22 @@ def unparse(node: ast.AST) -> str:
return None
elif isinstance(node, str):
return node
+ elif node.__class__ in OPERATORS:
+ return OPERATORS[node.__class__]
+ elif isinstance(node, ast.arg):
+ if node.annotation:
+ return "%s: %s" % (node.arg, unparse(node.annotation))
+ else:
+ return node.arg
+ elif isinstance(node, ast.arguments):
+ return unparse_arguments(node)
elif isinstance(node, ast.Attribute):
return "%s.%s" % (unparse(node.value), node.attr)
+ elif isinstance(node, ast.BinOp):
+ return " ".join(unparse(e) for e in [node.left, node.op, node.right])
+ elif isinstance(node, ast.BoolOp):
+ op = " %s " % unparse(node.op)
+ return op.join(unparse(e) for e in node.values)
elif isinstance(node, ast.Bytes):
return repr(node.s)
elif isinstance(node, ast.Call):
@@ -58,7 +96,7 @@ def unparse(node: ast.AST) -> str:
elif isinstance(node, ast.Index):
return unparse(node.value)
elif isinstance(node, ast.Lambda):
- return "<function <lambda>>" # TODO
+ return "lambda %s: ..." % unparse(node.args)
elif isinstance(node, ast.List):
return "[" + ", ".join(unparse(e) for e in node.elts) + "]"
elif isinstance(node, ast.Name):
@@ -73,6 +111,8 @@ def unparse(node: ast.AST) -> str:
return repr(node.s)
elif isinstance(node, ast.Subscript):
return "%s[%s]" % (unparse(node.value), unparse(node.slice))
+ elif isinstance(node, ast.UnaryOp):
+ return "%s %s" % (unparse(node.op), unparse(node.operand))
elif isinstance(node, ast.Tuple):
return ", ".join(unparse(e) for e in node.elts)
elif sys.version_info > (3, 6) and isinstance(node, ast.Constant):
@@ -80,3 +120,61 @@ def unparse(node: ast.AST) -> str:
return repr(node.value)
else:
raise NotImplementedError('Unable to parse %s object' % type(node).__name__)
+
+
+def unparse_arguments(node: ast.arguments) -> str:
+ """Unparse an arguments to string."""
+ defaults = list(node.defaults)
+ positionals = len(node.args)
+ posonlyargs = 0
+ if hasattr(node, "posonlyargs"): # for py38+
+ posonlyargs += len(node.posonlyargs) # type:ignore
+ positionals += posonlyargs
+ for _ in range(len(defaults), positionals):
+ defaults.insert(0, None)
+
+ kw_defaults = list(node.kw_defaults)
+ for _ in range(len(kw_defaults), len(node.kwonlyargs)):
+ kw_defaults.insert(0, None)
+
+ args = [] # type: List[str]
+ if hasattr(node, "posonlyargs"): # for py38+
+ for i, arg in enumerate(node.posonlyargs): # type: ignore
+ name = unparse(arg)
+ if defaults[i]:
+ if arg.annotation:
+ name += " = %s" % unparse(defaults[i])
+ else:
+ name += "=%s" % unparse(defaults[i])
+ args.append(name)
+
+ if node.posonlyargs: # type: ignore
+ args.append('/')
+
+ for i, arg in enumerate(node.args):
+ name = unparse(arg)
+ if defaults[i + posonlyargs]:
+ if arg.annotation:
+ name += " = %s" % unparse(defaults[i + posonlyargs])
+ else:
+ name += "=%s" % unparse(defaults[i + posonlyargs])
+ args.append(name)
+
+ if node.vararg:
+ args.append("*" + unparse(node.vararg))
+
+ if node.kwonlyargs and not node.vararg:
+ args.append('*')
+ for i, arg in enumerate(node.kwonlyargs):
+ name = unparse(arg)
+ if kw_defaults[i]:
+ if arg.annotation:
+ name += " = %s" % unparse(kw_defaults[i])
+ else:
+ name += "=%s" % unparse(kw_defaults[i])
+ args.append(name)
+
+ if node.kwarg:
+ args.append("**" + unparse(node.kwarg))
+
+ return ", ".join(args)