metwork-framework / jinja2_humanize_extension Goto Github PK

View Code? Open in Web Editor NEW

4.0 3.0 1.0 68 KB

a jinja2 extension to use humanize library inside jinja2 templates

License: BSD 3-Clause "New" or "Revised" License

Makefile 7.52% Python 92.48%

jinja2 jinja2-extension integration-level-3 github-actions autoreadme

jinja2_humanize_extension's Introduction

jinja2_humanize_extension

Status (master branch)

What is it ?

This is a jinja2 extension to use humanize library inside jinja2 templates.

Syntax

The generic syntax is {{ 'VALUE'|humanize_{humanize_fn}([humanize_fn_args]) }}.

Following humanize functions are currently mapped:

naturalsize
abs_timedelta (deprecated with humanize >= 4.0, we keep it for compatibility)
date_and_delta (deprecated with humanize >= 4.0, we keep it for compatibility)
naturaldate
naturalday
naturaldelta
naturaltime
precisedelta
ordinal
intcomma
intword
apnumber
fractional
scientific
clamp
metric
activate
deactivate
thousands_separator
decimal_separator

See humanize documentation for argument details.

To take a more real example, let's take the naturalsize() function. To use it inside a jinja2 template with this extension, you have to use:


The file size is: {{ 30000000|humanize_naturalsize(binary=False, gnu=True) }}

result content will be : The file size is : 30.0 MB

You can use the same logic with all supported functions. If you need other functions, feel free to open a PullRequest.

Installation

pip install jinja2-humanize-extension

Full example

from jinja2 import Template, Environment

# We load the extension in a jinja2 Environment
env = Environment(extensions=["jinja2_humanize_extension.HumanizeExtension"])

template = env.from_string("The file size is : {{ 30000000|humanize_naturalsize() }}")
result = template.render()

# [...]

result content will be : The file size is : 30.0 MB

Contributing guide

See CONTRIBUTING.md file.

Code of Conduct

See CODE_OF_CONDUCT.md file.

jinja2_humanize_extension's People

Contributors

Stargazers

Watchers

Forkers

velle

jinja2_humanize_extension's Issues

i18n support

Broken dependency on `humanize.abs_timedelta`

As of v4.0.0 of humanize, abs_timedelta() is deprecated.

My installation (humanize-4.0.0, jinja2-3.0.3, jinja2-humanize-extension-0.2.0) produces this:

Traceback (most recent call last):
  File "/var/tmp/pbench-test-server/test-2/opt/pbench-server/bin/pbench-tarball-stats.py", line 325, in <module>
    status = main(parsed)
  File "/var/tmp/pbench-test-server/test-2/opt/pbench-server/bin/pbench-tarball-stats.py", line 297, in main
    env = jinja2.Environment(
  File "/var/tmp/tox/jenkins-unittests/lib/python3.9/site-packages/jinja2/environment.py", line 362, in __init__
    self.extensions = load_extensions(self, extensions)
  File "/var/tmp/tox/jenkins-unittests/lib/python3.9/site-packages/jinja2/environment.py", line 118, in load_extensions
    extension = t.cast(t.Type["Extension"], import_string(extension))
  File "/var/tmp/tox/jenkins-unittests/lib/python3.9/site-packages/jinja2/utils.py", line 215, in import_string
    return getattr(__import__(module, None, None, [obj]), obj)
  File "/var/tmp/tox/jenkins-unittests/lib/python3.9/site-packages/jinja2_humanize_extension/__init__.py", line 5, in <module>
    from humanize.time import (
ImportError: cannot import name 'abs_timedelta' from 'humanize.time' (/var/tmp/tox/jenkins-unittests/lib/python3.9/site-packages/humanize/time.py)

Use more recent version of humanize?

jinja2 humanize does not work with values that are timezone aware. In order to get the right result, one must do stuff like:

{{ t.astimezone().replace(tzinfo=None) | humanize_naturaltime }}

{{ t | humanize_naturaltime(when=datetime.datetime.now(tz=dateutil.tz.gettz()) ) }}

More recent versions of humanize work well with time/datetime/date objects with timezone set, and that would allow the following to work:

{{ t | humanize_naturaltime }}

Are there any specific reasons why the requirements.txt file is set to not use above version 3 of humanize?

port this change

metwork-framework/jinja2_getenv_extension#9