Skip to main content

Spyce will not waste your time: controllers/handlers

Traditional view-oriented frameworks (such as PHP, or Spyce 1.3) do not handle control logic well. Today I'll show how Spyce 2 solves this problem with "active handlers," and tomorrow I'll show how this lets Spyce provide much more elegant code-reuse tools than either other view-oriented frameworks or MVC frameworks like Turbogears and Django.
Control logic is the code that decides what happens next in response to a user action. Say we have a simple form to create new to-do lists, like this:
<form>
<input type=text name=name value="">
<input type=submit>
</form>
In a traditional view-oriented framework (like Spyce 1.3), you would process this form with code that looks something like this:
[[name = request['name']
db.todo_lists.insert(name=name)
api.db.flush()
]]
That wasn't too bad. (Especially since I cheated and used the modern Spyce db api, AKA SqlSoup from SQLAlchemy.) But even with a simple, one-element form like this, a couple things are clear:
  • code like "name = request['name']" must be written for each form element. Irritating!
  • putting this chunk of code in the page with the form on it sucks (because you have to "if" it out if you're not actually processing the form POST)
  • putting this code on another page that doesn't actually do anything else sucks too (because then you have a view-that's-not-really-a-view, which is ugly -- to say nothing of existentially disturbing)
The Spyce solution is to allow you to specify Python functions, called handlers, that run on form submission. So your submit will now look like
<f:submit handler=list_new />
(note the Spyce form submit active tag; the vanilla html submit tag won't understand the handler parameter, of course), and you can define your handler as
def list_new(api, name):
    api.db.todo_lists.insert(name=name)
    api.db.flush()
This takes care of the redundant code to access form variables -- Spyce inspects the function definition and pulls the corresponding values out of the request for you -- and it also solves the problem of how to organize your code.
Earlier, I said you could write "handler=list_new." Actually, you either need to write "handler=self.list_new" and define list_new in a class chunk in the current page (as demonstrated in this example), or you can write "handler=somemodule.list_new," and put list_new in somemodule. (In the spirit of Not Wasting Your Time, Spyce will take care of importing somemodule as necessary.)
Pretty simple stuff, but I needed to explain handlers before I get into how Spyce uses them with active tags to provide unique code re-use tools. That will be our topic next time! Until then, if you missed the entry on form processing, go read it, since it touches on some of the more advanced features of handlers.







Comments

Popular posts from this blog

Why schema definition belongs in the database

Earlier, I wrote about how ORM developers shouldn't try to re-invent SQL . It doesn't need to be done, and you're not likely to end up with an actual improvement. SQL may be designed by committee, but it's also been refined from thousands if not millions of man-years of database experience. The same applies to DDL. (Data Definition Langage -- the part of the SQL standard that deals with CREATE and ALTER.) Unfortunately, a number of Python ORMs are trying to replace DDL with a homegrown Python API. This is a Bad Thing. There are at least four reasons why: Standards compliance Completeness Maintainability Beauty Standards compliance SQL DDL is a standard. That means if you want something more sophisticated than Emacs, you can choose any of half a dozen modeling tools like ERwin or ER/Studio to generate and edit your DDL. The Python data definition APIs, by contrast, aren't even compatibile with other Python tools. You can't take a table definition

Python at Mozy.com

At my day job, I write code for a company called Berkeley Data Systems. (They found me through this blog, actually. It's been a good place to work.) Our first product is free online backup at mozy.com . Our second beta release was yesterday; the obvious problems have been fixed, so I feel reasonably good about blogging about it. Our back end, which is the most algorithmically complex part -- as opposed to fighting-Microsoft-APIs complex, as we have to in our desktop client -- is 90% in python with one C extension for speed. We (well, they, since I wasn't at the company at that point) initially chose Python for speed of development, and it's definitely fulfilled that expectation. (It's also lived up to its reputation for readability, in that the Python code has had 3 different developers -- in serial -- with very quick ramp-ups in each case. Python's succinctness and and one-obvious-way-to-do-it philosophy played a big part in this.) If you try it out, pleas

A review of 6 Python IDEs

(March 2006: you may also be interested the updated review I did for PyCon -- http://spyced.blogspot.com/2006/02/pycon-python-ide-review.html .) For September's meeting, the Utah Python User Group hosted an IDE shootout. 5 presenters reviewed 6 IDEs: PyDev 0.9.8.1 Eric3 3.7.1 Boa Constructor 0.4.4 BlackAdder 1.1 Komodo 3.1 Wing IDE 2.0.3 (The windows version was tested for all but Eric3, which was tested on Linux. Eric3 is based on Qt, which basically means you can't run it on Windows unless you've shelled out $$$ for a commerical Qt license, since there is no GPL version of Qt for Windows. Yes, there's Qt Free , but that's not exactly production-ready software.) Perhaps the most notable IDEs not included are SPE and DrPython. Alas, nobody had time to review these, but if you're looking for a free IDE perhaps you should include these in your search, because PyDev was the only one of the 3 free ones that we'd consider using. And if you aren