Skip to main content

How To Influence Twisted With Django

This is probably taken as the concept for a horror novel by many, but bare with me as I am going somewhere productive with this line of thought. There are a number of valuable ideas in Django, even if they aren’t original. I think some of the concepts could be interesting if applied to Twisted. We can’t start over, but maybe we could bridge the gap.

The Project

A “Project” is a very vague concept that we all start when we’re doing something new, but in a system like Django it is a codified piece of the framework. What a project is, how it is structured, and where its boundaries lie are all documented carefully. This provides an obvious starting point and creates a wonderful sense of consistency from one project to the next.

The Application

Within a Django project one or more Django applications are combined, and each application provides a unit of reusable functionality. This might consist of DB models and views to aid in tagging objects, providing search indexes, or generating thumbnails from uploaded photos. Like the Project itself, the application is documented by Django in terms of its boundaries and structure.

If Twisted Took A Page From the Django Book?

I think we can make a case for borrowing these concepts and patterns. The running theme is breaking large things up into reusable chunks and defining the boundaries and interactions in ways that we can connect them largely via configuration. Can this work with Twisted? I think it can, in specific areas.

We can probably borrow the Project unit directly, add a script to every project that runs twistd and loads commands, like the manage.py in Django. A standard settings module to configure a project is an obvious choice.

At the next level we would configure smaller, reusable parts the project would bring together. Instead of a urls.py, we might define a ports.py, which we use to map the interfaces we listen on and the services that handle them.

I think we can’t map “Application” to any one concept, but need a variety of types of reusable things. That is fine and Django does the same. We talk about apps all the time, but we also have Request Middleware, Context Middleware, etc. Twisted has a lot of room for configurable middleware.

This is certainly something that deserves more thought.

Comments

Hey Calvin,

I can't help but love the idea of learning from other projects. Please keep thinking and writing about this topic! :)

About the specific idea of having something like `settings.py`, I have to disagree though. `settings.py` is one of my least favorite things about django projects. I don't want a pile of Python code defining a heap of global state for my project. Global state sucks! The problem settings.py is tackling is the same as the problem .tac files are tackling, I think. I think that neither one solves the problem _particularly_ well. Moving to a settings.py-like thing would just be lateral movement at best.

As far as manage.py goes, maybe you can talk about how having a copy of manage.py in every project is better than having one copy of twistd. What does manage.py get me that twistd doesn't?
Anonymous said…
I think the phrase is 'bear with me', unless you're in a naturalist beach. ;-)

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