Changeset 7626

Timestamp:

06/12/08 15:13:27 (3 months ago)

Author:

brosner

Message:

newforms-admin: Fixed #5731 -- Implemented ModelAdmin?.radio_fields to match trunk's radio_admin. Removed legacy code and added tests. Thanks Karen Tracey for the initial work.

Files:

• django/branches/newforms-admin/django/contrib/admin/__init__.py (modified) (1 diff)
• django/branches/newforms-admin/django/contrib/admin/options.py (modified) (4 diffs)
• django/branches/newforms-admin/django/contrib/admin/widgets.py (modified) (2 diffs)
• django/branches/newforms-admin/django/contrib/redirects/models.py (modified) (2 diffs)
• django/branches/newforms-admin/django/db/models/fields/__init__.py (modified) (6 diffs)
• django/branches/newforms-admin/django/db/models/fields/related.py (modified) (3 diffs)
• django/branches/newforms-admin/docs/admin.txt (modified) (1 diff)
• django/branches/newforms-admin/docs/custom_model_fields.txt (modified) (1 diff)
• django/branches/newforms-admin/docs/model-api.txt (modified) (1 diff)
• django/branches/newforms-admin/tests/regressiontests/modeladmin/models.py (modified) (4 diffs)

django/branches/newforms-admin/django/contrib/admin/__init__.py

@@ -1 @@
-
+, HORIZONTAL, VERTICAL
-from django.contrib.admin.options import StackedInline, TabularInline
-from django.contrib.admin.sites import AdminSite, site

django/branches/newforms-admin/django/contrib/admin/options.py

@@ -18 +18 @@
-import sets
-
+HORIZONTAL, VERTICAL = 1, 2
+# returns the <ul> class for a given radio_admin field
+get_ul_class = lambda x: 'radiolist%s' % ((x == HORIZONTAL) and ' inline' or '')
+
-class IncorrectLookupParameters(Exception):
-    pass
@@ -134 +138 @@
-    filter_vertical = ()
-    filter_horizontal = ()
+    radio_fields = {}
-    prepopulated_fields = {}
-
@@ -174 +179 @@
-            if isinstance(db_field, models.ForeignKey) and db_field.name in self.raw_id_fields:
-                kwargs['widget'] = widgets.ForeignKeyRawIdWidget(db_field.rel)
+            elif isinstance(db_field, models.ForeignKey) and db_field.name in self.radio_fields:
+                kwargs['widget'] = widgets.AdminRadioSelect(attrs={
+                    'class': get_ul_class(self.radio_fields[db_field.name]),
+                })
+                kwargs['empty_label'] = db_field.blank and _('None') or None
-            else:
-                if isinstance(db_field, models.ManyToManyField):
@@ -188 +198 @@
-                formfield.widget.render = widgets.RelatedFieldWidgetWrapper(formfield.widget.render, db_field.rel, self.admin_site)
-            return formfield
+        
+        if db_field.choices and db_field.name in self.radio_fields:
+            kwargs['widget'] = widgets.AdminRadioSelect(
+                choices=db_field.get_choices(include_blank=db_field.blank,
+                    blank_choice=[('', _('None'))]),
+                attrs={
+                    'class': get_ul_class(self.radio_fields[db_field.name]),
+                }
+            )
-
-        # For any other type of field, just call its formfield() method.

django/branches/newforms-admin/django/contrib/admin/widgets.py

@@ -4 +4 @@
-
-from django import newforms as forms
+from django.newforms.widgets import RadioFieldRenderer
+from django.newforms.util import flatatt
-from django.utils.datastructures import MultiValueDict
-from django.utils.text import capfirst, truncate_words
@@ -62 +64 @@
-        return mark_safe(u'<p class="datetime">%s %s<br />%s %s</p>' % \
-            (_('Date:'), rendered_widgets[0], _('Time:'), rendered_widgets[1]))
+
+class AdminRadioFieldRenderer(RadioFieldRenderer):
+    def render(self):
+        """Outputs a <ul> for this set of radio fields."""
+        return mark_safe(u'<ul%s>\n%s\n</ul>' % (
+            flatatt(self.attrs),
+            u'\n'.join([u'<li>%s</li>' % force_unicode(w) for w in self]))
+        )
+
+class AdminRadioSelect(forms.RadioSelect):
+    renderer = AdminRadioFieldRenderer
-
-class AdminFileWidget(forms.FileInput):

django/branches/newforms-admin/django/contrib/redirects/models.py

