Upgrade the EmClass.check() method making it detect inconsistency between EmClass fields and common_fields defines in EditorialModel.classtypes

Note : the check method does not correct the EmFields only displays a warning

EditorialModel/classes.py

@@ -5,6 +5,10 @@
 
 import copy
 
+# imports used in classtypes <-> actual model checks
+import difflib
+import warnings
+
 import EditorialModel
 from EditorialModel.components import EmComponent
 from EditorialModel.classtypes import EmClassType
@@ -31,10 +35,42 @@ class EmClass(EmComponent):
         self.sortcolumn = sortcolumn  # 'rank'
         super(EmClass, self).__init__(model=model, uid=uid, name=name, string=string, help_text=help_text, date_update=date_update, date_create=date_create, rank=rank)
 
-    ## Check if the EmComponent is valid
-    # @note this function add default and common fields to the EmClass if they are not yet created
+    ## @brief Check if the EmComponent is valid
+    # 
+    # This function add default and common fields to the EmClass if they are not yet created (and raises warning if existing common fields are outdated given the one describe in EditorialModel.classtypes
     # @throw EmComponentCheckError if fails
+    # 
+    # @warning If default parameters of EmField constructor changes this method can be broken
     def check(self):
+        # Checks that this class is up to date given the common_fields described in EditorialModel.classtypes
+        # if not just print a warning, don't raise an Exception
+        for field in self.fields():
+            if field.name in EditorialModel.classtypes.common_fields:
+                # Building fieltypes options to match the ones stored in EditorialModel.classtypes
+                ftype_opts = field.fieldtype_options()
+                ftype_opts['fieldtype'] = field.fieldtype
+
+                ctype_opts = EditorialModel.classtypes.common_fields[field.name]
+                #Adding default value for options nullable, uniq and internal to fieldtypes options stored in classtypes
+                defaults = { 'nullable': False, 'uniq': False, 'internal': False}
+                for opt_name, opt_val in defaults.items():
+                    if opt_name not in ctype_opts:
+                        ctype_opts[opt_name] = opt_val
+
+                if ftype_opts != ctype_opts:
+                    # If options mismatch produce a diff and display a warning
+                    ctype_opts = [ "%s: %s\n"%(repr(k), repr(ctype_opts[k])) for k in sorted(ctype_opts.keys())]
+                    ftype_opts = [ "%s: %s\n"%(repr(k), repr(ftype_opts[k])) for k in sorted(ftype_opts.keys())]
+
+                    diff_list = difflib.unified_diff(
+                        ctype_opts,
+                        ftype_opts, 
+                        fromfile="Classtypes.%s" % field.name,
+                        tofile="CurrentModel_%s.%s" % (self.name, field.name)
+                    )
+                    diff = ''.join(diff_list)
+                    warnings.warn("LOADED MODEL IS OUTDATED !!! The common_fields defined in classtypes differs from the fields in this model.\nHere is a diff : \n%s" % diff)
+            
         for fname in self.default_fields_list().keys():
             if fname not in [f.name for f in self.fields()]:
                 self.model.add_default_class_fields(self.uid)

EditorialModel/classtypes.py

@@ -9,15 +9,18 @@ common_fields = {
     'class_id': {
         'fieldtype': 'emuid',
         'is_id_class': True,
+        'internal': 'automatic',
     },
     'type_id': {
         'fieldtype': 'emuid',
         'is_id_class': False,
+        'internal': 'automatic',
     },
     'string': {
         'fieldtype': 'char',
         'max_length': 128,
         'internal': 'automatic',
+        'nullable': True,
     },
     'creation_date': {
         'fieldtype': 'datetime',

EditorialModel/fields.py

@@ -1,5 +1,6 @@
 #-*- coding: utf-8 -*-
 
+import copy
 import importlib
 import warnings
 
@@ -87,6 +88,11 @@ class EmField(EmComponent):
     @property
     def em_class(self):
         return self.model.component(self.class_id)
+    
+    ## @brief Getter for private property EmField._fieldtype_args
+    # @return A copy of private dict _fieldtype_args
+    def fieldtype_options(self):
+        return copy.copy(self._fieldtype_args)
 
     ## @brief Get the fieldtype instance
     # @return a fieldtype instance