Skip to main content

Class based template tags for Django

Project description

Please refer to the documentation in the docs/ directory for help. For a HTML rendered version of it please see here.

https://travis-ci.org/ojii/django-classy-tags.svg?branch=master

About this project

The goal of this project is to create a new way of writing Django template tags which is fully compatible with the current Django templating infrastructure. This new way should be easy, clean and require as little boilerplate code as possible while still staying as powerful as possible.

Features

  • Class based template tags.

  • Template tag argument parser.

  • Declarative way to define arguments.

  • Supports (theoretically infinite) parse-until blocks.

  • Extensible!

For the impatient

This is how a tag looks like using django-classy-tags:

from classytags.core import Options
from classytags.helpers import AsTag
from classytags.arguments import Argument
from django import template

register = template.Library()

class Hello(AsTag):
    options = Options(
        Argument('name', required=False, default='world'),
        'as',
        Argument('varname', required=False, resolve=False)
    )

    def get_value(self, context, name):
        return 'hello %s' % name

register.tag(Hello)

That’s your standard hello world example. Which can be used like this:

  • {% hello %}: Outputs hello world

  • {% hello "classytags" %}: Outputs hello classytags

  • {% hello as myvar %}: Outputs nothing but stores hello world into the template variable myvar.

  • {% hello "my friend" as othervar %}: Outputs nothing but stores hello my friend into the template variable othervar.

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

django-classy-tags-0.6.1.tar.gz (18.0 kB view details)

Uploaded Source

Built Distribution

django_classy_tags-0.6.1-py2.py3-none-any.whl (22.7 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-classy-tags-0.6.1.tar.gz.

File metadata

File hashes

Hashes for django-classy-tags-0.6.1.tar.gz
Algorithm Hash digest
SHA256 00b785ce56ce0faf904c6a52acc03c5d623e6c8d90f831a6540accdf64bdbb73
MD5 eb686aa767ad8cf88c1fa0f400a42516
BLAKE2b-256 92054dd245d581dd90ba0c9998c5c707a41b0ee4048277b83ee4ee02695f8a2e

See more details on using hashes here.

Provenance

File details

Details for the file django_classy_tags-0.6.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_classy_tags-0.6.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e57ff4e89649cd395bfe71e9c423f2c5360f2b631c5c72da3b6645b2a2d62013
MD5 c91b4d8c9f7df6c757b9143caf745e53
BLAKE2b-256 4eb73705d4fc5699d2f3ccb79e65b0d5c8413607e58e73595e80a78eb8e33206

See more details on using hashes here.

Provenance

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