Merge pull request #143 from ulope/widget_templates

A distinct template for each distinct widget.

docs/customization.rst

@@ -4,12 +4,15 @@ Customization
 Override default templates
 --------------------------
 
-Widgets have a ``template_name`` attribute that point to the template to use
-when rendering the form. Default templates are provided, for instance the
-default template for a ``TextInput`` and other input-type widgets is
-``floppyforms/input.html``. You can easily override this template in your
-project-level ``TEMPLATE_DIRS``, assuming they take precedence over app-level
-templates.
+Widgets have a ``template_name`` attribute that points to the template that is
+used when rendering the form. Default templates are provided for all
+:doc:`built-in widgets </widgets-reference>`. In most cases the default
+implementation of these templates have no specific behaviour and simply inherit
+from ``floppyforms/input.html``. They are provided mainly to give an easy
+way for a site-wide customization of how a specifig widget is rendered.
+
+You can easily override these templates in your project-level
+``TEMPLATE_DIRS``, assuming they take precedence over app-level templates.
 
 Custom widgets with custom templates
 ------------------------------------

docs/widgets-reference.rst

@@ -28,7 +28,7 @@ For each widgets, the default class attributes.
 
     .. attribute:: TextInput.template_name
 
-        ``'floppyforms/input.html'``
+        ``'floppyforms/text.html'``
 
     .. attribute:: TextInput.input_type
 
@@ -38,7 +38,7 @@ For each widgets, the default class attributes.
 
     .. attribute:: PasswordInput.template_name
 
-        ``'floppyforms/input.html'``
+        ``'floppyforms/password.html'``
 
     .. attribute:: PasswordInput.input_type
 
@@ -48,7 +48,7 @@ For each widgets, the default class attributes.
 
     .. attribute:: HiddenInput.template_name
 
-        ``'floppyforms/input.html'``
+        ``'floppyforms/hidden.html'``
 
     .. attribute:: HiddenInput.input_type
 
@@ -58,7 +58,7 @@ For each widgets, the default class attributes.
 
     .. attribute:: SlugInput.template_name
 
-        ``'floppyforms/input.html'``
+        ``'floppyforms/slug.html'``
 
     .. attribute:: SlugInput.input_type
 
@@ -71,7 +71,7 @@ For each widgets, the default class attributes.
 
     .. attribute:: IPAddressInput.template_name
 
-        ``'floppyforms/input.html'``
+        ``'floppyforms/ipaddress.html'``
 
     .. attribute:: IPAddressInput.input_type
 
@@ -85,7 +85,7 @@ For each widgets, the default class attributes.
 
     .. attribute:: FileInput.template_name
 
-        ``'floppyforms/input.html'``
+        ``'floppyforms/file.html'``
 
     .. attribute:: FileInput.input_type
 
@@ -95,7 +95,7 @@ For each widgets, the default class attributes.
 
     .. attribute:: ClearableFileInput.template_name
 
-        ``'floppyforms/input.html'``
+        ``'floppyforms/clearable_input.html'``
 
     .. attribute:: ClearableFileInput.input_type
 
@@ -120,7 +120,7 @@ For each widgets, the default class attributes.
 
     .. attribute:: EmailInput.template_name
 
-        ``'floppyforms/input.html'``
+        ``'floppyforms/email.html'``
 
     .. attribute:: EmailInput.input_type
 
@@ -130,7 +130,7 @@ For each widgets, the default class attributes.
 
     .. attribute:: URLInput.template_name
 
-        ``'floppyforms/input.html'``
+        ``'floppyforms/url.html'``
 
     .. attribute:: URLInput.input_type
 
@@ -140,7 +140,7 @@ For each widgets, the default class attributes.
 
     .. attribute:: SearchInput.template_name
 
-        ``'floppyforms/input.html'``
+        ``'floppyforms/search.html'``
 
     .. attribute:: SearchInput.input_type
 
@@ -150,7 +150,7 @@ For each widgets, the default class attributes.
 
     .. attribute:: ColorInput.template_name
 
-        ``'floppyforms/input.html'``
+        ``'floppyforms/color.html'``
 
     .. attribute:: ColorInput.input_type
 
