From 7a3a8bed9d125d45dadc32aa4e844dd2d96cf134 Mon Sep 17 00:00:00 2001
From: Tom Christie <tom@tomchristie.com>
Date: Wed, 10 Aug 2016 11:31:15 +0100
Subject: [PATCH] Resolve issues with ChoiceField, MultipleChoiceField and
 non-string options

---
 .../rest_framework/horizontal/checkbox_multiple.html   |  6 ++++--
 .../templates/rest_framework/horizontal/radio.html     |  6 ++++--
 .../templates/rest_framework/horizontal/select.html    |  4 +++-
 .../rest_framework/horizontal/select_multiple.html     |  4 +++-
 .../rest_framework/inline/checkbox_multiple.html       |  4 +++-
 .../templates/rest_framework/inline/radio.html         |  3 ++-
 .../templates/rest_framework/inline/select.html        |  4 +++-
 .../rest_framework/inline/select_multiple.html         |  3 ++-
 .../rest_framework/vertical/checkbox_multiple.html     |  6 ++++--
 .../templates/rest_framework/vertical/radio.html       |  5 +++--
 .../templates/rest_framework/vertical/select.html      |  4 +++-
 .../rest_framework/vertical/select_multiple.html       |  3 ++-
 rest_framework/templatetags/rest_framework.py          | 10 ++++++++++
 rest_framework/utils/serializer_helpers.py             |  2 +-
 14 files changed, 47 insertions(+), 17 deletions(-)

diff --git a/rest_framework/templates/rest_framework/horizontal/checkbox_multiple.html b/rest_framework/templates/rest_framework/horizontal/checkbox_multiple.html
index f01071297..7c7e57326 100644
--- a/rest_framework/templates/rest_framework/horizontal/checkbox_multiple.html
+++ b/rest_framework/templates/rest_framework/horizontal/checkbox_multiple.html
@@ -1,3 +1,5 @@
+{% load rest_framework %}
+
 <div class="form-group">
   {% if field.label %}
     <label class="col-sm-2 control-label {% if style.hide_label %}sr-only{% endif %}">
@@ -9,7 +11,7 @@
     {% if style.inline %}
       {% for key, text in field.choices.items %}
         <label class="checkbox-inline">
-          <input type="checkbox" name="{{ field.name }}" value="{{ key }}" {% if key in field.value %}checked{% endif %}>
+          <input type="checkbox" name="{{ field.name }}" value="{{ key }}" {% if key|as_string in field.value|as_list_of_strings %}checked{% endif %}>
           {{ text }}
         </label>
       {% endfor %}
@@ -17,7 +19,7 @@
       {% for key, text in field.choices.items %}
         <div class="checkbox">
           <label>
-            <input type="checkbox" name="{{ field.name }}" value="{{ key }}" {% if key in field.value %}checked{% endif %}>
+            <input type="checkbox" name="{{ field.name }}" value="{{ key }}" {% if key|as_string in field.value|as_list_of_strings %}checked{% endif %}>
             {{ text }}
           </label>
         </div>
diff --git a/rest_framework/templates/rest_framework/horizontal/radio.html b/rest_framework/templates/rest_framework/horizontal/radio.html
index 5a28386e1..e9922dd04 100644
--- a/rest_framework/templates/rest_framework/horizontal/radio.html
+++ b/rest_framework/templates/rest_framework/horizontal/radio.html
@@ -1,4 +1,6 @@
 {% load i18n %}
+{% load rest_framework %}
+
 {% trans "None" as none_choice %}
 
 <div class="form-group">
@@ -19,7 +21,7 @@
 
       {% for key, text in field.choices.items %}
         <label class="radio-inline">
-          <input type="radio" name="{{ field.name }}" value="{{ key }}" {% if key == field.value %}checked{% endif %} />
+          <input type="radio" name="{{ field.name }}" value="{{ key }}" {% if key|as_string == field.value|as_string %}checked{% endif %} />
           {{ text }}
         </label>
       {% endfor %}
@@ -35,7 +37,7 @@
         {% for key, text in field.choices.items %}
           <div class="radio">
             <label>
-              <input type="radio" name="{{ field.name }}" value="{{ key }}" {% if key == field.value %}checked{% endif %} />
+              <input type="radio" name="{{ field.name }}" value="{{ key }}" {% if key|as_string == field.value|as_string %}checked{% endif %} />
               {{ text }}
             </label>
           </div>
