installing snippets

Question

How do I install snippets in django? (specifically this)

I have the file /{project}/snippets/EnforceLoginMiddleware.py and I have tried any number of permutations inside MIDDLEWARE_CLASSES to load it as well as googling django snippets install to no avail :(

Any help would be grateful :)

PS(Why can't I find any documentation or examples on the installation of snippets. Maybe I'm just a bad googler)

Dominique Guardiola · Accepted Answer · 2011-01-17T19:49:07.033

"snippets" does not point to a specific element of Django, it just means : here is a piece of code for you to use. In this case, it's a Middleware, a specific Django module that will be called before and after a web request. Read django docs if needed

I use this middleware too, just paste everything in a file called middleware.py in your main application folder (any app folder will do, given this app is mentioned in INSTALLED_APPS)

Then add these lines in your settings.py file :

MIDDLEWARE_CLASSES = (
    #...all others middleware, on the last line, paste :
    'main.middleware.EnforceLoginMiddleware',
)

Note that here the app where I put the file is called main, yours may be named differently.

Don't forget to read the docstring of the snippet :

Middlware class which requires the user to be authenticated for all urls except 
those defined in PUBLIC_URLS in settings.py. PUBLIC_URLS should be a tuple of regular 
expresssions for the urls you want anonymous users to have access to. If PUBLIC_URLS 
is not defined, it falls back to LOGIN_URL or failing that '/accounts/login/'.  
Requests for urls not matching PUBLIC_URLS get redirected to LOGIN_URL with next set 
to original path of the unauthenticted request. 
Any urls statically served by django are excluded from this check. To enforce the same
validation on these set SERVE_STATIC_TO_PUBLIC to False.

score 2 · Answer 2 · answered Jan 17 '11 at 12:40

2

You need to make sure your snippet is on your PYTHONPATH (sys.path) or, that the snippet is within a module that exists on your PYTHONPATH.

In this case, if you add an __init__.py file to your snippets folder, that will treat the snippets folder as a module, and then you can do from snippets.EnforceLoginMiddleware import EnforceLoginMiddleware. I think this is the crucial step you're missing.

Your middleware classes would then look like:

MIDDLEWARE_CLASSES = (..., 'snippets.EnforceLoginMiddleware.EnforceLoginMiddleware')

answered Jan 17 '11 at 12:40

Josh Smeaton

47,939
24
129
164

Thank you. Your right but I decided to include the module in the main `middleware.py` file in the root of the project directory since it is going to be applied system wide – Robert Johnstone Jan 17 '11 at 12:56
1

@Sevenearths, that's exactly where it should be too. I had a bit of trouble figuring out how to include files from arbitrary directories at first. Groking modules and PYTHONPATH can be confusing at first. – Josh Smeaton Jan 17 '11 at 21:12

Horst Gutmann · Answer 3 · 2011-01-17T12:46:31.707

In your example your new entry to MIDDLEWARE_CLASSES would have to look like '{project}.snippets.EnforceLoginMiddleware.EnforceLoginMiddleware' (replace with the package name for your project).

Make sure, that your snippets folder also has an __init__.py file!

P.S.: that's probably because there is no such thing as a "snippet" when it comes to official components in Django. They usually are simple Python code fragments and have to be treated as such. Djangosnippets is just a site where you can post and share django code (also called snippets).

installing snippets

3 Answers3