django-urlconverter 1.0.0

Django URL converters

django-urlconverter: Django automatic view parameters conversion

The django-urlconverter package provides an easy way to convert view arguments from simple types to complex ones, like models, or just do some processing using robust syntax. Most interesting application of the package is to convert view arguments which are object ids (from database via ORM) to the instances of those objects (Models).

Installation

pip install django-urlconverter

Usage

models.py:

from django.db import models


class FooBar(models.Model):
    """Foo Bar model."""
    title = models.CharField(max_length=100)

converters.py:

from .models import FooBar


class Foo(object):
    """Foo converter. Convert an object id to FooBar instance."""
    def __init__(self, **kwargs):
        self.kwargs = kwargs

    def __call__(self, value, request, *args, **kwargs):
        return FooBar.objects.get(pk=value)

settings.py:

URL_CONVERTERS = {
    'Foo': 'converters.Foo',  # Converts to 'FooBar instance'
}

urls.py:

from django.conf.urls.defaults import patterns
from django_urlconverter import converted_arguments_url

urlpatterns = patterns('views',
    converted_arguments_url(r'^foos/<Foo:foo2>/', 'bar'),
)

views.py:

def bar(request, foo2):
    """View function which gets a converted foo2.
    the foo2 will be a converted parameter, which is the result of Foo converter
    """
    return foo2.title

Contact

If you have questions, bug reports, suggestions, etc. please create an issue on the GitHub project page.

License

This software is licensed under the MIT license

See https://github.com/paylogic/django-urlconverter/blob/master/LICENSE.txt

© 2013 Paylogic International.

Changelog

1.0.0

• Initial public release