@@ -4 +4 @@
-
-class Redirect(models.Model):
-, radio_admin=models.VERTICAL
+
-    old_path = models.CharField(_('redirect from'), max_length=200, db_index=True,
-        help_text=_("This should be an absolute path, excluding the domain name. Example: '/events/search/'."))
@@ -29 +29 @@
-    list_filter = ('site',)
-    search_fields = ('old_path', 'new_path')
+    radio_fields = {'site': admin.VERTICAL}
-
-admin.site.register(Redirect, RedirectAdmin)

django/branches/newforms-admin/django/db/models/fields/__init__.py

@@ -27 +27 @@
-    pass
-
-HORIZONTAL, VERTICAL = 1, 2
-
-# The values to use for "blank" in SelectFields. Will be appended to the start of most "choices" lists.
-BLANK_CHOICE_DASH = [("", "---------")]
@@ -35 +33 @@
-# prepares a value for use in a LIKE query
-prep_for_like_query = lambda x: smart_unicode(x).replace("\\", "\\\\").replace("%", "\%").replace("_", "\_")
-
-# returns the <ul> class for a given radio_admin value
-get_ul_class = lambda x: 'radiolist%s' % ((x == HORIZONTAL) and ' inline' or '')
-
-class FieldDoesNotExist(Exception):
@@ -88 +83 @@
-            editable=True, serialize=True, unique_for_date=None,
-            unique_for_month=None, unique_for_year=None, validator_list=None,
-radio_admin=None, help_text='', db_column
-db_tablespace=None, 
+help_text='', db_column=None, db_tablespace
+
-        self.name = name
-        self.verbose_name = verbose_name
@@ -106 +101 @@
-        self.unique_for_year = unique_for_year
-        self._choices = choices or []
-        self.radio_admin = radio_admin
-        self.help_text = help_text
-        self.db_column = db_column
@@ -286 +280 @@
-
-        if self.choices:
-
-
-
-
-
+
-
-            params['choices'] = self.get_choices_default()
@@ -378 +368 @@
-
-    def get_choices_default(self):
-
-
-
-
+
-
-    def _get_val_from_obj(self, obj):

django/branches/newforms-admin/django/db/models/fields/related.py

@@ -1 +1 @@
-from django.db import connection, transaction
-from django.db.models import signals, get_model
-get_ul_class, 
+
-from django.db.models.related import RelatedObject
-from django.db.models.query_utils import QueryWrapper
@@ -629 +629 @@
-    def prepare_field_objs_and_params(self, manipulator, name_prefix):
-        params = {'validator_list': self.validator_list[:], 'member_name': name_prefix + self.attname}
-
-
-
+
+
-        else:
-
-
-
-
+
-        params['choices'] = self.get_choices_default()
-        return field_objs, params
@@ -661 +657 @@
-            # In required many-to-one fields with only one available choice,
-            # select that one available choice. Note: For SelectFields
-
-
-
-
+
+
-            if not self.blank and self.choices:
-                choice_list = self.get_choices_default()
-
-
-
+
-                    return {self.attname: choice_list[1][0]}
-        return Field.flatten_data(self, follow, obj)

django/branches/newforms-admin/docs/admin.txt

@@ -345 +345 @@
-If this isn't provided, the Django admin will use the model's default ordering.
-
+``radio_fields``
+----------------
+
+By default, Django's admin uses a select-box interface (<select>) for
+fields that are ``ForeignKey`` or have ``choices`` set. If a field is present
+in ``radio_fields``, Django will use a radio-button interface instead.
+Assuming ``group`` is a ``ForeignKey`` on the ``Person`` model::
+
+    class PersonAdmin(admin.ModelAdmin):
+        radio_fields = {"group": admin.VERTICAL}
+
+You have the choice of using ``HORIZONTAL`` or ``VERTICAL`` from the
+``django.contrib.admin`` module.
+
+Don't include a field in ``radio_fields`` unless it's a ``ForeignKey`` or has
+``choices`` set.
+
-``save_as``
------------

django/branches/newforms-admin/docs/custom_model_fields.txt

@@ -205 +205 @@
-    * ``validator_list``
-    * ``choices``
-    * ``radio_admin``
-    * ``help_text``
-    * ``db_column``

django/branches/newforms-admin/docs/model-api.txt

@@ -663 +663 @@
-``primary_key=True`` implies ``blank=False``, ``null=False`` and
-``unique=True``. Only one primary key is allowed on an object.
-
-``radio_admin``
-~~~~~~~~~~~~~~~
-
-By default, Django's admin uses a select-box interface (<select>) for
-fields that are ``ForeignKey`` or have ``choices`` set. If ``radio_admin``
-is set to ``True``, Django will use a radio-button interface instead.
-
-Don't use this for a field unless it's a ``ForeignKey`` or has ``choices``
-set.
-
-``unique``

django/branches/newforms-admin/tests/regressiontests/modeladmin/models.py

