X-Git-Url: http://git.ithinksw.org/philo.git/blobdiff_plain/2f2aed7e371d11b021432124de8f9bdd436b0832..16c91c1902f065c6d9b12a5c89c04d6aef620291:/models/fields.py?ds=sidebyside diff --git a/models/fields.py b/models/fields.py index 7f76b9c..83798c4 100644 --- a/models/fields.py +++ b/models/fields.py @@ -1,12 +1,50 @@ +from django import forms +from django.core.exceptions import FieldError, ValidationError from django.db import models -from django.db.models import signals -from django.core.exceptions import ObjectDoesNotExist, FieldError -from django.contrib.contenttypes.models import ContentType -from functools import partial -from philo.models.base import Attribute, Relationship, Entity +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, 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 = 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) + 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) + + def has_default(self): + return self.default is not NOT_PROVIDED class AttributeFieldDescriptor(object): @@ -15,82 +53,211 @@ class AttributeFieldDescriptor(object): def __get__(self, instance, owner): if instance: + 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.attribute_set.get(key__exact=self.field.key).value - except ObjectDoesNotExist: + 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): - try: - attribute = instance.attribute_set.get(key__exact=self.field.key) - except ObjectDoesNotExist: - attribute = Attribute() - attribute.entity = instance - attribute.key = self.field.key - attribute.value = value - attribute.save() + raise NotImplementedError('AttributeFieldDescriptor subclasses must implement a __set__ method.') def __delete__(self, instance): - instance.attribute_set.filter(key__exact=self.field.key).delete() + if self.field in instance._added_attribute_registry: + del instance._added_attribute_registry[self.field] + instance._removed_attribute_registry.append(self.field) -class AttributeField(object): - def __init__(self, key): +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): + 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) self.key = key + if field_template is None: + field_template = models.CharField(max_length=255) + self.field_template = field_template - def actually_contribute_to_class(self, sender, **kwargs): - setattr(sender, self.name, AttributeFieldDescriptor(self)) + 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) - 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.') + def value_from_object(self, obj): + try: + return getattr(obj, self.attname) + except AttributeError: + return None + + 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 RelationshipFieldDescriptor(object): +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} + 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): + 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): + 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): + default_validators = [json_validator] + + def clean(self, value): + if value == '' and not self.required: + return None + 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 def __get__(self, instance, owner): - if instance: - try: - return instance.relationship_set.get(key__exact=self.field.key).value - except ObjectDoesNotExist: - return None - else: - raise AttributeError('The \'%s\' attribute can only be accessed from %s instances.' % (self.field.name, owner.__name__)) + if instance is None: + raise AttributeError # ? + + if self.field.name not in instance.__dict__: + json_string = getattr(instance, self.field.attname) + instance.__dict__[self.field.name] = json.loads(json_string) + + return instance.__dict__[self.field.name] def __set__(self, instance, value): - if isinstance(value, (models.Model, type(None))): - try: - relationship = instance.relationship_set.get(key__exact=self.field.key) - except ObjectDoesNotExist: - relationship = Relationship() - relationship.entity = instance - relationship.key = self.field.key - relationship.value = value - relationship.save() - else: - raise AttributeError('The \'%\' attribute can only be set using existing Model objects.' % self.field.name) + instance.__dict__[self.field.name] = value + setattr(instance, self.field.attname, json.dumps(value)) def __delete__(self, instance): - instance.relationship_set.filter(key__exact=self.field.key).delete() + del(instance.__dict__[self.field.name]) + setattr(instance, self.field.attname, json.dumps(None)) -class RelationshipField(object): - def __init__(self, key): - self.key = key +class JSONField(models.TextField): + default_validators = [json_validator] - def actually_contribute_to_class(self, sender, **kwargs): - setattr(sender, self.name, RelationshipFieldDescriptor(self)) + def get_attname(self): + return "%s_json" % self.name 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(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 + return super(JSONField, self).formfield(*args, **kwargs) + + +try: + from south.modelsinspector import add_introspection_rules +except ImportError: + pass +else: + add_introspection_rules([], ["^philo\.models\.fields\.TemplateField"]) + add_introspection_rules([], ["^philo\.models\.fields\.JSONField"]) \ No newline at end of file