django-admin2/djadmin2/renderers.py

# -*- coding: utf-8 -*-
"""
This module contains default renderers for admin fields. They are used for
example in the list view.
"""
from __future__ import division, absolute_import, unicode_literals

import os.path
from datetime import date, time, datetime

from django.utils import formats, timezone
from django.template.loader import render_to_string

from djadmin2 import settings


def boolean_renderer(value, field):
    """
    Render a boolean value as icon.

    This uses the template ``renderers/boolean.html``.

    :param value: The value to process.
    :type value: boolean
    :param field: The model field instance
    :type field: django.db.models.fields.Field
    :rtype: unicode

    """
    # TODO caching of template
    tpl = os.path.join(settings.ADMIN2_THEME_DIRECTORY, 'renderers/boolean.html')
    return render_to_string(tpl, {'value': value})


def datetime_renderer(value, field):
    """
    Localize and format the specified date.

    :param value: The value to process.
    :type value: datetime.date or datetime.time or datetime.datetime
    :param field: The model field instance
    :type field: django.db.models.fields.Field
    :rtype: unicode

    """
    if isinstance(value, datetime):
        return formats.localize(timezone.template_localtime(value))
    elif isinstance(value, (date, time)):
        return formats.localize(value)
    else:
        return value


def title_renderer(value, field):
    """
    Render a string in title case (capitalize every word).

    :param value: The value to process.
    :type value: str or unicode
    :param field: The model field instance
    :type field: django.db.models.fields.Field
    :rtype: unicode

    """
    return unicode(value).title()