Skip to main content

Python AST Manipulation for Transparent Defering of Calls?

A lot of work has been going on with the Python AST and being able to manipulate it for more runtime uses. This is a generalized suggestion for something we could do in the Twisted community to utilize this.

Given a simple function like this:



def processPage(url):
d = getPage(url)
d.addCallback(cb_processPage)
d.addErrback(eb_processPage)
def cb_processPage(page):
print page
def eb_processPage(error):
print "Could not load page. Error: ", error

We write like that, but what we really mean, and just need to express in a more difficult manner, is:


def processPage(url):
try:
print getPage(url)
except LoadError, e:
print "Could not load page. Error: ", e

What I want to know, is can we take the second example and process the AST branch to produce the first example? Lets step through and see how it would work. First of all, we need to know what is deferred. A simple way would be to check every function return and determine if it is a deferred, but there may be more efficent methods we can discover later. For any possibly deferred call, the expression it is a part of can be refactored out into its own function, as can the exception handler code. When a deferred is detected, the callbacks can be attached and if the operation is not deferred, the callbacks can be used directly. This might even bring about something slightly new: optionally deferred operations. Instead of using defer.succeed and such, returning a deferred could cause code to handle the deferred properly, which would otherwise act in a normal syncronous manner. Depending on just how the AST stuff progresses, maybe the returning of the deferred could trigger the inspection of the calling function to inject the deferred handling code, so only functions that ever get a deferred will need processing.

Comments

PJE said…
"""What I want to know, is can we take the second example and process the AST branch to produce the first example?"""

Doesn't matter. Change your second example to say "print yield getPage(url)", use Python 2.5, and run the whole thing under a trampoline function that knows how to handle deferreds. See PEP 342 for examples. Net result: all you have to do is add "yield" wherever your code can be suspended -- even in the middle of arbitrary expressions, error handlers, and the like.

Now, if you want to do it with Python versions before 2.5, see peak.events. You just have to make it say "yield getPage(url); print events.resume()" instead, because Python before 2.5 can't get a value back from a yield statement. But peak.events already has the necessary trampolines written, and they already work with Twisted's deferreds.
Anonymous said…
I'd prefer to write something like this (replacing indentation with periods for legibility's sake):

def processPage(url):
....when getPage(url) -> page:
........print page
....except LoadError, e:
........print 'Could not load page. Error: ', e

Popular posts from this blog

CARDIAC: The Cardboard Computer

I am just so excited about this. CARDIAC. The Cardboard Computer. How cool is that? This piece of history is amazing and better than that: it is extremely accessible. This fantastic design was built in 1969 by David Hagelbarger at Bell Labs to explain what computers were to those who would otherwise have no exposure to them. Miraculously, the CARDIAC (CARDboard Interactive Aid to Computation) was able to actually function as a slow and rudimentary computer.  One of the most fascinating aspects of this gem is that at the time of its publication the scope it was able to demonstrate was actually useful in explaining what a computer was. Could you imagine trying to explain computers today with anything close to the CARDIAC? It had 100 memory locations and only ten instructions. The memory held signed 3-digit numbers (-999 through 999) and instructions could be encoded such that the first digit was the instruction and the second two digits were the address of memory to operate on

Statement Functions

At a small suggestion in #python, I wrote up a simple module that allows the use of many python statements in places requiring statements. This post serves as the announcement and documentation. You can find the release here . The pattern is the statement's keyword appended with a single underscore, so the first, of course, is print_. The example writes 'some+text' to an IOString for a URL query string. This mostly follows what it seems the print function will be in py3k. print_("some", "text", outfile=query_iostring, sep="+", end="") An obvious second choice was to wrap if statements. They take a condition value, and expect a truth value or callback an an optional else value or callback. Values and callbacks are named if_true, cb_true, if_false, and cb_false. if_(raw_input("Continue?")=="Y", cb_true=play_game, cb_false=quit) Of course, often your else might be an error case, so raising an exception could be u

How To use Sphinx Autodoc on ReadTheDocs with a Django application

Sphinx is awesome for writing documentation. ReadTheDocs is awesome for hosting it. Autodocs are great for covering your entire API easily. Django is a great framework that makes my job easier. Between these four things is an interaction that only brought me pain, however. I'm here to help the next dev avoid this. Autodocs works by importing your modules and walking over the classes and functions to build documentation out of the existing docstrings. It can be used to generate complete API docs quickly and keep them in sync with the libraries existing docstrings, so you won't get conflicts between your docs and your code. Fantastic. This creates a problem when used with Django applications, where many things cannot be imported unless a valid settings module can be found. This can prevent a hurdle in some situations, and requires a little boilerplate to get working properly with Sphinx. It require a little extra to get working on ReadTheDocs. What makes this particularly h