Skip to main content

Correctly generate plurals when using Django

Project description

NAME

inflect_dj.py - Generate plurals for use with Django.

VERSION

This document describes version 0.2.0 of inflect_dj.py

INSTALLATION

pip install inflect_dj

or

easy_install inflect_dj

DESCRIPTION

@verbose_name_plural —

Decorator for the Django models.Model classes.

Decorating a child class of model.Model with @verbose_name_plural will ensure that the plural form of the model name will be rendered correctly.

It uses the module inflect.py to determine the correct pluralisation.

USAGE

  1. Using @verbose_name_plural when specifying a verbose_name for the model:

    from django.db import models
    from inflect_dj import verbose_name_plural
    
    @verbose_name_plural
    class mycategory(models.Model):
        [definition of the model]
        class Meta:
            verbose_name = 'category'
            [rest of the Meta class definition]
    
The plural will be displayed correctly as categories.
  1. Using @verbose_name_plural without specifying verbose_name:

    from django.db import models
    from inflect_dj import verbose_name_plural
    
    @verbose_name_plural
    class category(models.Model):
        [definition of the model]
        class Meta:
            [class Meta definition]
    
The plural will be displayed correctly as categories, as this is the plural of the class name.

Earlier versions of Python

If you are using a Python version earlier than 2.6 you cannot use class decorators and must explicitly redefine the class with a call to verbose_name_plural():

from django.db import models
from inflect_dj import verbose_name_plural

class mycategory(models.Model):
    [definition of the model]
    class Meta:
        verbose_name = 'category'
        [rest of the Meta class definition]
mycategory = verbose_name_plural(mycategory)

AUTHOR

Paul Dyson (pwdyson@yahoo.com)

Project details


Download files

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

Files for inflect_dj, version v0.2.0
Filename, size & hash File type Python version Upload date
inflect_dj-v0.2.0.tar.gz (14.7 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page