Skip to main content

Form and model fields for storing durations on Django models as ISO 8601 compliant strings, and returning relativedelta objects.

Project description

Welcome to thecut-durationfield Documentation Status

This app provides a custom Django model field, RelativeDeltaField, and related form fields and widgets. RelativeDeltaField stores time durations using ISO 8601 representations, and returns dateutil.relativedelta objects which may be used directly with datetime.datetime objects.

This project was inspired by packages such as django-durationfield. However, this project focuses on:

  1. providing a database-agnostic, standards-compliant way of storing the durations in the database (using ISO 8601).

  2. returning dateutil.relativedelta objects that can be used to perform calculations on datetime.datetime objects.

Note that django-durationfield provides the ability to filter querysets based on the relative size of the stored duration, which is not possible with this project. I.e., you can’t use __lt and __gt etc., when filtering by fields provided by this project.


The full documentation is at


Install thecut-durationfield using the installation instructions found in the documentation.

Model field

from django.db import models
from datetime import datetime
from thecut.durationfield.models import RelativeDeltaField

class MyModel(models.Model):
    duration = RelativeDeltaField(blank=True, null=True)

my_instance = MyModel(duration='P7D')
datetime(2014, 1, 1) + my_instance.duration  # datetime(2014, 1, 8, 0, 0)

Form field

Two form fields are provided: RelativeDeltaChoiceField and RelativeDeltaTextInput:

from django import forms
from thecut.durationfield.models import RelativeDeltaChoiceField

    ('', 'Never'),
    ('P7D', 'One week'),
    ('P1M', 'One month'),

class MyForm(forms.ModelForm):

    duration = RelativeDeltaChoiceField(choices=DURATIONS)

or, if you’d prefer to type in the (ISO 8601 compliant) value manually:

from django import forms
from thecut.durationfield.forms import RelativeDeltaTextInput

class MyForm(forms.ModelForm):

    duration = RelativeDeltaTextInput()


See AUTHORS.rst.


2.0.3 (2016-08-15)

  • Removed cross-document links from README.rst as it breaks pypi.

  • Small fix to project’s setup file.

2.0.2 (2016-08-15)

  • Documentation updates.

2.0.1 (2016-08-15)

  • Documentation fixes.

  • Testing fixes.

2.0 (2016-08-15)

  • Added support for Django 1.10.

  • Removed support for Django < 1.8.

  • Restructured test suite.

  • Restructured documentation.

1.0.8 (2015-08-26)

  • Improved handling of seconds and milliseconds.

1.0.8 (2015-08-26)

  • Improved handling of seconds and milliseconds.

1.0.7 (2015-03-17)

  • Added Python 3 support.

1.0.6 (2014-07-28)

  • Fix an issue which caused an empty relativedelta to be returned for a database NULL value.

  • Get tox up and running.

  • Update package for public release.

1.0.5 (2014-03-19)

  • Remove distribute from install_requires.

1.0.4 (2013-12-17)

  • Fixed an issue with Postgres’s fixed-length 64 character field.

1.0.3 (2013-09-28)

  • Minor code cleanup.

1.0.2 (20132-08-08)

  • Add a Select widget for friendlier form input.

1.0.1 (2013-07-25)

  • Fixes to south introspection rules.

1.0 (2013-07-25)

  • First useful release with base model and form fields.

0.1 (2013-06-10)

  • Initial release, mostly useless.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

thecut-durationfield-2.0.3.tar.gz (14.9 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page