X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/1d3756407233b937d7491bde6dd4046fb8b4b6d6..15c68a7a08349d807c767cce58fdbeec0dcc192d:/models/fields.py?ds=inline diff --git a/models/fields.py b/models/fields.py index 0c68858..0289e57 100644 --- a/models/fields.py +++ b/models/fields.py @@ -1,165 +1,16 @@ -from django.db import models from django import forms -from django.core.exceptions import FieldError, ValidationError +from django.db import models from django.utils import simplejson as json -from django.utils.text import capfirst -from philo.signals import entity_class_prepared +from philo.forms.fields import JSONFormField from philo.validators import TemplateValidator, json_validator -__all__ = ('JSONAttribute', 'ForeignKeyAttribute', 'ManyToManyAttribute') - - -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): - from philo.models.base import Entity - 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 - - def __get__(self, instance, owner): - if instance: - if self.field.key in instance._added_attribute_registry: - return instance._added_attribute_registry[self.field.key] - if self.field.key in instance._removed_attribute_registry: - return None - try: - return instance.attributes[self.field.key] - except KeyError: - return None - else: - raise AttributeError('The \'%s\' attribute can only be accessed from %s instances.' % (self.field.name, owner.__name__)) - - def __set__(self, instance, value): - raise NotImplementedError('AttributeFieldDescriptor subclasses must implement a __set__ method.') - - def __delete__(self, instance): - if self.field.key in instance._added_attribute_registry: - del instance._added_attribute_registry[self.field.key] - instance._removed_attribute_registry.append(self.field.key) - - -class JSONAttributeDescriptor(AttributeFieldDescriptor): - def __set__(self, instance, value): - if self.field.key in instance._removed_attribute_registry: - instance._removed_attribute_registry.remove(self.field.key) - instance._added_attribute_registry[self.field.key] = value - - -class ForeignKeyAttributeDescriptor(AttributeFieldDescriptor): - def __set__(self, instance, value): - if isinstance(value, (models.Model, type(None))): - if self.field.key in instance._removed_attribute_registry: - instance._removed_attribute_registry.remove(self.field.key) - instance._added_attribute_registry[self.field.key] = value - else: - raise AttributeError('The \'%s\' attribute can only be set using existing Model objects.' % self.field.name) - - -class ManyToManyAttributeDescriptor(AttributeFieldDescriptor): - def __set__(self, instance, value): - if isinstance(value, models.QuerySet): - if self.field.key in instance._removed_attribute_registry: - instance._removed_attribute_registry.remove(self.field.key) - instance._added_attribute_registry[self.field.key] = value - else: - raise AttributeError('The \'%s\' attribute can only be set to a QuerySet.' % self.field.name) - - -class AttributeField(EntityProxyField): - def contribute_to_class(self, cls, name): - super(AttributeField, self).contribute_to_class(cls, name) - if self.key is None: - self.key = name - - -class JSONAttribute(AttributeField): - descriptor_class = JSONAttributeDescriptor - - 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, **kwargs): - defaults = {'required': False, 'label': capfirst(self.verbose_name), 'help_text': self.help_text} - defaults.update(kwargs) - return self.field_template.formfield(**defaults) - - def value_from_object(self, obj): - return getattr(obj, self.attname).value - - -class ForeignKeyAttribute(AttributeField): - descriptor_class = ForeignKeyAttributeDescriptor - - def __init__(self, model, limit_choices_to=None, key=None, **kwargs): - super(ForeignKeyAttribute, 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 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(ForeignKeyAttribute, self).value_from_object(obj).value - return getattr(relobj, 'pk', None) - - -class ManyToManyAttribute(AttributeField): - descriptor_class = ManyToManyAttributeDescriptor - #FIXME: Add __init__ and formfield methods - - 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)) -class JSONFormField(forms.Field): - def clean(self, value): - try: - return json.loads(value) - except Exception, e: - raise ValidationError(u'JSON decode error: %s' % e) - - class JSONDescriptor(object): def __init__(self, field): self.field = field @@ -184,9 +35,7 @@ class JSONDescriptor(object): class JSONField(models.TextField): - def __init__(self, *args, **kwargs): - super(JSONField, self).__init__(*args, **kwargs) - self.validators.append(json_validator) + default_validators = [json_validator] def get_attname(self): return "%s_json" % self.name @@ -194,6 +43,11 @@ class JSONField(models.TextField): def contribute_to_class(self, cls, name): super(JSONField, self).contribute_to_class(cls, name) setattr(cls, name, JSONDescriptor(self)) + models.signals.pre_init.connect(self.fix_init_kwarg, sender=cls) + + def fix_init_kwarg(self, sender, args, kwargs, **signal_kwargs): + if self.name in kwargs: + kwargs[self.attname] = json.dumps(kwargs.pop(self.name)) def formfield(self, *args, **kwargs): kwargs["form_class"] = JSONFormField