Merge lp:~openerp-groupes/openobject-addons/base_module_doc_rst_improvements into lp:openobject-addons

[Olivier Ligot]

This branch improves the module base_module_doc_rst by adding 3 news fields on ir.module.module:
- level: number of times a model is processed when it is in relation with another model
- filter_model_ids: filter the models taken into account to generate the relationship graph
- dot_graph: save the generated graph as a DOT file

[Fabien (Open ERP) (fp-tinyerp)]

seems good

[Julien Thewys (julien-thewys)]

Looks like this has actually never been merged.
Could you make it so?

Unmerged revisions

4152. By Olivier Ligot on 2010-10-04

[ADD] dot_graph field on ir.module.module object

This new field allows to save the generated graph as a DOT file

4151. By Olivier Ligot on 2010-10-04

[FIX] same variable name (id)

4150. By Olivier Ligot on 2010-10-04

[ADD] filter_model_ids field on ir.module.module object

This new field allows to filter the models taken into account to generate the relationship graph

4149. By Olivier Ligot on 2010-10-04

[ADD] level field on ir.module.module object

This new field allows to specify the number of times a model is processed when it is in relation with another model.

4148. By Olivier Ligot on 2010-10-04

[REM] Useless code

4147. By Olivier Ligot on 2010-10-01

[FIX] DOT file label

4146. By Xavier (Open ERP) on 2010-09-30

[FIX] account_voucher: fix sales_reicept tests to assert on the status of 'reconciled' rather than print random stuff to stdout

4145. By Launchpad Translations on behalf of openerp on 2010-09-30

Launchpad automatic translations update.

4144. By Borja (Pexego) on 2010-09-29

[FIX] Merged Borja's branch for correction on Invoice correctd workflow action of sale order

4143. By Harry (OpenERP) on 2010-09-29

[FIX] stock_planning, hr_attendance: resolve regression after rev:4139

=== modified file 'base_module_doc_rst/base_module_doc_rst.py'
--- base_module_doc_rst/base_module_doc_rst.py	2010-08-19 11:51:57 +0000
+++ base_module_doc_rst/base_module_doc_rst.py	2010-10-05 07:51:48 +0000
@@ -32,21 +32,32 @@
     _description = 'Module With Relationship Graph'
     _columns = {
         'file_graph': fields.binary('Relationship Graph'),
+        'level': fields.integer('Level', help="""Number of times a model is processed
+when it is in relation with another model."""),
+        'filter_model_ids': fields.many2many('ir.model', 'module_filter_model_rel', 'module_id', 'model_id', 'Filter models'),
+        'dot_graph': fields.binary('Graph (DOT file)'),
             }
 
-    def _get_graphical_representation(self, cr, uid, model_ids, level=1, context={}):
+    _defaults = {
+        'level': 1
+    }
+
+    def _get_graphical_representation(self, cr, uid, module_id, model_ids, level=1, context={}):
         obj_model = self.pool.get('ir.model')
         if level == 0:
             return tuple()
         relation = []
+        module = self.browse(cr, uid, module_id, context=context)
+        filter_models = [model.model for model in module.filter_model_ids]
         for id in model_ids:
             model_data = obj_model.browse(cr, uid, id, context=context)
             for field in (f for f in model_data.field_id if f.ttype in ('many2many', 'many2one', 'one2many')):
-                relation.append((model_data.model, field.name, field.ttype, field.relation, field.field_description))
-                new_model_ids = obj_model.search(cr, uid, [('model', '=', field.relation)], context=context)
-                if new_model_ids:
-                    model = obj_model.read(cr, uid, new_model_ids, ['id', 'name'], context=context)[0]
-                    relation.extend(self._get_graphical_representation(cr, uid, model['id'], level - 1))
+                if not filter_models or field.relation in filter_models:
+                    relation.append((model_data.model, field.name, field.ttype, field.relation, field.field_description))
+                    new_model_ids = obj_model.search(cr, uid, [('model', '=', field.relation)], context=context)
+                    if new_model_ids:
+                        model = obj_model.read(cr, uid, new_model_ids, ['id', 'name'], context=context)[0]
+                        relation.extend(self._get_graphical_representation(cr, uid, module_id, [model['id']], level - 1))
         return tuple(relation)
 
     def _get_structure(self, relations, main_element):
@@ -70,7 +81,7 @@
             'one2many': 'arrowtail="none" arrowhead="crow" color="blue" label="o2m"',
         }[field_type]
 
-    def get_graphical_representation(self, cr, uid, model_ids, context=None):
+    def get_graphical_representation(self, cr, uid, id, model_ids, context=None):
         obj_model = self.pool.get('ir.model')
         if context is None:
             context = {}
@@ -78,7 +89,7 @@
         models = []
         for obj in obj_model.browse(cr, uid, model_ids, context=context):
             models.append(obj.model)
