X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/d619bfea3c16942826ae2df297f7e1660f63f8ac..16c91c1902f065c6d9b12a5c89c04d6aef620291:/models/fields.py?ds=sidebyside diff --git a/models/fields.py b/models/fields.py index 9483516..83798c4 100644 --- a/models/fields.py +++ b/models/fields.py @@ -1,23 +1,26 @@ -from django.db import models from django import forms from django.core.exceptions import FieldError, ValidationError +from django.db import models +from django.db.models.fields import NOT_PROVIDED from django.utils import simplejson as json from django.utils.text import capfirst from philo.signals import entity_class_prepared from philo.validators import TemplateValidator, json_validator -__all__ = ('AttributeField', 'RelationshipField') +__all__ = ('JSONAttribute', 'ForeignKeyAttribute', 'ManyToManyAttribute') class EntityProxyField(object): descriptor_class = None - def __init__(self, *args, **kwargs): + def __init__(self, verbose_name=None, help_text=None, default=NOT_PROVIDED, editable=True, *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) + self.verbose_name = verbose_name + self.help_text = help_text + self.default = default + self.editable = editable def actually_contribute_to_class(self, sender, **kwargs): sender._entity_meta.add_proxy_field(self) @@ -39,6 +42,9 @@ class EntityProxyField(object): def value_from_object(self, obj): return getattr(obj, self.attname) + + def has_default(self): + return self.default is not NOT_PROVIDED class AttributeFieldDescriptor(object): @@ -47,30 +53,73 @@ class AttributeFieldDescriptor(object): 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: + if self.field in instance._added_attribute_registry: + return instance._added_attribute_registry[self.field] + if self.field 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__)) + return None 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 + 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) + if self.field in instance._added_attribute_registry: + del instance._added_attribute_registry[self.field] + instance._removed_attribute_registry.append(self.field) + + +class JSONAttributeDescriptor(AttributeFieldDescriptor): + def __set__(self, instance, value): + if self.field in instance._removed_attribute_registry: + instance._removed_attribute_registry.remove(self.field) + instance._added_attribute_registry[self.field] = value + + +class ForeignKeyAttributeDescriptor(AttributeFieldDescriptor): + def __set__(self, instance, value): + if isinstance(value, (models.Model, type(None))): + if self.field in instance._removed_attribute_registry: + instance._removed_attribute_registry.remove(self.field) + instance._added_attribute_registry[self.field] = 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.query.QuerySet): + if self.field in instance._removed_attribute_registry: + instance._removed_attribute_registry.remove(self.field) + instance._added_attribute_registry[self.field] = value + else: + raise AttributeError('The \'%s\' attribute can only be set to a QuerySet.' % self.field.name) class AttributeField(EntityProxyField): - descriptor_class = AttributeFieldDescriptor + def contribute_to_class(self, cls, name): + super(AttributeField, self).contribute_to_class(cls, name) + if self.key is None: + self.key = name + + def set_attribute_value(self, attribute, value, value_class): + if not isinstance(attribute.value, value_class): + if isinstance(attribute.value, models.Model): + attribute.value.delete() + new_value = value_class() + else: + new_value = attribute.value + new_value.value = value + new_value.save() + attribute.value = new_value + + +class JSONAttribute(AttributeField): + descriptor_class = JSONAttributeDescriptor def __init__(self, field_template=None, key=None, **kwargs): super(AttributeField, self).__init__(**kwargs) @@ -79,72 +128,69 @@ class AttributeField(EntityProxyField): field_template = models.CharField(max_length=255) self.field_template = field_template - 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} + if self.has_default(): + defaults['initial'] = self.default defaults.update(kwargs) return self.field_template.formfield(**defaults) - - -class RelationshipFieldDescriptor(object): - def __init__(self, field): - self.field = field - def __get__(self, instance, owner): - if instance: - if self.field.key in instance._added_relationship_registry: - return instance._added_relationship_registry[self.field.key] - if self.field.key in instance._removed_relationship_registry: - return None - try: - return instance.relationships[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): - if isinstance(value, (models.Model, type(None))): - if self.field.key in instance._removed_relationship_registry: - instance._removed_relationship_registry.remove(self.field.key) - instance._added_relationship_registry[self.field.key] = value - else: - raise AttributeError('The \'%s\' attribute can only be set using existing Model objects.' % self.field.name) + def value_from_object(self, obj): + try: + return getattr(obj, self.attname) + except AttributeError: + return None - def __delete__(self, instance): - if self.field.key in instance._added_relationship_registry: - del instance._added_relationship_registry[self.field.key] - instance._removed_relationship_registry.append(self.field.key) + def set_attribute_value(self, attribute, value, value_class=None): + if value_class is None: + from philo.models.base import JSONValue + value_class = JSONValue + super(JSONAttribute, self).set_attribute_value(attribute, value, value_class) -class RelationshipField(EntityProxyField): - descriptor_class = RelationshipFieldDescriptor +class ForeignKeyAttribute(AttributeField): + descriptor_class = ForeignKeyAttributeDescriptor def __init__(self, model, limit_choices_to=None, key=None, **kwargs): - super(RelationshipField, self).__init__(**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 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): defaults = {'required': False, 'label': capfirst(self.verbose_name), 'help_text': self.help_text} + if self.has_default(): + defaults['initial'] = self.default 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) + try: + relobj = super(ForeignKeyAttribute, self).value_from_object(obj) + except AttributeError: + return None return getattr(relobj, 'pk', None) + + def set_attribute_value(self, attribute, value, value_class=None): + if value_class is None: + from philo.models.base import ForeignKeyValue + value_class = ForeignKeyValue + super(ForeignKeyAttribute, self).set_attribute_value(attribute, value, value_class) + + +class ManyToManyAttribute(ForeignKeyAttribute): + descriptor_class = ManyToManyAttributeDescriptor + + def formfield(self, form_class=forms.ModelMultipleChoiceField, **kwargs): + return super(ManyToManyAttribute, self).formfield(form_class, **kwargs) + + def set_attribute_value(self, attribute, value, value_class=None): + if value_class is None: + from philo.models.base import ManyToManyValue + value_class = ManyToManyValue + super(ManyToManyAttribute, self).set_attribute_value(attribute, value, value_class) class TemplateField(models.TextField): @@ -154,7 +200,11 @@ class TemplateField(models.TextField): class JSONFormField(forms.Field): + default_validators = [json_validator] + def clean(self, value): + if value == '' and not self.required: + return None try: return json.loads(value) except Exception, e: @@ -185,9 +235,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 @@ -195,6 +243,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