blob: 751ea6f648425e2bcd776ae07432813b5e87dfdc [file] [log] [blame]
Tim Peters400cbc32006-02-28 18:44:41 +00001"Usage: unparse.py <path to source file>"
2import sys
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00003import _ast
4import cStringIO
5import os
Tim Peters400cbc32006-02-28 18:44:41 +00006
Guido van Rossumd8faa362007-04-27 19:54:29 +00007def interleave(inter, f, seq):
8 """Call f on each item in seq, calling inter() in between.
9 """
10 seq = iter(seq)
11 try:
12 f(seq.next())
13 except StopIteration:
14 pass
15 else:
16 for x in seq:
17 inter()
18 f(x)
19
Tim Peters400cbc32006-02-28 18:44:41 +000020class Unparser:
21 """Methods in this class recursively traverse an AST and
22 output source code for the abstract syntax; original formatting
23 is disregarged. """
24
25 def __init__(self, tree, file = sys.stdout):
26 """Unparser(tree, file=sys.stdout) -> None.
27 Print the source for tree to file."""
28 self.f = file
29 self._indent = 0
30 self.dispatch(tree)
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +000031 print >>self.f,""
Tim Peters400cbc32006-02-28 18:44:41 +000032 self.f.flush()
33
34 def fill(self, text = ""):
35 "Indent a piece of text, according to the current indentation level"
36 self.f.write("\n"+" "*self._indent + text)
37
38 def write(self, text):
39 "Append a piece of text to the current line."
40 self.f.write(text)
41
42 def enter(self):
43 "Print ':', and increase the indentation."
44 self.write(":")
45 self._indent += 1
46
47 def leave(self):
48 "Decrease the indentation level."
49 self._indent -= 1
50
51 def dispatch(self, tree):
52 "Dispatcher function, dispatching tree type T to method _T."
53 if isinstance(tree, list):
54 for t in tree:
55 self.dispatch(t)
56 return
57 meth = getattr(self, "_"+tree.__class__.__name__)
58 meth(tree)
59
60
61 ############### Unparsing methods ######################
62 # There should be one method per concrete grammar type #
63 # Constructors should be grouped by sum type. Ideally, #
64 # this would follow the order in the grammar, but #
65 # currently doesn't. #
66 ########################################################
67
68 def _Module(self, tree):
69 for stmt in tree.body:
70 self.dispatch(stmt)
71
72 # stmt
73 def _Expr(self, tree):
74 self.fill()
75 self.dispatch(tree.value)
76
77 def _Import(self, t):
78 self.fill("import ")
Guido van Rossumd8faa362007-04-27 19:54:29 +000079 interleave(lambda: self.write(", "), self.dispatch, t.names)
Tim Peters400cbc32006-02-28 18:44:41 +000080
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000081 def _ImportFrom(self, t):
82 self.fill("from ")
83 self.write(t.module)
84 self.write(" import ")
Guido van Rossumd8faa362007-04-27 19:54:29 +000085 interleave(lambda: self.write(", "), self.dispatch, t.names)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000086 # XXX(jpe) what is level for?
87
Tim Peters400cbc32006-02-28 18:44:41 +000088 def _Assign(self, t):
89 self.fill()
90 for target in t.targets:
91 self.dispatch(target)
92 self.write(" = ")
93 self.dispatch(t.value)
94
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +000095 def _AugAssign(self, t):
96 self.fill()
97 self.dispatch(t.target)
98 self.write(" "+self.binop[t.op.__class__.__name__]+"= ")
99 self.dispatch(t.value)
100
101 def _Return(self, t):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000102 self.fill("return")
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000103 if t.value:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000104 self.write(" ")
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000105 self.dispatch(t.value)
106
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000107 def _Pass(self, t):
108 self.fill("pass")
109
110 def _Break(self, t):
111 self.fill("break")
112
113 def _Continue(self, t):
114 self.fill("continue")
115
116 def _Delete(self, t):
117 self.fill("del ")
118 self.dispatch(t.targets)
119
120 def _Assert(self, t):
121 self.fill("assert ")
122 self.dispatch(t.test)
123 if t.msg:
124 self.write(", ")
125 self.dispatch(t.msg)
126
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000127 def _Print(self, t):
128 self.fill("print ")
129 do_comma = False
130 if t.dest:
131 self.write(">>")
132 self.dispatch(t.dest)
133 do_comma = True
134 for e in t.values:
135 if do_comma:self.write(", ")
136 else:do_comma=True
137 self.dispatch(e)
138 if not t.nl:
139 self.write(",")
140
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000141 def _Global(self, t):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000142 self.fill("global ")
143 interleave(lambda: self.write(", "), self.write, t.names)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000144
145 def _Yield(self, t):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000146 self.write("(")
147 self.write("yield")
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000148 if t.value:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000149 self.write(" ")
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000150 self.dispatch(t.value)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000151 self.write(")")
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000152
153 def _Raise(self, t):
154 self.fill('raise ')
155 if t.type:
156 self.dispatch(t.type)
157 if t.inst:
158 self.write(", ")
159 self.dispatch(t.inst)
160 if t.tback:
161 self.write(", ")
162 self.dispatch(t.tback)
163
164 def _TryExcept(self, t):
165 self.fill("try")
166 self.enter()
167 self.dispatch(t.body)
168 self.leave()
169
170 for ex in t.handlers:
171 self.dispatch(ex)
172 if t.orelse:
173 self.fill("else")
174 self.enter()
175 self.dispatch(t.orelse)
176 self.leave()
177
178 def _TryFinally(self, t):
179 self.fill("try")
180 self.enter()
181 self.dispatch(t.body)
182 self.leave()
183
184 self.fill("finally")
185 self.enter()
186 self.dispatch(t.finalbody)
187 self.leave()
188
189 def _excepthandler(self, t):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000190 self.fill("except")
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000191 if t.type:
Guido van Rossumd8faa362007-04-27 19:54:29 +0000192 self.write(" ")
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000193 self.dispatch(t.type)
194 if t.name:
195 self.write(", ")
196 self.dispatch(t.name)
197 self.enter()
198 self.dispatch(t.body)
199 self.leave()
200
Tim Peters400cbc32006-02-28 18:44:41 +0000201 def _ClassDef(self, t):
202 self.write("\n")
203 self.fill("class "+t.name)
204 if t.bases:
205 self.write("(")
206 for a in t.bases:
207 self.dispatch(a)
208 self.write(", ")
209 self.write(")")
210 self.enter()
211 self.dispatch(t.body)
212 self.leave()
213
214 def _FunctionDef(self, t):
215 self.write("\n")
Thomas Wouters89f507f2006-12-13 04:49:30 +0000216 for deco in t.decorators:
217 self.fill("@")
218 self.dispatch(deco)
Tim Peters400cbc32006-02-28 18:44:41 +0000219 self.fill("def "+t.name + "(")
220 self.dispatch(t.args)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000221 self.write(")")
Tim Peters400cbc32006-02-28 18:44:41 +0000222 self.enter()
223 self.dispatch(t.body)
224 self.leave()
225
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000226 def _For(self, t):
227 self.fill("for ")
228 self.dispatch(t.target)
229 self.write(" in ")
230 self.dispatch(t.iter)
231 self.enter()
232 self.dispatch(t.body)
233 self.leave()
234 if t.orelse:
235 self.fill("else")
236 self.enter()
237 self.dispatch(t.orelse)
238 self.leave
239
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000240 def _If(self, t):
241 self.fill("if ")
242 self.dispatch(t.test)
243 self.enter()
244 # XXX elif?
245 self.dispatch(t.body)
246 self.leave()
247 if t.orelse:
248 self.fill("else")
249 self.enter()
250 self.dispatch(t.orelse)
251 self.leave()
252
253 def _While(self, t):
254 self.fill("while ")
255 self.dispatch(t.test)
256 self.enter()
257 self.dispatch(t.body)
258 self.leave()
259 if t.orelse:
260 self.fill("else")
261 self.enter()
262 self.dispatch(t.orelse)
263 self.leave
264
265 def _With(self, t):
266 self.fill("with ")
267 self.dispatch(t.context_expr)
268 if t.optional_vars:
269 self.write(" as ")
270 self.dispatch(t.optional_vars)
271 self.enter()
272 self.dispatch(t.body)
273 self.leave()
274
Tim Peters400cbc32006-02-28 18:44:41 +0000275 # expr
276 def _Str(self, tree):
277 self.write(repr(tree.s))
278
279 def _Name(self, t):
280 self.write(t.id)
281
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000282 def _Repr(self, t):
283 self.write("`")
284 self.dispatch(t.value)
285 self.write("`")
286
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000287 def _Num(self, t):
288 self.write(repr(t.n))
289
Tim Peters400cbc32006-02-28 18:44:41 +0000290 def _List(self, t):
291 self.write("[")
Guido van Rossumd8faa362007-04-27 19:54:29 +0000292 interleave(lambda: self.write(", "), self.dispatch, t.elts)
Tim Peters400cbc32006-02-28 18:44:41 +0000293 self.write("]")
294
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000295 def _ListComp(self, t):
296 self.write("[")
297 self.dispatch(t.elt)
298 for gen in t.generators:
299 self.dispatch(gen)
300 self.write("]")
301
302 def _GeneratorExp(self, t):
303 self.write("(")
304 self.dispatch(t.elt)
305 for gen in t.generators:
306 self.dispatch(gen)
307 self.write(")")
308
309 def _comprehension(self, t):
310 self.write(" for ")
311 self.dispatch(t.target)
312 self.write(" in ")
313 self.dispatch(t.iter)
314 for if_clause in t.ifs:
315 self.write(" if ")
316 self.dispatch(if_clause)
317
318 def _IfExp(self, t):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000319 self.write("(")
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000320 self.dispatch(t.body)
321 self.write(" if ")
322 self.dispatch(t.test)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000323 self.write(" else ")
324 self.dispatch(t.orelse)
325 self.write(")")
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000326
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000327 def _Dict(self, t):
328 self.write("{")
Guido van Rossumd8faa362007-04-27 19:54:29 +0000329 def writem((k, v)):
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000330 self.dispatch(k)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000331 self.write(": ")
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000332 self.dispatch(v)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000333 interleave(lambda: self.write(", "), writem, zip(t.keys, t.values))
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000334 self.write("}")
335
336 def _Tuple(self, t):
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000337 self.write("(")
Guido van Rossumd8faa362007-04-27 19:54:29 +0000338 if len(t.elts) == 1:
339 (elt,) = t.elts
340 self.dispatch(elt)
341 self.write(",")
342 else:
343 interleave(lambda: self.write(", "), self.dispatch, t.elts)
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000344 self.write(")")
345
Tim Peters400cbc32006-02-28 18:44:41 +0000346 unop = {"Invert":"~", "Not": "not", "UAdd":"+", "USub":"-"}
347 def _UnaryOp(self, t):
348 self.write(self.unop[t.op.__class__.__name__])
349 self.write("(")
350 self.dispatch(t.operand)
351 self.write(")")
352
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000353 binop = { "Add":"+", "Sub":"-", "Mult":"*", "Div":"/", "Mod":"%",
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000354 "LShift":">>", "RShift":"<<", "BitOr":"|", "BitXor":"^", "BitAnd":"&",
355 "FloorDiv":"//", "Pow": "**"}
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000356 def _BinOp(self, t):
357 self.write("(")
358 self.dispatch(t.left)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000359 self.write(" " + self.binop[t.op.__class__.__name__] + " ")
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000360 self.dispatch(t.right)
361 self.write(")")
362
363 cmpops = {"Eq":"==", "NotEq":"!=", "Lt":"<", "LtE":"<=", "Gt":">", "GtE":">=",
364 "Is":"is", "IsNot":"is not", "In":"in", "NotIn":"not in"}
365 def _Compare(self, t):
366 self.write("(")
367 self.dispatch(t.left)
368 for o, e in zip(t.ops, t.comparators):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000369 self.write(" " + self.cmpops[o.__class__.__name__] + " ")
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000370 self.dispatch(e)
371 self.write(")")
372
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000373 boolops = {_ast.And: 'and', _ast.Or: 'or'}
374 def _BoolOp(self, t):
375 self.write("(")
Guido van Rossumd8faa362007-04-27 19:54:29 +0000376 s = " %s " % self.boolops[t.op.__class__]
377 interleave(lambda: self.write(s), self.dispatch, t.values)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000378 self.write(")")
379
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000380 def _Attribute(self,t):
381 self.dispatch(t.value)
382 self.write(".")
383 self.write(t.attr)
384
385 def _Call(self, t):
386 self.dispatch(t.func)
387 self.write("(")
388 comma = False
389 for e in t.args:
390 if comma: self.write(", ")
391 else: comma = True
392 self.dispatch(e)
393 for e in t.keywords:
394 if comma: self.write(", ")
395 else: comma = True
396 self.dispatch(e)
397 if t.starargs:
398 if comma: self.write(", ")
399 else: comma = True
400 self.write("*")
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000401 self.dispatch(t.starargs)
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000402 if t.kwargs:
403 if comma: self.write(", ")
404 else: comma = True
405 self.write("**")
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000406 self.dispatch(t.kwargs)
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000407 self.write(")")
408
409 def _Subscript(self, t):
410 self.dispatch(t.value)
411 self.write("[")
412 self.dispatch(t.slice)
413 self.write("]")
414
415 # slice
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000416 def _Ellipsis(self, t):
417 self.write("...")
418
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000419 def _Index(self, t):
420 self.dispatch(t.value)
421
422 def _Slice(self, t):
423 if t.lower:
424 self.dispatch(t.lower)
425 self.write(":")
426 if t.upper:
427 self.dispatch(t.upper)
428 if t.step:
429 self.write(":")
430 self.dispatch(t.step)
431
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000432 def _ExtSlice(self, t):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000433 interleave(lambda: self.write(', '), self.dispatch, t.dims)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000434
Tim Peters400cbc32006-02-28 18:44:41 +0000435 # others
436 def _arguments(self, t):
437 first = True
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000438 nonDef = len(t.args)-len(t.defaults)
439 for a in t.args[0:nonDef]:
Tim Peters400cbc32006-02-28 18:44:41 +0000440 if first:first = False
441 else: self.write(", ")
442 self.dispatch(a)
Martin v. Löwis87a8b4f2006-02-28 21:41:30 +0000443 for a,d in zip(t.args[nonDef:], t.defaults):
444 if first:first = False
445 else: self.write(", ")
446 self.dispatch(a),
447 self.write("=")
448 self.dispatch(d)
Tim Peters400cbc32006-02-28 18:44:41 +0000449 if t.vararg:
450 if first:first = False
451 else: self.write(", ")
452 self.write("*"+t.vararg)
453 if t.kwarg:
454 if first:first = False
455 else: self.write(", ")
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000456 self.write("**"+t.kwarg)
Tim Peters400cbc32006-02-28 18:44:41 +0000457
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000458 def _keyword(self, t):
459 self.write(t.arg)
460 self.write("=")
461 self.dispatch(t.value)
462
463 def _Lambda(self, t):
464 self.write("lambda ")
465 self.dispatch(t.args)
466 self.write(": ")
467 self.dispatch(t.body)
468
Guido van Rossumd8faa362007-04-27 19:54:29 +0000469 def _alias(self, t):
470 self.write(t.name)
471 if t.asname:
472 self.write(" as "+t.asname)
473
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000474def roundtrip(filename, output=sys.stdout):
Tim Peters400cbc32006-02-28 18:44:41 +0000475 source = open(filename).read()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000476 tree = compile(source, filename, "exec", _ast.PyCF_ONLY_AST)
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000477 Unparser(tree, output)
478
479
480
481def testdir(a):
482 try:
483 names = [n for n in os.listdir(a) if n.endswith('.py')]
484 except OSError:
485 print >> sys.stderr, "Directory not readable: %s" % a
486 else:
487 for n in names:
488 fullname = os.path.join(a, n)
489 if os.path.isfile(fullname):
490 output = cStringIO.StringIO()
491 print 'Testing %s' % fullname
492 try:
493 roundtrip(fullname, output)
Guido van Rossumb940e112007-01-10 16:19:56 +0000494 except Exception as e:
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000495 print ' Failed to compile, exception is %s' % repr(e)
496 elif os.path.isdir(fullname):
497 testdir(fullname)
498
499def main(args):
500 if args[0] == '--testdir':
501 for a in args[1:]:
502 testdir(a)
503 else:
504 for a in args:
505 roundtrip(a)
Tim Peters400cbc32006-02-28 18:44:41 +0000506
507if __name__=='__main__':
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000508 main(sys.argv[1:])