-        relations = set(self._get_graphical_representation(cr, uid, model_ids, context.get('level', 1)))
+        relations = set(self._get_graphical_representation(cr, uid, id, model_ids, context.get('level', 1)))
         res[obj.model] = "digraph G {\nnode [style=rounded, shape=record];\n%s\n%s }" % (
                 self._get_structure(relations, models),
                 ''.join('"%s":%s -> "%s":id:n [%s]; // %s\n' % (m, fn, fr, self._get_arrow(ft),ft) for m, fn, ft, fr, fl in relations),
@@ -86,23 +97,28 @@
         return res
 
     def _get_module_objects(self, cr, uid, module, context={}):
-        obj_model = self.pool.get('ir.model')
         obj_mod_data = self.pool.get('ir.model.data')
-        obj_ids = []
         model_data_ids = obj_mod_data.search(cr, uid, [('module', '=', module), ('model', '=', 'ir.model')], context=context)
         model_ids = []
+        module_id = self.search(cr, uid, [('name', '=', module)])[0]
+        module = self.browse(cr, uid, module_id, context=context)
+        filter_model_ids = [model.id for model in module.filter_model_ids]
         for mod in obj_mod_data.browse(cr, uid, model_data_ids, context=context):
-            model_ids.append(mod.res_id)
-        models = obj_model.browse(cr, uid, model_ids, context=context)
-        map(lambda x: obj_ids.append(x.id),models)
-        return obj_ids
+            if not filter_model_ids or mod.res_id in filter_model_ids:
+                model_ids.append(mod.res_id)
+        return model_ids
 
     def get_relation_graph(self, cr, uid, module_name, context=None):
+        if context is None:
+            context = {}
+        result = {}
         object_ids = self._get_module_objects(cr, uid, module_name, context=context)
         if not object_ids:
-            return {'module_file': False}
-        context.update({'level': 1})
-        dots = self.get_graphical_representation(cr, uid, object_ids, context=context)
+            return False
+        module_id = self.search(cr, uid, [('name', '=', module_name)])[0]
+        module = self.browse(cr, uid, module_id)
+        context.update({'level': module.level})
+        dots = self.get_graphical_representation(cr, uid, module_id, object_ids, context=context)
         # todo: use os.realpath
         file_path = tools.config['addons_path']+"/base_module_doc_rst/"
         path_png = file_path + "/module.png"
@@ -111,12 +127,17 @@
            fp = file(path_dotfile, "w")
            fp.write(val)
            fp.close()
+        fp = file(path_dotfile, "r")
+        x = fp.read()
+        fp.close()
+        result['dot_graph'] = base64.encodestring(x)
         os.popen('dot -Tpng' +' '+ path_dotfile + ' '+ '-o' +' ' + path_png)
         fp = file(path_png, "r")
         x = fp.read()
         fp.close()
         os.popen('rm ' + path_dotfile + ' ' + path_png)
-        return {'module_file': base64.encodestring(x)}
+        result['file_graph'] = base64.encodestring(x)
+        return result
 
 module()
 
 
=== modified file 'base_module_doc_rst/base_module_doc_rst_view.xml'
--- base_module_doc_rst/base_module_doc_rst_view.xml	2010-05-19 15:57:31 +0000
+++ base_module_doc_rst/base_module_doc_rst_view.xml	2010-10-05 07:51:48 +0000
@@ -14,8 +14,12 @@
 			<field name="arch" type="xml">
 				<notebook position="inside">
 					<page string="Relationship Graph">
+						<separator colspan="4" string="You can filter the models taken into account to generate the graph"/>
+						<field name="filter_model_ids" colspan="4" nolabel="1"/>
+						<field name="level"/>
 						<separator colspan="4" string="You can save this image as .png file"/>
 						<field name="file_graph" widget="image" nolabel="1" />
+						<field name="dot_graph"/>
 					</page>
 				</notebook>
 			</field>
 
=== modified file 'base_module_doc_rst/report/report_proximity_graph.py'
--- base_module_doc_rst/report/report_proximity_graph.py	2010-08-19 11:51:57 +0000
+++ base_module_doc_rst/report/report_proximity_graph.py	2010-10-05 07:51:48 +0000
@@ -48,7 +48,7 @@
                     if id:
                         get_dpend_module(id[0].id)
         get_dpend_module(module_id)
-        graph = pydot.Dot(graph_type='digraph',fontsize='10', label="\\nProximity Graph. \\n\\nGray Color:Official Modules, Red  Color:Extra Addons Modules, Blue Color:Community Modules, Purple Color:Unknow Modules"
+        graph = pydot.Dot(graph_type='digraph',fontsize='10', label='"\\nProximity Graph. \\n\\nGray Color:Official Modules, Red  Color:Extra Addons Modules, Blue Color:Community Modules, Purple Color:Unknow Modules"'
                                      , center='1')
         for node in nodes:
             if node[1] == "official":
 
=== modified file 'base_module_doc_rst/wizard/generate_relation_graph.py'
--- base_module_doc_rst/wizard/generate_relation_graph.py	2010-05-19 15:57:31 +0000
+++ base_module_doc_rst/wizard/generate_relation_graph.py	2010-10-05 07:51:48 +0000
@@ -33,8 +33,8 @@
     modules = mod_obj.browse(cr, uid, datas['ids'], context=context)
     for module in modules:
         module_data = mod_obj.get_relation_graph(cr, uid, module.name, context=context)
-        if module_data['module_file']:
-            mod_obj.write(cr, uid, [module.id], {'file_graph': module_data['module_file']}, context=context)
+        if module_data:
+            mod_obj.write(cr, uid, [module.id], module_data, context=context)
     return {}
 
 class create_graph(wizard.interface):