Jinja2 Pluralize Filters

Warnings

• gotcha The library's last release was in 2015, and it was officially tested up to Python 3.5. While it might function on newer Python versions, active support and compatibility with recent Jinja2 releases (e.g., Jinja2 3.x) are not guaranteed, potentially leading to unforeseen issues.
  Fix: Thoroughly test on your target Python and Jinja2 versions. Consider migrating to actively maintained alternatives for new projects or if issues arise.
• gotcha The `pluralize_simple` filter relies on the `inflect` library for its functionality. However, `inflect` is not a declared dependency of `jinja2-pluralize`. If you intend to use `pluralize_simple`, you must install `inflect` separately (`pip install inflect`).
  Fix: Explicitly install `inflect` if you plan to use `pluralize_simple`.
• gotcha Given the lack of recent maintenance, consider modern and actively developed alternatives like `jinja2-inflection` for pluralization and other string transformations, which provides a broader set of filters and better compatibility with current Python and Jinja2 versions.
  Fix: Evaluate `jinja2-inflection` or other actively maintained Jinja2 extensions for new projects or when upgrading existing ones.

Install

• pip install jinja2-pluralize Install latest version

Imports

• pluralize_dj

  from jinja2_pluralize import pluralize_dj

  This is the Django-style pluralization filter, commonly used.
• pluralize_simple

  from jinja2_pluralize import pluralize_simple

  This is the simple pluralization filter, which depends on 'inflect'.

Quickstart

This quickstart demonstrates how to register the `pluralize_dj` filter with a Jinja2 environment and use it in a template to handle singular and plural forms of words, including custom plural suffixes.

from jinja2 import Environment
from jinja2_pluralize import pluralize_dj

env = Environment()
env.filters['pluralize'] = pluralize_dj

template = env.from_string('I have {{ count }} dog{{ count|pluralize }}.')

# Example 1: count = 1
result1 = template.render(count=1)
print(f"Rendered for count=1: {result1}") # Expected: I have 1 dog.

# Example 2: count = 2
result2 = template.render(count=2)
print(f"Rendered for count=2: {result2}") # Expected: I have 2 dogs.

template_args = env.from_string('There {{ num_items|pluralize("is", "are") }} {{ num_items }} item{{ num_items|pluralize }}.')

# Example 3: using custom singular/plural words
result3 = template_args.render(num_items=1)
print(f"Rendered for num_items=1: {result3}") # Expected: There is 1 item.

result4 = template_args.render(num_items=3)
print(f"Rendered for num_items=3: {result4}") # Expected: There are 3 items.