Added helper function to ease response 'returns' for signal listeners

[philo.git] / models / fields.py

diff --git a/models/fields.py b/models/fields.py
index 9fc2dfb..50df799 100644 (file)
--- a/models/fields.py
+++ b/models/fields.py
@@ -1,6 +1,7 @@
 from django.db import models
 from django import forms
 from django.core.exceptions import FieldError
+from django.utils.text import capfirst
 from philo.models.base import Entity
 from philo.signals import entity_class_prepared
 
@@ -14,6 +15,8 @@ class EntityProxyField(object):
        def __init__(self, *args, **kwargs):
                if self.descriptor_class is None:
                        raise NotImplementedError('EntityProxyField subclasses must specify a descriptor_class.')
+               self.verbose_name = kwargs.get('verbose_name', None)
+               self.help_text = kwargs.get('help_text', None)
        
        def actually_contribute_to_class(self, sender, **kwargs):
                sender._entity_meta.add_proxy_field(self)
@@ -23,6 +26,8 @@ class EntityProxyField(object):
                if issubclass(cls, Entity):
                        self.name = name
                        self.attname = name
+                       if self.verbose_name is None and name:
+                               self.verbose_name = name.replace('_', ' ')
                        entity_class_prepared.connect(self.actually_contribute_to_class, sender=cls)
                else:
                        raise FieldError('%s instances can only be declared on Entity subclasses.' % self.__class__.__name__)
@@ -65,16 +70,22 @@ class AttributeFieldDescriptor(object):
 class AttributeField(EntityProxyField):
        descriptor_class = AttributeFieldDescriptor
        
-       def __init__(self, key, field_template=None):
+       def __init__(self, field_template=None, key=None, **kwargs):
+               super(AttributeField, self).__init__(**kwargs)
                self.key = key
                if field_template is None:
                        field_template = models.CharField(max_length=255)
                self.field_template = field_template
        
-       def formfield(self, *args, **kwargs):
-               field = self.field_template.formfield(*args, **kwargs)
-               field.required = False
-               return field
+       def contribute_to_class(self, cls, name):
+               super(AttributeField, self).contribute_to_class(cls, name)
+               if self.key is None:
+                       self.key = name
+       
+       def formfield(self, **kwargs):
+               defaults = {'required': False, 'label': capfirst(self.verbose_name), 'help_text': self.help_text}
+               defaults.update(kwargs)
+               return self.field_template.formfield(**defaults)
 
 
 class RelationshipFieldDescriptor(object):
@@ -111,17 +122,23 @@ class RelationshipFieldDescriptor(object):
 class RelationshipField(EntityProxyField):
        descriptor_class = RelationshipFieldDescriptor
        
-       def __init__(self, key, model, limit_choices_to=None):
+       def __init__(self, model, limit_choices_to=None, key=None, **kwargs):
+               super(RelationshipField, self).__init__(**kwargs)
                self.key = key
                self.model = model
                if limit_choices_to is None:
                        limit_choices_to = {}
                self.limit_choices_to = limit_choices_to
        
+       def contribute_to_class(self, cls, name):
+               super(RelationshipField, self).contribute_to_class(cls, name)
+               if self.key is None:
+                       self.key = name
+       
        def formfield(self, form_class=forms.ModelChoiceField, **kwargs):
-               field = form_class(self.model._default_manager.complex_filter(self.limit_choices_to), **kwargs)
-               field.required = False
-               return field
+               defaults = {'required': False, 'label': capfirst(self.verbose_name), 'help_text': self.help_text}
+               defaults.update(kwargs)
+               return form_class(self.model._default_manager.complex_filter(self.limit_choices_to), **defaults)
        
        def value_from_object(self, obj):
                relobj = super(RelationshipField, self).value_from_object(obj)