django_view_dispatch

Django utility to dispatch views based on request method


Keywords
django
License
BSD-3-Clause
Install
pip install django_view_dispatch==0.1

Documentation

Usage

from django.conf.urls import patterns, url
from django_view_dispatch import dispatch, dispatch_strict

from . import views


urlpatterns = patterns('',
    url(r'^some_url/$', dispatch(get=views.my_view, post=views.my_view_for_post), name='events_json'),

    # you can get any keyword argument you want to specify any http verb
    url(r'^some_url/$', dispatch(get=views.my_view, put=views.create, foo=views.another_view, bar=views.baz), name='events_json'),

    # by default, if a request has an HTTP verb that hasn't been specified in
    # the dispatch() function, it will be redirected to the GET view if present
    url(r'^some_url/$', dispatch(get=views.will_get_everything_thats_not_put, put=views.stuff), name='events_json'),

    # you can change this behavior this way
    url(r'^some_url/$', dispatch(get=views.stuff, put=views.will_get_everything_thats_not_get, default="put"), name='events_json'),

    # if "default" is set to None, this behavior is disabled and and
    # HttpResponseNotAllowed will be returned
    url(r'^input/$', dispatch(post=views.my_view_for_post, default=None), name='events_json'),  # behave like @require_POST

    # a more explicit way to do that is provided with "dispatch_strict" which behave exactly like dispatch with default set to None
    url(r'^input/$', dispatch_strict(post=views.my_view_for_post), name='events_json'),
)

Installation

pip install django_view_dispatch

Why

Something that you learn as you progress in programming is that conditional are "bad" (as in "should be avoided") because they increase the complexity of your code and are a potential source of bugs.

For example, mixing POST and GET handling in the same view can be a good terrain for bug and for a more complex code while spliting it gives a KISS situation where you have two views that do only one thing and do it well.

Django doesn't provide an easy nor standard way to do this so this library is trying to address that.

Can I use string to designated a view like in the standard url function?

No, since django 1.8, using string to target views in patterns is depreciated, therefor there is no point in supporting this feature.

Also, to be honest, I have not idea on how to do that and haven't really made any research about it. That would also make the code way more complex.

Running tests

pip install pytest
py.test test.py

Licence

BSD.