X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/aca27b0d4429d193b539f993eb629d28efd2157b..4c276c601b86efbba0236eea2bda190bdff48af1:/models/fields.py diff --git a/models/fields.py b/models/fields.py index 467befb..dbf1886 100644 --- a/models/fields.py +++ b/models/fields.py @@ -1,12 +1,45 @@ from django.db import models -from django.db.models import signals +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 +from philo.validators import TemplateValidator __all__ = ('AttributeField', 'RelationshipField') +class EntityProxyField(object): + descriptor_class = None + + 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) + setattr(sender, self.attname, self.descriptor_class(self)) + + def contribute_to_class(self, cls, name): + 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__) + + def formfield(self, *args, **kwargs): + raise NotImplementedError('EntityProxyField subclasses must implement a formfield method.') + + def value_from_object(self, obj): + return getattr(obj, self.attname) + + class AttributeFieldDescriptor(object): def __init__(self, field): self.field = field @@ -35,19 +68,25 @@ class AttributeFieldDescriptor(object): instance._removed_attribute_registry.append(self.field.key) -class AttributeField(object): - def __init__(self, key): - self.key = key +class AttributeField(EntityProxyField): + descriptor_class = AttributeFieldDescriptor - def actually_contribute_to_class(self, sender, **kwargs): - setattr(sender, self.name, AttributeFieldDescriptor(self)) + 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 contribute_to_class(self, cls, name): - if issubclass(cls, Entity): - self.name = name - signals.class_prepared.connect(self.actually_contribute_to_class, sender=cls) - else: - raise FieldError('AttributeFields can only be declared on Entity subclasses.') + 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): @@ -81,16 +120,41 @@ class RelationshipFieldDescriptor(object): instance._removed_relationship_registry.append(self.field.key) -class RelationshipField(object): - def __init__(self, key): - self.key = key +class RelationshipField(EntityProxyField): + descriptor_class = RelationshipFieldDescriptor - def actually_contribute_to_class(self, sender, **kwargs): - setattr(sender, self.name, RelationshipFieldDescriptor(self)) + 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): - if issubclass(cls, Entity): - self.name = name - signals.class_prepared.connect(self.actually_contribute_to_class, sender=cls) - else: - raise FieldError('RelationshipFields can only be declared on Entity subclasses.') \ No newline at end of file + super(RelationshipField, self).contribute_to_class(cls, name) + if self.key is None: + self.key = name + + def formfield(self, form_class=forms.ModelChoiceField, **kwargs): + 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) + return getattr(relobj, 'pk', None) + + +class TemplateField(models.TextField): + def __init__(self, allow=None, disallow=None, secure=True, *args, **kwargs): + super(TemplateField, self).__init__(*args, **kwargs) + self.validators.append(TemplateValidator(allow, disallow, secure)) + + +try: + from south.modelsinspector import add_introspection_rules +except ImportError: + pass +else: + add_introspection_rules([], ["^philo\.models\.fields\.TemplateField"]) \ No newline at end of file