Skip to main content

Ways Django Can Import Things

How many ways can django import a module?

Grep is hard for this.

In .py files

"import (.*)\..*"
"from (.*)\..* import .*"
"patterns\(['"](.*)['"]"
"url(r?['"].*, ['"](.*)"


In INSTALLED_APPS and other settings.

Am I missing any? Better question: Why do I have to wonder if I'm missing any?

Comments

Doug Napoleone said…
You forgot about the magic __path__ hack done to the templatetags 'package' directory. It turns out that app.templatetags.app and django.templtatetags.app are two DIFFERENT imports of the same code and are independent modules with their own globals and locals...

Think about that for a while...
James Bennett said…
You did actually miss one: django.utils.importlib, which is simply a copy of the available-in-future-Python importlib module that Brett Cannon helpfully backported for us to handle all the things in Django (think pluggable backend modules) which require dynamic imports. Previously we used Python's raw __import__ for that, and importlib makes it ever so much simpler, and generally they have to in order to support the sort of dynamic-but-still-concise stuff people like to do in Python.

Anyway, two of the things you've listed are just standard Python import statements, and the other two are just URL-pattern functions which -- if it bugs you that much -- will happily accept the actual callable (or an iterable of patterns, in the case of include()) instead of strings. The string option is mostly just a convenience.

So I'm not sure I really understand the "why do I have to wonder if I'm missing any"; lots of frameworks/libraries have ways to specify something as a string and get it dynamically imported later through some mechanism other than a direct "import whatever" statement.

Oh, and for Doug: the __path__ hacking for templatetags is finally gone in trunk, which means it won't be in 1.2. The last bit of "magic" from magic-removal is finally out, hallelujah.
Unknown said…
Not sure if it is what you were intent on capturing, but there is the import of the Django settings file as a special sort of case. I recently posted some stuff about that at http://blog.dscpl.com.au/2010/03/improved-wsgi-script-for-use-with.html.
James Thiele said…
__import__( ... )
Robert said…
Wouldn't it be nice to standardize these 'import later module strings'* that various python frameworks have as some sort of generic-ized deferredimport('some.python.path.etc') object?

*: which are sometimes necessary due to definition order and cyclic dependencies etc.

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