@@ -160,7 +160,7 @@ For each widgets, the default class attributes.
 
     .. attribute:: PhoneNumberInput.template_name
 
-        ``'floppyforms/input.html'``
+        ``'floppyforms/phonenumber.html'``
 
     .. attribute:: PhoneNumberInput.input_type
 
@@ -170,7 +170,7 @@ For each widgets, the default class attributes.
 
     .. attribute:: DateInput.template_name
 
-        ``'floppyforms/input.html'``
+        ``'floppyforms/date.html'``
 
     .. attribute:: DateInput.input_type
 
@@ -185,7 +185,7 @@ For each widgets, the default class attributes.
 
     .. attribute:: DateTimeInput.template_name
 
-        ``'floppyforms/input.html'``
+        ``'floppyforms/datetime.html'``
 
     .. attribute:: DateTimeInput.input_type
 
@@ -195,7 +195,7 @@ For each widgets, the default class attributes.
 
     .. attribute:: TimeInput.template_name
 
-        ``'floppyforms/input.html'``
+        ``'floppyforms/time.html'``
 
     .. attribute:: TimeInput.input_type
 
@@ -205,7 +205,7 @@ For each widgets, the default class attributes.
 
     .. attribute:: NumberInput.template_name
 
-        ``'floppyforms/input.html'``
+        ``'floppyforms/number.html'``
 
     .. attribute:: NumberInput.input_type
 
@@ -230,7 +230,7 @@ For each widgets, the default class attributes.
 
     .. attribute:: NumberInput.template_name
 
-        ``'floppyforms/input.html'``
+        ``'floppyforms/range.html'``
 
     .. attribute:: RangeInput.input_type
 
@@ -271,7 +271,7 @@ For each widgets, the default class attributes.
 
     .. attribute:: CheckboxInput.template_name
 
-        ``'floppyforms/input.html'``
+        ``'floppyforms/checkbox.html'``
 
     .. attribute:: CheckboxInput.input_type
 

floppyforms/templates/floppyforms/checkbox.html

@@ -0,0 +1 @@
+{% extends "floppyforms/input.html" %}

floppyforms/templates/floppyforms/color.html

@@ -0,0 +1 @@
+{% extends "floppyforms/input.html" %}

floppyforms/templates/floppyforms/date.html

@@ -0,0 +1 @@
+{% extends "floppyforms/input.html" %}

floppyforms/templates/floppyforms/datetime.html

@@ -0,0 +1 @@
+{% extends "floppyforms/input.html" %}

floppyforms/templates/floppyforms/email.html

@@ -0,0 +1 @@
+{% extends "floppyforms/input.html" %}

floppyforms/templates/floppyforms/file.html

@@ -0,0 +1 @@
+{% extends "floppyforms/input.html" %}

floppyforms/templates/floppyforms/hidden.html

@@ -0,0 +1 @@
+{% extends "floppyforms/input.html" %}

floppyforms/templates/floppyforms/ipaddress.html

@@ -0,0 +1 @@
+{% extends "floppyforms/input.html" %}

floppyforms/templates/floppyforms/number.html

@@ -0,0 +1 @@
+{% extends "floppyforms/input.html" %}

floppyforms/templates/floppyforms/password.html

@@ -0,0 +1 @@
+{% extends "floppyforms/input.html" %}

floppyforms/templates/floppyforms/phonenumber.html

@@ -0,0 +1 @@
+{% extends "floppyforms/input.html" %}

floppyforms/templates/floppyforms/range.html

@@ -0,0 +1 @@
+{% extends "floppyforms/input.html" %}

floppyforms/templates/floppyforms/search.html

@@ -0,0 +1 @@
+{% extends "floppyforms/input.html" %}

floppyforms/templates/floppyforms/slug.html

@@ -0,0 +1 @@
+{% extends "floppyforms/input.html" %}

floppyforms/templates/floppyforms/text.html

@@ -0,0 +1 @@
+{% extends "floppyforms/input.html" %}

floppyforms/templates/floppyforms/time.html

@@ -0,0 +1 @@
+{% extends "floppyforms/input.html" %}

floppyforms/templates/floppyforms/url.html

@@ -0,0 +1 @@
+{% extends "floppyforms/input.html" %}