diff --git a/rest_framework/templates/rest_framework/horizontal/select.html b/rest_framework/templates/rest_framework/horizontal/select.html
index 3c9e36bbb..7a3db2db8 100644
--- a/rest_framework/templates/rest_framework/horizontal/select.html
+++ b/rest_framework/templates/rest_framework/horizontal/select.html
@@ -1,3 +1,5 @@
+{% load rest_framework %}
+
 <div class="form-group">
   {% if field.label %}
     <label class="col-sm-2 control-label {% if style.hide_label %}sr-only{% endif %}">
@@ -16,7 +18,7 @@
           {% elif select.end_option_group %}
             </optgroup>
           {% else %}
-            <option value="{{ select.value }}" {% if select.value == field.value %}selected{% endif %} {% if select.disabled %}disabled{% endif %}>{{ select.display_text }}</option>
+            <option value="{{ select.value }}" {% if select.value|as_string == field.value|as_string %}selected{% endif %} {% if select.disabled %}disabled{% endif %}>{{ select.display_text }}</option>
           {% endif %}
       {% endfor %}
     </select>
diff --git a/rest_framework/templates/rest_framework/horizontal/select_multiple.html b/rest_framework/templates/rest_framework/horizontal/select_multiple.html
index 68b40ecc3..36ff9fd0d 100644
--- a/rest_framework/templates/rest_framework/horizontal/select_multiple.html
+++ b/rest_framework/templates/rest_framework/horizontal/select_multiple.html
@@ -1,4 +1,6 @@
 {% load i18n %}
+{% load rest_framework %}
+
 {% trans "No items to select." as no_items %}
 
 <div class="form-group">
@@ -16,7 +18,7 @@
         {% elif select.end_option_group %}
           </optgroup>
         {% else %}
-          <option value="{{ select.value }}" {% if select.value in field.value %}selected{% endif %} {% if select.disabled %}disabled{% endif %}>{{ select.display_text }}</option>
+          <option value="{{ select.value }}" {% if select.value|as_string in field.value|as_list_of_strings %}selected{% endif %} {% if select.disabled %}disabled{% endif %}>{{ select.display_text }}</option>
         {% endif %}
       {% empty %}
           <option>{{ no_items }}</option>
diff --git a/rest_framework/templates/rest_framework/inline/checkbox_multiple.html b/rest_framework/templates/rest_framework/inline/checkbox_multiple.html
index b02425a62..4c544ff8a 100644
--- a/rest_framework/templates/rest_framework/inline/checkbox_multiple.html
+++ b/rest_framework/templates/rest_framework/inline/checkbox_multiple.html
@@ -1,3 +1,5 @@
+{% load rest_framework %}
+
 <div class="form-group {% if field.errors %}has-error{% endif %}">
   {% if field.label %}
     <label class="sr-only">{{ field.label }}</label>
@@ -6,7 +8,7 @@
   {% for key, text in field.choices.items %}
     <div class="checkbox">
       <label>
-        <input type="checkbox" name="{{ field.name }}" value="{{ key }}" {% if key in field.value %}checked{% endif %}>
+        <input type="checkbox" name="{{ field.name }}" value="{{ key }}" {% if key|as_string in field.value|as_list_of_strings %}checked{% endif %}>
         {{ text }}
       </label>
     </div>
diff --git a/rest_framework/templates/rest_framework/inline/radio.html b/rest_framework/templates/rest_framework/inline/radio.html
index efaef6c9b..8d43cb390 100644
--- a/rest_framework/templates/rest_framework/inline/radio.html
+++ b/rest_framework/templates/rest_framework/inline/radio.html
@@ -1,4 +1,5 @@
 {% load i18n %}
+{% load rest_framework %}
 {% trans "None" as none_choice %}
 
 <div class="form-group {% if field.errors %}has-error{% endif %}">
@@ -20,7 +21,7 @@
   {% for key, text in field.choices.items %}
     <div class="radio">
       <label>
-        <input type="radio" name="{{ field.name }}" value="{{ key }}" {% if key == field.value %}checked{% endif %}>
+        <input type="radio" name="{{ field.name }}" value="{{ key }}" {% if key|as_string == field.value|as_string %}checked{% endif %}>
         {{ text }}
       </label>
     </div>
