Changeset 511

Timestamp:

01/26/10 14:18:05 (6 weeks ago)

Author:

olivier

Message:

Decorate Django fields so that they are not required (blank=True), and also have a default=value by default. The goal is DRY in the CREM models, and especially to prepare adding verbose names without cluttering the model classes.

Location:

trunk/telemeta/models

Files:

• core.py (modified) (4 diffs)
• crem.py (modified) (25 diffs)

trunk/telemeta/models/core.py

@@ -93 +93 @@
         return self._delta.days * 24 * 3600 + self._delta.seconds
             
+def normalize_field(args, default_value):
+    """Normalize field constructor arguments, so that the field is marked blank=True
+       and has a default value by default.
+       
+       This behaviour can be disabled by passing the special argument required=True.
+
+       The default value can also be overriden with the default=value argument.
+       """
+    required = False
+    if args.has_key('required'):
+        required = args['required']
+        args.pop('required')
+
+    args['blank'] = not required
+
+    if not required:
+        if not args.has_key('default'):
+            if args.get('null'):
+                args['default'] = None
+            else:
+                args['default'] = default_value
+
+    return args                
+
 # The following is based on Django TimeField
 class DurationField(models.Field):
     """Duration Django model field. Essentially the same as a TimeField, but
-    with values over 24h allowed."""
+    with values over 24h allowed.
+    
+    The constructor arguments are also normalized with normalize_field(). 
+    """
 
     description = _("Duration")
@@ -105 +132 @@
         'invalid': _('Enter a valid duration in HH:MM[:ss[.uuuuuu]] format.'),
     }
+
+    def __init__(self, *args, **kwargs):
+        super(DurationField, self).__init__(args, **normalize_field(kwargs, '00:00'))
 
     def get_internal_type(self):
@@ -145 +175 @@
         return super(DurationField, self).formfield(**defaults)
            
-
-class WeakForeignKey(models.ForeignKey):
+class ForeignKey(models.ForeignKey):
+    """The constructor arguments of this ForeignKey are normalized
+    with normalize_field(), however the field is marked required by default
+    unless it is allowed to be null."""
+
+    def __init__(self, to, **kwargs):
+        if not kwargs.has_key('required'):
+            if not kwargs.get('null'):
+                kwargs['required'] = True
+
+        super(ForeignKey, self).__init__(to, **normalize_field(kwargs, 0))                
+
+class WeakForeignKey(ForeignKey):
     """A weak foreign key is the same as foreign key but without cascading
     delete. Instead the reference is set to null when the referenced record
     get deleted. This emulates the ON DELETE SET NULL sql behaviour.
