EM: on avance…

em/class.py

@@ -1,41 +1,52 @@
 # -*- coding: utf-8 -*-
 
-## Manipulate Classes of the Editorial Model
-#
-# Create classes of object
-# @see EmClass, EmType, EmFieldGroup, EmField
+""" Manipulate Classes of the Editorial Model
+    Create classes of object
+    @see EmClass, EmType, EmFieldGroup, EmField
+"""
 
-import EmComponent
+from component import EmComponent
 
 class EmClass(EmComponent)
     def __init(id_or_name):
         self.table = 'em_class'
         pass
 
-    ## create a new class
-    # @param str         name       name of the new class
-    # @param EmClasstype class_type type of the class
+    """ create a new class
+        @param name str: name of the new class
+        @param class_type EmClasstype: type of the class
+    """
+    @staticmethod
     def create(self, name, class_type):
        pass
 
-    ## retrieve list field_groups of this class
-    # @return [EmFieldGroup]
+    """ retrieve list of the field_groups of this class
+        @return field_groups [EmFieldGroup]:
+    """
     def field_groups():
        pass
 
+    """ retrieve list of fields
+        @return fields [EmField]:
+    """
     def fields():
        pass
 
+    """ retrieve list of type of this class
+        @return types [EmType]:
+    """
     def types():
         pass
 
-    ## add a new EmType that can ben linked to this class
-    # @param  EmType t       type to link
-    # @return bool   success
+    """ add a new EmType that can ben linked to this class
+        @param  t EmType: type to link
+        @return success bool: done or not
+    """
     def link_type(t <EmType>):
         pass
-    
-    ## retrieve list of EmType that are linked to this class
-    # @return [EmType]
+
+    """ retrieve list of EmType that are linked to this class
+        @return types [EmType]:
+    """
     def linked_types():
         pass

em/component.py

@@ -1,16 +1,21 @@
 # -*- coding: utf-8 -*-
 
-## Main object to manipulate Editorial Model
-#
-# parent of all other EM editing classes
-# @see EmClass, EmType, EmFieldGroup, EmField
+""" Main object to manipulate Editorial Model
+    parent of all other EM editing classes
+    @see EmClass, EmType, EmFieldGroup, EmField
+"""
+
+from ml_string import MlString
 
 class EmComponent(object):
 
-    ## instaciate an EmComponent
-    # @param int|str id_or_name 
-    # @raise TypeError
-    def __init(id_or_name):
+    """ instaciate an EmComponent
+        @param id_or_name int|str: name or id of the object
+        @exception TypeError
+    """
+    def __init__(self, id_or_name):
+        if self is EmComponent:
+            raise EnvironmentError('Abstract class')
         if id_or_name is int:
             self.id = id_or_name
         else if id_or_name is str:
@@ -19,56 +24,65 @@ class EmComponent(object):
         else:
             raise TypeError('Bad argument: expecting <int> or <str>')
 
-    ## Lookup in the database properties of the object
+    """ Lookup in the database properties of the object to populate the properties
+    """
     def populate(self):
         if self.id is None:
             where = "name = " + db.quote(self.name)
         else:
             where = "id = " + self.id
 
-        row = db.query(where)
+        row = db.query('*', self.table, where)
         if not row:
             # could have two possible Error message for id and for name
             raise EmComponentNotExistError("Bad id_or_name: could not find the component")
 
         self.name = row.name
-        self.rank = row.rank
+        self.rank = int(row.rank)
         self.date_update = row.date_update
         self.date_create = row.date_create
-        self.string <MlString object> : string representation of the component
-        self.help <MlString object> : help string
-        self.icon <string> : path to the icon (should be id_global of EmFile object)
+        self.string = MlString.from_json(row.string)
+        self.help = MlString.from_json(row.help)
+        self.icon = row.icon
+
+        return row
 
-    ## write the representation of the component in the database
-    # @return bool
+    """ write the representation of the component in the database
+        @return bool
+    """
     def save(self):
         pass
 
-    ## delete this component in the database
-    # @return bool
+    """ delete this component data in the database
+        @return bool
+    """
     def delete(self):
         pass
 
-    ## change the rank of the component
-    # @param int new_rank new position
+    """ change the rank of the component
+        @param int new_rank new position
+    """
     def modify_rank(self, new_rank):
         pass
 
-    ## set a string representation of the component for a given language
-    # @param  str lang iso 639-2 representation of the language http://en.wikipedia.org/wiki/List_of_ISO_639-2_codes
-    # @param  str text
-    # @return bool
+    """ set a string representation of the component for a given language
+        @param  lang str: iso 639-2 code of the language http://en.wikipedia.org/wiki/List_of_ISO_639-2_codes
+        @param  text str: text to set
+        @return bool
+    """
     def set_string(self, lang, text):
         pass
 
-    ## set the string representation of the component
-    # @param  MlString ml_string strings for all language
-    # @return bool
+    """ set the string representation of the component
+        @param  ml_string  MlString: strings for all language
+        @return bool
+    """
     def set_strings(self, ml_string):
         pass
 
-    ## get the string representation of the component for the given language
-    # @param  str lang iso 639-2 representation of the language
-    # @return str
+    """ get the string representation of the component for the given language
+        @param  lang   str: iso 639-2 code of the language
+        @return text   str: 
+    """
     def get_string(self, lang):
         pass

em/field.py

@@ -15,6 +15,7 @@ class EmField(EmComponent):
         super(EmField, self).__init__()
         pass
 
+    @staticmethod
     def create( name, em_fieldgroup, ml_repr = None, ml_help = None,
                 icon = None, optionnal = False, type_relation = None,
                 relationnal_field = None, primary_data = False,
@@ -22,7 +23,6 @@ class EmField(EmComponent):
         """ Create a new EmType and instanciate it
             
             @todo Change the icon param type
-            @todo change staticmethod to classmethod ?
             @todo simplify function aguments ?
             @todo typeof default_value argument ?
             @todo typeof params argument ?
@@ -40,9 +40,9 @@ class EmField(EmComponent):
             @param type_relation EmType|None: If not None make a link between the class of the new EmField and this EmType
             @param relationnal_field EmField|None: If not None indicates that the new field defines the relation created by this EmField argument
             @param primary_data bool: Is the new field a primary data field ?
-            @param The default_value: field's default value
-            @param Params params: of the field
-            @param Value value: of the field
+            @param default_value str: The field's default value
+            @param params str: Params of the field
+            @param value str: Value of the field
             
             @throw TypeError
             @see EmComponent::__init__()

em/fieldgroup.py

@@ -20,7 +20,7 @@ class EmFieldGroup(EmComponent):
         super(EmFieldGroup, self).__init__()
         pass
 
-
+    @staticmethod
     def create(name, em_class, ml_repr = None, ml_help = None, icon = None):
         """ Create a new EmType and instanciate it
             
@@ -35,7 +35,6 @@ class EmFieldGroup(EmComponent):
             @param The string|None: filename of the icon
             @return An EmFieldGroup instance
             @see EmComponent::__init__()
-            @staticmethod
         """
         pass