@@ -1 +1 @@
-# coding: utf-8
-from django.db import models
+from datetime import date
-
-class Band(models.Model):
@@ -6 +7 @@
-    bio = models.TextField()
-    sign_date = models.DateField()
+    
+    def __unicode__(self):
+        return self.name
+
+class Concert(models.Model):
+    main_band = models.ForeignKey(Band, related_name='main_concerts')
+    opening_band = models.ForeignKey(Band, related_name='opening_concerts',
+        blank=True)
+    day = models.CharField(max_length=3, choices=((1, 'Fri'), (2, 'Sat')))
+    transport = models.CharField(max_length=100, choices=(
+        (1, 'Plane'),
+        (2, 'Train'),
+        (3, 'Bus')
+    ), blank=True)
-
-
-__test__ = {'API_TESTS': """
-
-
+, HORIZONTAL, VERTICAL
->>> from django.contrib.admin.sites import AdminSite
-
@@ -18 +33 @@
->>> request = None
-
-
+
+
+
-
-Under the covers, the admin system will initialize ModelAdmin with a Model
@@ -106 +123 @@
-<class 'django.contrib.admin.widgets.AdminDateWidget'>
-
+# radio_fields behavior ################################################
+
+First, without any radio_fields specified, the widgets for ForeignKey
+and fields with choices specified ought to be a basic Select widget.
+For Select fields, all of the choices lists have a first entry of dashes.
+
+>>> cma = ModelAdmin(Concert, site)
+>>> cmafa = cma.get_form(request)
+
+>>> type(cmafa.base_fields['main_band'].widget)
+<class 'django.newforms.widgets.Select'>
+>>> list(cmafa.base_fields['main_band'].widget.choices)
+[(u'', u'---------'), (1, u'The Doors')]
+
+>>> type(cmafa.base_fields['opening_band'].widget)
+<class 'django.newforms.widgets.Select'>
+>>> list(cmafa.base_fields['opening_band'].widget.choices)
+[(u'', u'---------'), (1, u'The Doors')]
+
+>>> type(cmafa.base_fields['day'].widget)
+<class 'django.newforms.widgets.Select'>
+>>> list(cmafa.base_fields['day'].widget.choices)
+[('', '---------'), (1, 'Fri'), (2, 'Sat')]
+
+>>> type(cmafa.base_fields['transport'].widget)
+<class 'django.newforms.widgets.Select'>
+>>> list(cmafa.base_fields['transport'].widget.choices)
+[('', '---------'), (1, 'Plane'), (2, 'Train'), (3, 'Bus')]
+
+Now specify all the fields as radio_fields.  Widgets should now be
+RadioSelect, and the choices list should have a first entry of 'None' iff
+blank=True for the model field.  Finally, the widget should have the
+'radiolist' attr, and 'inline' as well if the field is specified HORIZONTAL.
+
+>>> class ConcertAdmin(ModelAdmin):
+...     radio_fields = {
+...         'main_band': HORIZONTAL,
+...         'opening_band': VERTICAL,
+...         'day': VERTICAL,
+...         'transport': HORIZONTAL,
+...     }
+
+>>> cma = ConcertAdmin(Concert, site)
+>>> cmafa = cma.get_form(request)
+
+>>> type(cmafa.base_fields['main_band'].widget)
+<class 'django.contrib.admin.widgets.AdminRadioSelect'>
+>>> cmafa.base_fields['main_band'].widget.attrs
+{'class': 'radiolist inline'}
+>>> list(cmafa.base_fields['main_band'].widget.choices)
+[(1, u'The Doors')]
+
+>>> type(cmafa.base_fields['opening_band'].widget)
+<class 'django.contrib.admin.widgets.AdminRadioSelect'>
+>>> cmafa.base_fields['opening_band'].widget.attrs
+{'class': 'radiolist'}
+>>> list(cmafa.base_fields['opening_band'].widget.choices)
+[(u'', u'None'), (1, u'The Doors')]
+
+>>> type(cmafa.base_fields['day'].widget)
+<class 'django.contrib.admin.widgets.AdminRadioSelect'>
+>>> cmafa.base_fields['day'].widget.attrs
+{'class': 'radiolist'}
+>>> list(cmafa.base_fields['day'].widget.choices)
+[(1, 'Fri'), (2, 'Sat')]
+
+>>> type(cmafa.base_fields['transport'].widget)
+<class 'django.contrib.admin.widgets.AdminRadioSelect'>
+>>> cmafa.base_fields['transport'].widget.attrs
+{'class': 'radiolist inline'}
+>>> list(cmafa.base_fields['transport'].widget.choices)
+[('', u'None'), (1, 'Plane'), (2, 'Train'), (3, 'Bus')]
+
+>>> band.delete()
+
-"""
-}