Jinja2 Strcase

0.0.2 · active · verified Mon Apr 13

jinja2-strcase is a Python package that provides a set of filters for converting string cases within Jinja2 templates, including common formats like snake_case, kebab-case, and camelCase. It is currently at version 0.0.2 and is a port of the Go `strcase` package. The package has an 'Alpha' development status, indicating it is not yet stable for production use.

Warnings

breaking The package is currently in 'Development Status :: 3 - Alpha'. This means the API might change significantly in future versions without maintaining backward compatibility.
Fix: Review the project's GitHub repository for any changes before upgrading and test thoroughly.
gotcha Jinja2 extensions, including jinja2-strcase, need to be explicitly loaded into the Jinja2 Environment via the `extensions` parameter. Forgetting this step will result in template filter not found errors.
Fix: Ensure `extensions=['jinja2_strcase.StrcaseExtension']` is passed to the `jinja2.Environment` constructor.
gotcha When using Jinja2 templates, if a variable or attribute does not exist, it will return an undefined value. Operations on undefined values, or attempting to iterate over non-iterable objects, can lead to `NoneType` errors.
Fix: Always check if a variable is defined or iterable using `{% if variable is defined %}` or `{% if variable is iterable %}` before operating on it. Use default values where appropriate, e.g., `{{ variable | default('fallback_value') }}`.
gotcha Comparing different data types (e.g., string and integer) directly in Jinja2 templates without proper type conversion can lead to runtime errors.
Fix: Use Jinja2 filters like `|int` or `|float` to convert variables to the desired numeric type before comparison, e.g., `{% if '3'|int > 0 %}`.

Install

pip install jinja2-strcase Install with pip

Imports

StrcaseExtension
```
from jinja2_strcase import StrcaseExtension
```
This is the primary extension to enable the case conversion filters in Jinja2.
Environment
```
from jinja2 import Environment
```
Required from the core Jinja2 library to create a templating environment.

Quickstart

This quickstart demonstrates how to initialize a Jinja2 environment with the `StrcaseExtension` and then use various case conversion filters (e.g., `to_snake`, `to_screaming_snake`, `to_camel`) on strings within a template.

from jinja2 import Environment
from jinja2_strcase import StrcaseExtension

# Create a Jinja2 environment and load the StrcaseExtension
env = Environment(extensions=[StrcaseExtension])

# Define a template using the 'to_snake' filter
template = env.from_string("{{ 'Any kind of string' | to_snake }}")
print(f"to_snake: {template.render()}")

# Example with another filter: to_screaming_snake
template_screaming_snake = env.from_string("{{ 'Another Test String' | to_screaming_snake }}")
print(f"to_screaming_snake: {template_screaming_snake.render()}")

# Example with to_camel
template_camel = env.from_string("{{ 'this is a camel case' | to_camel }}")
print(f"to_camel: {template_camel.render()}")

view raw JSON →