floppyforms/widgets.py

@@ -114,6 +114,7 @@ def render(self, name, value, attrs=None, **kwargs):
 
 
 class TextInput(Input):
+    template_name = 'floppyforms/text.html'
     input_type = 'text'
 
     def __init__(self, *args, **kwargs):
@@ -123,6 +124,7 @@ def __init__(self, *args, **kwargs):
 
 
 class PasswordInput(TextInput):
+    template_name = 'floppyforms/password.html'
     input_type = 'password'
 
     def __init__(self, attrs=None, render_value=False):
@@ -136,6 +138,7 @@ def render(self, name, value, attrs=None):
 
 
 class HiddenInput(Input):
+    template_name = 'floppyforms/hidden.html'
     input_type = 'hidden'
 
 
@@ -168,6 +171,8 @@ def value_from_datadict(self, data, files, name):
 
 
 class SlugInput(TextInput):
+    template_name = 'floppyforms/slug.html'
+
     """<input type="text"> validating slugs with a pattern"""
     def get_context(self, name, value, attrs):
         context = super(SlugInput, self).get_context(name, value, attrs)
@@ -176,6 +181,8 @@ def get_context(self, name, value, attrs):
 
 
 class IPAddressInput(TextInput):
+    template_name = 'floppyforms/ipaddress.html'
+
     """<input type="text"> validating IP addresses with a pattern"""
     ip_pattern = ("(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25"
                   "[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}")
@@ -187,6 +194,7 @@ def get_context(self, name, value, attrs):
 
 
 class FileInput(Input):
+    template_name = 'floppyforms/file.html'
     input_type = 'file'
     needs_multipart_form = True
     omit_value = True
@@ -266,6 +274,7 @@ def _format_value(self, value):
 
 
 class DateInput(Input):
+    template_name = 'floppyforms/date.html'
     input_type = 'date'
     supports_microseconds = False
 
@@ -292,6 +301,7 @@ def _has_changed(self, initial, data):
 
 
 class DateTimeInput(Input):
+    template_name = 'floppyforms/datetime.html'
     input_type = 'datetime'
     supports_microseconds = False
 
@@ -323,6 +333,7 @@ def _has_changed(self, initial, data):
 
 
 class TimeInput(Input):
+    template_name = 'floppyforms/time.html'
     input_type = 'time'
     supports_microseconds = False
 
@@ -353,22 +364,27 @@ def _has_changed(self, initial, data):
 
 
 class SearchInput(Input):
+    template_name = 'floppyforms/search.html'
     input_type = 'search'
 
 
 class EmailInput(TextInput):
+    template_name = 'floppyforms/email.html'
     input_type = 'email'
 
 
 class URLInput(TextInput):
+    template_name = 'floppyforms/url.html'
     input_type = 'url'
 
 
 class ColorInput(Input):
+    template_name = 'floppyforms/color.html'
     input_type = 'color'
 
 
 class NumberInput(TextInput):
+    template_name = 'floppyforms/number.html'
     input_type = 'number'
     min = None
     max = None
@@ -386,10 +402,12 @@ def __init__(self, attrs=None):
 
 
 class RangeInput(NumberInput):
+    template_name = 'floppyforms/range.html'
     input_type = 'range'
 
 
 class PhoneNumberInput(Input):
+    template_name = 'floppyforms/phonenumber.html'
     input_type = 'tel'
 
 
@@ -398,6 +416,7 @@ def boolean_check(v):
 
 
 class CheckboxInput(Input, forms.CheckboxInput):
+    template_name = 'floppyforms/checkbox.html'
     input_type = 'checkbox'
 
     def __init__(self, attrs=None, check_test=None):

tests/rendering.py

@@ -41,7 +41,7 @@ def test_default_retrieve(self):
         # retrieve widget template
 
         template_name = config.retrieve('widget_template', bound_field=form['name'])
-        self.assertEqual(template_name, 'floppyforms/input.html')
+        self.assertEqual(template_name, 'floppyforms/text.html')
 
         template_name = config.retrieve('widget_template', bound_field=form['comment'])
         self.assertEqual(template_name, 'floppyforms/textarea.html')