-    
+   
+    This field is automatically allowed to be null, there's no need to pass
+    null=True. 
+
+    The constructor arguments are normalized with normalize_field() by the
+    parent ForeignKey
+
     Warning: must be used in conjunction with EnhancedQuerySet, EnhancedManager,
     and EnhancedModel
     """
     def __init__(self, to, **kwargs):
+        kwargs['null'] = True
         super(WeakForeignKey, self).__init__(to, **kwargs)
        
@@ -198 +246 @@
     class Meta:
         abstract = True
+
+class CharField(models.CharField):
+    """This is a CharField with a default max_length of 250.
+    
+       The arguments are also normalized with normalize_field()"""
+
+    def __init__(self, *args, **kwargs):
+        if not kwargs.has_key('max_length'):
+            kwargs['max_length'] = 250
+
+        super(CharField, self).__init__(*args, **normalize_field(kwargs, ''))
+
+class IntegerField(models.IntegerField):
+    """IntegerField normalized with normalize_field()"""
+
+    def __init__(self, *args, **kwargs):
+        super(IntegerField, self).__init__(*args, **normalize_field(kwargs, 0))
+
+class BooleanField(models.BooleanField):
+    """BooleanField normalized with normalize_field()"""
+
+    def __init__(self, *args, **kwargs):
+        super(BooleanField, self).__init__(*args, **normalize_field(kwargs, False))
+
+class TextField(models.TextField):
+    """TextField normalized with normalize_field()"""
+
+    def __init__(self, *args, **kwargs):
+        super(TextField, self).__init__(*args, **normalize_field(kwargs, ''))
+
+class DateTimeField(models.DateTimeField):
+    """DateTimeField normalized with normalize_field()"""
+
+    def __init__(self, *args, **kwargs):
+        super(DateTimeField, self).__init__(*args, **normalize_field(kwargs, '0000-00-00 00:00'))
+
+class FileField(models.FileField):
+    """FileField normalized with normalize_field()"""
+
+    def __init__(self, *args, **kwargs):
+        super(FileField, self).__init__(*args, **normalize_field(kwargs, ''))
+
+class FloatField(models.FloatField):
+    """FloatField normalized with normalize_field()"""
+
+    def __init__(self, *args, **kwargs):
+        super(FloatField, self).__init__(*args, **normalize_field(kwargs, 0))
+
+class DateField(models.DateField):
+    """DateField normalized with normalize_field()"""
+
+    def __init__(self, *args, **kwargs):
+        super(DateField, self).__init__(*args, **normalize_field(kwargs, '0000-00-00'))
+

trunk/telemeta/models/crem.py

@@ -34 +34 @@
 #          David LIPSZYC <davidlipszyc@gmail.com>
 
-from django.db import models
 from django.core.exceptions import ObjectDoesNotExist
 import cremquery as query
@@ -40 +39 @@
 from telemeta.util.unaccent import unaccent_icmp
 import re
-from telemeta.models.core import DurationField, Duration, WeakForeignKey, EnhancedModel
+from telemeta.models.core import DurationField, Duration, WeakForeignKey, EnhancedModel, \
+                                 CharField, TextField, IntegerField, BooleanField, \
+                                 DateTimeField, FileField, ForeignKey, FloatField, DateField
 from telemeta.models import dublincore as dc
 
@@ -49 +50 @@
         required = []
         for field in cls._meta.fields:
-            if (field != cls._meta.pk and field.default == models.fields.NOT_PROVIDED and
-                    not field.null and not getattr(field, 'auto_now_add', False)):
+            if not field.blank:
                 required.append(field)
         return required
@@ -94 +94 @@
         for name, value in fields.iteritems():
             element = doc.createElement(self.get_dom_field_name(name))
-            if isinstance(value, models.Model):
+            if isinstance(value, EnhancedModel):
                 element.setAttribute('key', str(value.pk))
             value = unicode(value)
@@ -136 +136 @@
     code_regex             = '(?:%s|%s)' % (published_code_regex, unpublished_code_regex)
 
-    reference             = models.CharField(unique=True, max_length=250,
-                                             null=True)
-    physical_format       = WeakForeignKey('PhysicalFormat', related_name="collections", null=True)
-    old_code              = models.CharField(unique=True, max_length=250, null=True)
-    code                  = models.CharField(unique=True, max_length=250)
-    title                 = models.CharField(max_length=250)
-    alt_title             = models.CharField(max_length=250, default="")
-    physical_items_num    = models.IntegerField(default=0)
-    publishing_status     = WeakForeignKey('PublishingStatus', related_name="collections", null=True)
-    creator               = models.CharField(max_length=250, default="")
-    booklet_author        = models.CharField(max_length=250, default="")
-    booklet_description   = models.TextField(default="")
-    collector             = models.CharField(max_length=250, default="")
-    collector_is_creator  = models.BooleanField(default="")
-    publisher             = WeakForeignKey('Publisher', related_name="collections", null=True)     
-    is_published          = models.BooleanField(default="")
-    year_published        = models.IntegerField(default=0)
-    publisher_collection  = WeakForeignKey('PublisherCollection', related_name="collections", null=True)
-    publisher_serial      = models.CharField(max_length=250, default="")
-    external_references   = models.TextField(default="")
-    acquisition_mode      = WeakForeignKey('AcquisitionMode', related_name="collections", null=True)
-    comment               = models.TextField(default="")
-    metadata_author       = WeakForeignKey('MetadataAuthor', related_name="collections", null=True)
-    metadata_writer       = WeakForeignKey('MetadataWriter', related_name="collections", null=True)
-    legal_rights          = WeakForeignKey('LegalRight', related_name="collections", null=True)
-    alt_ids               = models.CharField(max_length=250, default="")
-    recorded_from_year    = models.IntegerField(default=0)
-    recorded_to_year      = models.IntegerField(default=0)
-    recording_context     = WeakForeignKey('RecordingContext', related_name="collections", null=True)
-    approx_duration       = DurationField(default='00:00')
-    doctype_code          = models.IntegerField(default=0)
-    travail               = models.CharField(max_length=250, default="")
-    state                 = models.TextField(default="")
-    cnrs_contributor      = models.CharField(max_length=250, default="")
-    items_done            = models.CharField(max_length=250, default="")
-    a_informer_07_03      = models.CharField(max_length=250, default="")
-    ad_conversion         = WeakForeignKey('AdConversion', related_name='collections', null=True)
-    public_access         = models.CharField(choices=PUBLIC_ACCESS_CHOICES, max_length=16, default="metadata")
+    reference             = CharField(unique=True, null=True)
+    physical_format       = WeakForeignKey('PhysicalFormat', related_name="collections")
+    old_code              = CharField(unique=True, null=True)
+    code                  = CharField(unique=True, required=True)
+    title                 = CharField(required=True)
+    alt_title             = CharField()
+    physical_items_num    = IntegerField(default=0)
+    publishing_status     = WeakForeignKey('PublishingStatus', related_name="collections")
+    creator               = CharField()
+    booklet_author        = CharField()
+    booklet_description   = TextField()
+    collector             = CharField()
+    collector_is_creator  = BooleanField()
+    publisher             = WeakForeignKey('Publisher', related_name="collections")     
+    is_published          = BooleanField()
+    year_published        = IntegerField()
+    publisher_collection  = WeakForeignKey('PublisherCollection', related_name="collections")
+    publisher_serial      = CharField()
+    external_references   = TextField()
+    acquisition_mode      = WeakForeignKey('AcquisitionMode', related_name="collections")
+    comment               = TextField()
+    metadata_author       = WeakForeignKey('MetadataAuthor', related_name="collections")
+    metadata_writer       = WeakForeignKey('MetadataWriter', related_name="collections")
+    legal_rights          = WeakForeignKey('LegalRight', related_name="collections")
+    alt_ids               = CharField()
+    recorded_from_year    = IntegerField()
+    recorded_to_year      = IntegerField()
+    recording_context     = WeakForeignKey('RecordingContext', related_name="collections")
+    approx_duration       = DurationField()
+    doctype_code          = IntegerField()
+    travail               = CharField()
+    state                 = TextField()
+    cnrs_contributor      = CharField()
+    items_done            = CharField()
+    a_informer_07_03      = CharField()
+    ad_conversion         = WeakForeignKey('AdConversion', related_name='collections')
+    public_access         = CharField(choices=PUBLIC_ACCESS_CHOICES, max_length=16, default="metadata")
 
     objects               = query.MediaCollectionManager()
@@ -252 +251 @@
     code_regex              = '(?:%s|%s)' % (published_code_regex, unpublished_code_regex)
 
-    collection            = models.ForeignKey('MediaCollection', related_name="items")
-    track                 = models.CharField(max_length=250, default="")
-    old_code              = models.CharField(unique=True, max_length=250, null=True)
-    code                  = models.CharField(unique=True, max_length=250, null=True)
-    approx_duration       = DurationField(default='00:00')
-    recorded_from_date    = models.DateField(default=0)
-    recorded_to_date      = models.DateField(default=0)
+    collection            = ForeignKey('MediaCollection', related_name="items")
+    track                 = CharField()
+    old_code              = CharField(unique=True, null=True)
+    code                  = CharField(unique=True, null=True)
+    approx_duration       = DurationField()
+    recorded_from_date    = DateField()
+    recorded_to_date      = DateField()
     location              = WeakForeignKey('Location', related_name="items",
-                                           db_column='location_name', null=True)
-    location_comment      = models.CharField(max_length=250, default="")
-    ethnic_group          = WeakForeignKey('EthnicGroup', related_name="items", null=True)
-    title                 = models.CharField(max_length=250)
-    alt_title             = models.CharField(max_length=250, default="")
-    author                = models.CharField(max_length=250, default="")
-    vernacular_style      = WeakForeignKey('VernacularStyle', related_name="items",
-                                              null=True)
-    context_comment       = models.TextField(default="")
-    external_references   = models.TextField(default="")
-    moda_execut           = models.CharField(max_length=250, default="")
-    copied_from_item      = WeakForeignKey('self', related_name="copies", null=True)
-    collector             = models.CharField(max_length=250, default="")
-    cultural_area         = models.CharField(max_length=250, default="")
-    generic_style         = WeakForeignKey('GenericStyle', related_name="items",
-                                              null=True)
-    collector_selection   = models.CharField(max_length=250, default="")
-    creator_reference     = models.CharField(max_length=250, default="")
-    comment               = models.TextField(default="")
-    file                  = models.FileField(upload_to='items/%Y/%m/%d', db_column="filename", default='')
-    public_access         = models.CharField(choices=PUBLIC_ACCESS_CHOICES, 
-                                             max_length=16, default="metadata")
+                                           db_column='location_name')
+    location_comment      = CharField()
+    ethnic_group          = WeakForeignKey('EthnicGroup', related_name="items")
+    title                 = CharField(required=True)
+    alt_title             = CharField()
+    author                = CharField()
+    vernacular_style      = WeakForeignKey('VernacularStyle', related_name="items")
+    context_comment       = TextField()
+    external_references   = TextField()
+    moda_execut           = CharField()
+    copied_from_item      = WeakForeignKey('self', related_name="copies")
+    collector             = CharField()
+    cultural_area         = CharField()
+    generic_style         = WeakForeignKey('GenericStyle', related_name="items")
+    collector_selection   = CharField()
+    creator_reference     = CharField()
+    comment               = TextField()
+    file                  = FileField(upload_to='items/%Y/%m/%d', db_column="filename")
+    public_access         = CharField(choices=PUBLIC_ACCESS_CHOICES, max_length=16, default="metadata")
 
     objects               = query.MediaItemManager()
@@ -344 +340 @@
     "Describe an item part"
     element_type = 'part'
-    item  = models.ForeignKey('MediaItem', related_name="parts")
-    title = models.CharField(max_length=250)
-    start = models.FloatField()
-    end   = models.FloatField()
+    item  = ForeignKey('MediaItem', related_name="parts")
+    title = CharField(required=True)
+    start = FloatField(required=True)
+    end   = FloatField(required=True)
     
     class Meta(MetaCore):
@@ -357 +353 @@
 class Enumeration(ModelCore):
     "Abstract enumerations base class"
-    value = models.CharField(max_length=250, unique=True)
+    value = CharField(required=True, unique=True)
     
     def __unicode__(self):
@@ -427 +423 @@
 class Instrument(ModelCore):
     "Instrument used in the item"
-    name    = models.CharField(max_length=250)
+    name    = CharField(required=True)
 
     class Meta(MetaCore):
@@ -437 +433 @@
 class InstrumentAlias(ModelCore):
     "Instrument other name"
-    name = models.CharField(max_length=250)
+    name = CharField(required=True)
 
     class Meta(MetaCore):
@@ -447 +443 @@
 class InstrumentRelation(ModelCore):
     "Instrument family"
-    instrument        = models.ForeignKey('Instrument', related_name="parent_relation")
-    parent_instrument = models.ForeignKey('Instrument', related_name="child_relation")
+    instrument        = ForeignKey('Instrument', related_name="parent_relation")
+    parent_instrument = ForeignKey('Instrument', related_name="child_relation")
 
     class Meta(MetaCore):
@@ -456 +452 @@
 class InstrumentAliasRelation(ModelCore):
     "Instrument family other name"
-    alias      = models.ForeignKey('InstrumentAlias', related_name="other_name")
-    instrument = models.ForeignKey('InstrumentAlias', related_name="relation")
+    alias      = ForeignKey('InstrumentAlias', related_name="other_name")
+    instrument = ForeignKey('InstrumentAlias', related_name="relation")
 
     class Meta(MetaCore):
@@ -465 +461 @@
 class MediaItemPerformance(ModelCore):
     "Item performance"
-    media_item      = models.ForeignKey('MediaItem', related_name="performances")
-    instrument      = WeakForeignKey('Instrument', related_name="performances", null=True)
-    alias           = WeakForeignKey('InstrumentAlias', related_name="performances", null=True)
-    instruments_num = models.CharField(max_length=250, default="")
-    musicians       = models.CharField(max_length=250, default="")
+    media_item      = ForeignKey('MediaItem', related_name="performances")
+    instrument      = WeakForeignKey('Instrument', related_name="performances")
+    alias           = WeakForeignKey('InstrumentAlias', related_name="performances")
+    instruments_num = CharField()
+    musicians       = CharField()
 
     class Meta(MetaCore):
@@ -478 +474 @@
     LEVEL_CHOICES = (('user', 'user'), ('maintainer', 'maintainer'), ('admin', 'admin'))    
 
-    username   = models.CharField(primary_key=True, max_length=64)
-    level      = models.CharField(choices=LEVEL_CHOICES, max_length=250)
-    first_name = models.CharField(max_length=250, default="")
-    last_name  = models.CharField(max_length=250, default="")
-    phone      = models.CharField(max_length=250, default="")
-    email      = models.CharField(max_length=250, default="")
+    username   = CharField(primary_key=True, max_length=64, required=True)
+    level      = CharField(choices=LEVEL_CHOICES, max_length=32, required=True)
+    first_name = CharField()
+    last_name  = CharField()
+    phone      = CharField()
+    email      = CharField()
 
     class Meta(MetaCore):
@@ -493 +489 @@
 class Playlist(ModelCore):
     "Item or collection playlist"
-    owner_username = models.ForeignKey('User', related_name="playlists", db_column="owner_username") 
-    name           = models.CharField(max_length=250)
+    owner_username = ForeignKey('User', related_name="playlists", db_column="owner_username") 
+    name           = CharField(required=True)
 
     class Meta(MetaCore):
@@ -506 +502 @@
     RESOURCE_TYPE_CHOICES = (('item', 'item'), ('collection', 'collection'))
 
-    playlist              = models.ForeignKey('Playlist', related_name="resources")
-    resource_type         = models.CharField(choices=RESOURCE_TYPE_CHOICES, max_length=250)
-    resource              = models.IntegerField()
+    playlist              = ForeignKey('Playlist', related_name="resources")
+    resource_type         = CharField(choices=RESOURCE_TYPE_CHOICES, required=True)
+    resource              = IntegerField(required=True)
 
     class Meta(MetaCore):
@@ -517 +513 @@
     TYPE_CHOICES     = (('country', 'country'), ('continent', 'continent'), ('other', 'other'))
 
-    name             = models.CharField(primary_key=True, max_length=150)
-    type             = models.CharField(choices=TYPE_CHOICES, max_length=16)
-    complete_type    = models.ForeignKey('LocationType', related_name="types")
+    name             = CharField(primary_key=True, max_length=150, required=True)
+    type             = CharField(choices=TYPE_CHOICES, max_length=16, required=True)
+    complete_type    = ForeignKey('LocationType', related_name="types")
     current_name     = WeakForeignKey('self', related_name="past_names", 
-                                      db_column="current_name", null=True) 
-    is_authoritative = models.BooleanField(default=0)
+                                      db_column="current_name") 
+    is_authoritative = BooleanField()
 
     def parent(self):
@@ -564 +560 @@
 class LocationType(ModelCore):
     "Location type of an item location"
-    id   = models.CharField(max_length=64, primary_key=True)
-    name = models.CharField(max_length=150)
+    id   = CharField(max_length=64, primary_key=True, required=True)
+    name = CharField(max_length=150, required=True)
 
     class Meta(MetaCore):
@@ -572 +568 @@
 class LocationAlias(ModelCore):
     "Location other name"
-    location         = models.ForeignKey('Location', related_name="aliases",
+    location         = ForeignKey('Location', related_name="aliases",
                                           db_column="location_name", max_length=150)
-    alias            = models.CharField(max_length=150)
-    is_authoritative = models.BooleanField(default=0)
+    alias            = CharField(max_length=150, required=True)
+    is_authoritative = BooleanField()
 
     def __unicode__(self):
@@ -586 +582 @@
 class LocationRelation(ModelCore):
     "Location family"
-    location             = models.ForeignKey('Location', related_name="parent_relations",
+    location             = ForeignKey('Location', related_name="parent_relations",
                                               db_column="location_name", max_length=150)
-    parent_location      = models.ForeignKey('Location', related_name="child_relations",
+    parent_location      = ForeignKey('Location', related_name="child_relations",
                                               db_column="parent_location_name", null=True, max_length=150)
-    is_authoritative     = models.BooleanField()
+    is_authoritative     = BooleanField()
 
     class Meta(MetaCore):
@@ -603 +599 @@
 class MediaItemKeyword(ModelCore):
     "Item keyword"
-    item    = models.ForeignKey('MediaItem')
-    keyword = models.ForeignKey('ContextKeyword')
+    item    = ForeignKey('MediaItem')
+    keyword = ForeignKey('ContextKeyword')
 
     class Meta(MetaCore):
@@ -618 +614 @@
 class PublisherCollection(ModelCore):
     "Collection which belongs to publisher"
-    publisher = models.ForeignKey('Publisher', related_name="publisher_collections")
-    value     = models.CharField(max_length=250)
+    publisher = ForeignKey('Publisher', related_name="publisher_collections")
+    value     = CharField(required=True)
 
     def __unicode__(self):
@@ -632 +628 @@
     CHANGE_TYPE_CHOICES  = (('import', 'import'), ('create', 'create'), ('update', 'update'), ('delete','delete'))
 
-    element_type         = models.CharField(choices=ELEMENT_TYPE_CHOICES, max_length=16)
-    element_id           = models.IntegerField()
-    change_type          = models.CharField(choices=CHANGE_TYPE_CHOICES, max_length=16)
-    time                 = models.DateTimeField(auto_now_add=True)
-    user                 = models.ForeignKey('User', db_column='username', related_name="revisions")
+    element_type         = CharField(choices=ELEMENT_TYPE_CHOICES, max_length=16, required=True)
+    element_id           = IntegerField(required=True)
+    change_type          = CharField(choices=CHANGE_TYPE_CHOICES, max_length=16, required=True)
+    time                 = DateTimeField(auto_now_add=True)
+    user                 = ForeignKey('User', db_column='username', related_name="revisions")
     
     @classmethod
@@ -659 +655 @@
 class EthnicGroup(ModelCore):
     "Item ethnic group"
-    name = models.CharField(max_length=250)
+    name = CharField(required=True)
 
     class Meta(MetaCore):
@@ -669 +665 @@
 class EthnicGroupAlias(ModelCore):
     "Item ethnic group other name" 
-    ethnic_group = models.ForeignKey('EthnicGroup', related_name="aliases")
-    name         = models.CharField(max_length=250)
+    ethnic_group = ForeignKey('EthnicGroup', related_name="aliases")
+    name         = CharField(required=True)
 
     class Meta(MetaCore):