Django snippets: djangopath: conveniently set sys.path and DJANGO_SETTINGS

import sys, os
from os.path import dirname, abspath

def djangopath(up=1, settings=None):
    '''convenience function to easily set the application sys.path and 
       DJANGO_SETTINGS_MODULE environment variable depending on the location
       of the script file in question.
    
    :param up: how many directories up from current __file__ where the
               djangopath function is called.
    :type up: integer
    :param settings: <djangoapp>.settings
    :type: settings: string
    
    usage::
        
        >>> from lib import djangopath
        >>> djangopath(up=3, settings='myapp.settings')
        
    '''
    # here's the magic
    path = abspath(sys._getframe(1).f_code.co_filename)
    for i in range(up):
        path = dirname(path)
    sys.path.insert(0, path)
    if settings:
        os.environ['DJANGO_SETTINGS_MODULE'] = settings

More like this

Custom mod_python AuthenHandler by aeby 5 years, 9 months ago
apache authentication via cookies by sean 6 years, 2 months ago
manage.py with magic python path by bikeshedder 5 years, 11 months ago
Zope testing django layer by grahamcarlyle 5 years, 4 months ago
TestSettingsManager: temporarily change settings for tests by carljm 4 years, 8 months ago

In the past, whenever I had a script that I wanted to properly configure the settings for, I would use something like the following idiom at the top of the script:

import sys, os; dirname = os.path.dirname
# sys.path.insert(0, dirname(dirname(__file__)))
sys.path.insert(0, dirname(__file__))
os.environ['DJANGO_SETTINGS_MODULE'] = 'myapp.settings'

Notice that this is a relative setting to __file__ variable in the script. The djangopath function is an attempt to do away with the above such that I can now write the following:

from lib import djangopath; djangopath(up=2, settings='myapp.settings')

This seems to work for me, but it assumes that you are packaging your script inside your projects/apps. If they are elsewhere then you may need to resort to another method (e.g. absolute paths, etc.)

Author:: alia_khouri
Posted:: August 7, 2008
Language:: Python
Django Version:: .96
Tags:: settings path
Score:: 0 (after 0 ratings)

Django snippets

djangopath: conveniently set sys.path and DJANGO_SETTINGS_MODULE

More like this

Tools

Comments

Snippets

About