diff --git a/rest_framework/templates/rest_framework/inline/select.html b/rest_framework/templates/rest_framework/inline/select.html
index 99f10ae71..5023c2203 100644
--- a/rest_framework/templates/rest_framework/inline/select.html
+++ b/rest_framework/templates/rest_framework/inline/select.html
@@ -1,3 +1,5 @@
+{% load rest_framework %}
+
 <div class="form-group {% if field.errors %}has-error{% endif %}">
   {% if field.label %}
     <label class="sr-only">
@@ -15,7 +17,7 @@
         {% elif select.end_option_group %}
           </optgroup>
         {% else %}
-          <option value="{{ select.value }}" {% if select.value == field.value %}selected{% endif %} {% if select.disabled %}disabled{% endif %}>{{ select.display_text }}</option>
+          <option value="{{ select.value }}" {% if select.value|as_string == field.value|as_string %}selected{% endif %} {% if select.disabled %}disabled{% endif %}>{{ select.display_text }}</option>
         {% endif %}
     {% endfor %}
   </select>
diff --git a/rest_framework/templates/rest_framework/inline/select_multiple.html b/rest_framework/templates/rest_framework/inline/select_multiple.html
index 1c0e96b3c..b5fd46f8b 100644
--- a/rest_framework/templates/rest_framework/inline/select_multiple.html
+++ b/rest_framework/templates/rest_framework/inline/select_multiple.html
@@ -1,4 +1,5 @@
 {% load i18n %}
+{% load rest_framework %}
 {% trans "No items to select." as no_items %}
 
 <div class="form-group {% if field.errors %}has-error{% endif %}">
@@ -15,7 +16,7 @@
           {% elif select.end_option_group %}
             </optgroup>
           {% else %}
-            <option value="{{ select.value }}" {% if select.value in field.value %}selected{% endif %} {% if select.disabled %}disabled{% endif %}>{{ select.display_text }}</option>
+            <option value="{{ select.value }}" {% if select.value|as_string in field.value|as_list_of_strings %}selected{% endif %} {% if select.disabled %}disabled{% endif %}>{{ select.display_text }}</option>
           {% endif %}
       {% empty %}
       <option>{{ no_items }}</option>
diff --git a/rest_framework/templates/rest_framework/vertical/checkbox_multiple.html b/rest_framework/templates/rest_framework/vertical/checkbox_multiple.html
index 8412f8e2d..b933f4ff5 100644
--- a/rest_framework/templates/rest_framework/vertical/checkbox_multiple.html
+++ b/rest_framework/templates/rest_framework/vertical/checkbox_multiple.html
@@ -1,3 +1,5 @@
+{% load rest_framework %}
+
 <div class="form-group {% if field.errors %}has-error{% endif %}">
   {% if field.label %}
     <label {% if style.hide_label %}class="sr-only"{% endif %}>{{ field.label }}</label>
@@ -7,7 +9,7 @@
     <div>
       {% for key, text in field.choices.items %}
         <label class="checkbox-inline">
-          <input type="checkbox" name="{{ field.name }}" value="{{ key }}" {% if key in field.value %}checked{% endif %}>
+          <input type="checkbox" name="{{ field.name }}" value="{{ key }}" {% if key|as_string in field.value|as_list_of_stringsg %}checked{% endif %}>
             {{ text }}
         </label>
       {% endfor %}
@@ -16,7 +18,7 @@
     {% for key, text in field.choices.items %}
       <div class="checkbox">
         <label>
-          <input type="checkbox" name="{{ field.name }}" value="{{ key }}" {% if key in field.value %}checked{% endif %}>
+          <input type="checkbox" name="{{ field.name }}" value="{{ key }}" {% if key|as_string in field.value|as_list_of_stringsg %}checked{% endif %}>
           {{ text }}
         </label>
       </div>
diff --git a/rest_framework/templates/rest_framework/vertical/radio.html b/rest_framework/templates/rest_framework/vertical/radio.html
index 9922ef6a1..6e5d2232c 100644
--- a/rest_framework/templates/rest_framework/vertical/radio.html
+++ b/rest_framework/templates/rest_framework/vertical/radio.html
@@ -1,4 +1,5 @@
 {% load i18n %}
+{% load rest_framework %}
 {% trans "None" as none_choice %}
 
 <div class="form-group {% if field.errors %}has-error{% endif %}">
