New humanize filter "naturalday" (yesterday, today, tomorrow)

[exogen@…]

Just something I think people might want in humanize or defaultfilters. This will return 'yesterday', 'today', and 'tomorrow' when the given date has the appropriate relation with the current date. Otherwise, return the full day name. Maybe it could even be extended to do 'last Tuesday', 'this Tuesday', or 'next Tuesday' when appropriate. Anyway the idea is that it is very common to hear this method of communicating the day in speech.

import datetime

def naturalday(value):
    today = datetime.date.today()
    value = datetime.date(value.year, value.month, value.day)
    delta = datetime.timedelta(days=1)
    if value == today:
        return 'today'
    elif value == today + delta:
        return 'tomorrow'
    elif value == today - delta:
        return 'yesterday'
    return value.strftime('%A')

[Adrian Holovaty]

Sounds good to me. Could you provide a patch plus tests and docs?

[Gary Wilson <gary.wilson@…>]

I wouldn't think you would want to output just the day of the week for dates and datetimes more/less than 1 day away/ago. Maybe it should instead default to settings.DATE_FORMAT or settings.DATETIME_FORMAT, also taking an optional date format string that would override the default.

[Jyrki Pulliainen <jyrki.pulliainen@…>]

naturalday patch incl. tests

[Jyrki Pulliainen <jyrki.pulliainen@…>]

Added a patch including unittests. Presented patch now does the fallback formatting according to settings.DATE_FORMAT. If passed value is not a date value, it returns the value without throwing an exception

[Jyrki Pulliainen <jyrki.pulliainen@…>]

Documentation for naturalday

[Jyrki Pulliainen <jyrki.pulliainen@…>]

ReST typo fixed

[Gary Wilson <gary.wilson@…>]

I would suggest allowing a format string to be passed in as well and call django.template.defaultfilters.date() when the date is not yesterday, today, or tomorrow. That way, the default settings.DATE_FORMAT could be overridden in the template just as with the date template filter.

[Jyrki Pulliainen <jyrki.pulliainen@…>]

New docs for latest changes

[Jyrki Pulliainen <jyrki.pulliainen@…>]

Tests against v3 patch

[Jyrki Pulliainen <jyrki.pulliainen@…>]

New patch

[Jyrki Pulliainen <jyrki.pulliainen@…>]

New patch, uses now the defaultfilter date().

Argument using documented and new tests added.

[Brian Beck <exogen@…>]

This is pretty minor, but I have a hunch it would be a little quicker to do:

delta = value - today
if delta.days == 0:
    return _('today')
if delta.days == 1:
    return _('tomorrow')
elif delta.days == -1:
    return _('yesterday')

...so that only one delta is calculated and less comparisons will happen (no date.__eq__/__cmp__).

P.S. Awesome job on the patches Jyrki!

[Jyrki Pulliainen <jyrki.pulliainen@…>]

Naturalday patch with the time delta

[Jyrki Pulliainen <jyrki.pulliainen@…>]

Replying to Brian Beck <exogen@gmail.com>:

...so that only one delta is calculated and less comparisons will happen (no date.__eq__/__cmp__).

Changed the code to do less compares. Thank you for the tip

P.S. Awesome job on the patches Jyrki!

Thanks!

[Chris Beaven]

I'm not up with the play on the whole gettext side of things, but I thought I remembered there is a move away from using _ as the name for gettext. Or maybe not... just checking.

[Brian Rosner <brosner@…>]

FYI, this patch needs to get updated to trunk. The unicode branch is now requiring a slight change.

from django.utils.translation import gettext as _

to

from django.utils.translation import ugettext as _

[Jyrki Pulliainen <jyrki.pulliainen@…>]

Merged patch with latest trunk and made it use unicode gettext

[Jyrki Pulliainen <jyrki.pulliainen@…>]

Unicode-aware patch (fixed some typos) against 5722

[Simon G. <dev@…>]

Last version looks good - tests, docs & everything.

[Malcolm Tredinnick]

(In [5985]) Fixed #3311 -- Added naturalday filter to contrib.humanize. Thanks, Jyrki Pulliainen.