@@ -19,7 +20,7 @@
 
         {% for key, text in field.choices.items %}
           <label class="radio-inline">
-            <input type="radio" name="{{ field.name }}" value="{{ key }}" {% if key == field.value %}checked{% endif %}>
+            <input type="radio" name="{{ field.name }}" value="{{ key }}" {% if key|as_string == field.value|as_string %}checked{% endif %}>
             {{ text }}
           </label>
         {% endfor %}
@@ -37,7 +38,7 @@
       {% for key, text in field.choices.items %}
         <div class="radio">
           <label>
-            <input type="radio" name="{{ field.name }}" value="{{ key }}" {% if key == field.value %}checked{% endif %}>
+            <input type="radio" name="{{ field.name }}" value="{{ key }}" {% if key|as_string == field.value|as_string %}checked{% endif %}>
             {{ text }}
           </label>
         </div>
diff --git a/rest_framework/templates/rest_framework/vertical/select.html b/rest_framework/templates/rest_framework/vertical/select.html
index 9736fc072..6ccaaf27f 100644
--- a/rest_framework/templates/rest_framework/vertical/select.html
+++ b/rest_framework/templates/rest_framework/vertical/select.html
@@ -1,3 +1,5 @@
+{% load rest_framework %}
+
 <div class="form-group {% if field.errors %}has-error{% endif %}">
   {% if field.label %}
     <label {% if style.hide_label %}class="sr-only"{% endif %}>
@@ -15,7 +17,7 @@
         {% elif select.end_option_group %}
           </optgroup>
         {% else %}
-          <option value="{{ select.value }}" {% if select.value == field.value %}selected{% endif %} {% if select.disabled %}disabled{% endif %}>{{ select.display_text }}</option>
+          <option value="{{ select.value }}" {% if select.value|as_string == field.value|as_string %}selected{% endif %} {% if select.disabled %}disabled{% endif %}>{{ select.display_text }}</option>
         {% endif %}
     {% endfor %}
   </select>
diff --git a/rest_framework/templates/rest_framework/vertical/select_multiple.html b/rest_framework/templates/rest_framework/vertical/select_multiple.html
index 8d0be0427..b77c4be3b 100644
--- a/rest_framework/templates/rest_framework/vertical/select_multiple.html
+++ b/rest_framework/templates/rest_framework/vertical/select_multiple.html
@@ -1,4 +1,5 @@
 {% load i18n %}
+{% load rest_framework %}
 {% trans "No items to select." as no_items %}
 
 <div class="form-group {% if field.errors %}has-error{% endif %}">
@@ -15,7 +16,7 @@
         {% elif select.end_option_group %}
           </optgroup>
         {% else %}
-          <option value="{{ select.value }}" {% if select.value in field.value %}selected{% endif %} {% if select.disabled %}disabled{% endif %}>{{ select.display_text }}</option>
+          <option value="{{ select.value }}" {% if select.value|as_string in field.value|as_list_of_strings %}selected{% endif %} {% if select.disabled %}disabled{% endif %}>{{ select.display_text }}</option>
         {% endif %}
     {% empty %}
         <option>{{ no_items }}</option>
diff --git a/rest_framework/templatetags/rest_framework.py b/rest_framework/templatetags/rest_framework.py
index 225edcbee..a3fa98bd5 100644
--- a/rest_framework/templatetags/rest_framework.py
+++ b/rest_framework/templatetags/rest_framework.py
@@ -89,6 +89,16 @@ def add_query_param(request, key, val):
     return escape(replace_query_param(uri, key, val))
 
 
+@register.filter
+def as_string(value):
+    return "%s" % value
+
+
+@register.filter
+def as_list_of_strings(value):
+    return ["%s" % item for item in value]
+
+
 @register.filter
 def add_class(value, css_class):
     """
diff --git a/rest_framework/utils/serializer_helpers.py b/rest_framework/utils/serializer_helpers.py
index 115f1e186..4734332af 100644
--- a/rest_framework/utils/serializer_helpers.py
+++ b/rest_framework/utils/serializer_helpers.py
@@ -78,7 +78,7 @@ class BoundField(object):
         ))
 
     def as_form_field(self):
-        value = '' if (self.value is None or self.value is False) else force_text(self.value)
+        value = '' if (self.value is None or self.value is False) else self.value
         return self.__class__(self._field, value, self.errors, self._prefix)