Changeset 51

Timestamp:

11/01/06 21:38:57 (2 years ago)

Author:

verbosus

Message:

Modelviz 0.6: introduced colours, switched to Django templates for DOT generation, switched to DOT HTML-like tables for graph layout

Files:

• django/trunk/utils/modelviz.py (modified) (7 diffs)

django/trunk/utils/modelviz.py

@@ -1 @@
-#!/usr/bin/python
+#!/usr/bin/env python
 """Django model to DOT (Graphviz) converter
 by Antonio Cavedoni <antonio@cavedoni.org>
@@ -6 +6 @@
 the script like this:
 
-  $ python modelviz.py <app_label> > <filename>.dot
-
-Changelog
-
-0.5.1
-Got rid of print statements, now the generate_dot() function returns
-a string with the file contents
-
-0.5
-Cleaned up code, now the relationship arrows start from the 
-correct model attribute position
-
-0.4
-Fixed OneToOneField support (thanks, limodou)
-
-0.3
-Added support for GenericRelation and OneToOneField
-
-0.2
-Changed display (shape="record", thanks Malcolm Tredinnick), 
-fixed arrow direction, added display of model attributes 
-(thanks, Russell Keith-Magee)
-
-0.1
-First release.
+$ python modelviz.py <app_label> > <filename>.dot
 """
 
-__version__ = "0.5.1"
+__version__ = "0.6"
 __svnid__ = "$Id$"
 __license__ = "Python"
@@ -39 +15 @@
 __contributors__ = [
    "Stefano J. Attardi <http://attardi.org/>",
-   "limodou <http://www.donews.net/limodou/>"
+   "limodou <http://www.donews.net/limodou/>",
+   "Carlo C8E Miron"
    ]
 
@@ -47 +24 @@
     ForeignKey, OneToOneField, ManyToManyField
 from django.db.models.fields.generic import GenericRelation
+from django.template import Template, Context
 
-def generate_dot(app_label):
-   app = models.get_app(app_label)
+dot_template = """
+digraph {{ name }} {
+  fontname = "Helvetica"
+  fontsize = 8
 
-   graph = []
-   graph.append("digraph %s {" % ('"' + app.__name__ + '"'))
-   graph.append("""  fontname = "Helvetica"
-  fontsize = 8
-      
   node [
     fontname = "Helvetica"
     fontsize = 8
-    shape = "record"
+    shape = "plaintext"
   ]
    edge [
@@ -65 +40 @@
     fontsize = 8
   ]
-""")
-   for o in get_models(app):
-      graph.append(""" subgraph cluster_%(model)s {
-  shape = "record";
-  label = "%(model)s";
-  fontname = "Helvetica Bold";
-  fontsize = 10;
-  labelfontcolor = "black";
-  %(model)s [label = "{""" % {'model': o.__name__})
+
+  {% for model in models %}
+  {{ model.name }} [label=<
+    <TABLE BGCOLOR="palegoldenrod" BORDER="0" CELLBORDER="0" CELLSPACING="0">
+     <TR><TD COLSPAN="2" CELLPADDING="4" ALIGN="CENTER" BGCOLOR="olivedrab4"
+     ><FONT FACE="Helvetica Bold" COLOR="white"
+     >{{ model.name }}</FONT></TD></TR>
+     {% for field in model.fields %}
+     <TR><TD ALIGN="LEFT" BORDER="0"
+     ><FONT FACE="Helvetica Bold">{{ field.name }}</FONT
+     ></TD>
+     <TD ALIGN="LEFT">{{ field.type }}</TD></TR>
+     {% endfor %}
+    </TABLE>
+    >]
+   
+  {% for relation in model.relations %}
+  {{ model.name }} -> {{ relation.target }} 
+    [label="{{ relation.type }}"] {{ relation.arrows }};
+  {% endfor %}
+  {% endfor %}
+}
+"""
+
+def generate_dot(app_label):
+   app = models.get_app(app_label)
+   graph = Context({
+      'name': '"%s"' % app.__name__, 
+      'models': []
+      })
+
+   for appmodel in get_models(app):
+      model = {
+         'name': appmodel.__name__,
+         'fields': [],
+         'relations': []
+         }
 
       # model attributes
       def add_attributes():
-         graph.append("<%(model)s_%(field)s>%(field)s : %(related)s|" % \
-                      {'model': o.__name__, 'field': field.name, 
-                       'related': type(field).__name__})
+         model['fields'].append({
+               'name': field.name,
+               'type': type(field).__name__
+               })
 
-      for field in o._meta.fields:
+      for field in appmodel._meta.fields:
          add_attributes()
          
-      if o._meta.many_to_many:
-         for field in o._meta.many_to_many:
+      if appmodel._meta.many_to_many:
+         for field in appmodel._meta.many_to_many:
             add_attributes()
 
-      graph.append(""" }"] [color="white" shape="record"];\n }\n""")
+      # relations
+      def add_relation(extras=""):
+         _rel = {
+            'target': field.rel.to.__name__,
+            'type': type(field).__name__,
+            'arrows': extras
+            }
+         if _rel not in model['relations']:
+            model['relations'].append(_rel)
 
-      # relations
-      rel = []
-      def add_relation(extras=""):
-         _rel = """ %(model)s:%(model)s_%(field)s -> %(related)s 
-         [label="%(relationship)s"] %(extras)s;\n""" % {
-            'model': o.__name__, 'field': field.name, 
-            'related': field.rel.to.__name__, 
-            'relationship': type(field).__name__,
-            'extras': extras}
-         if _rel not in rel:
-            rel.append(_rel)
-
-      for field in o._meta.fields:
+      for field in appmodel._meta.fields:
          if isinstance(field, ForeignKey):
             add_relation()
@@ -108 +108 @@
             add_relation("[arrowhead=none arrowtail=none]")
 
-      if o._meta.many_to_many:
-         for field in o._meta.many_to_many:
+      if appmodel._meta.many_to_many:
+         for field in appmodel._meta.many_to_many:
             if isinstance(field, ManyToManyField):
                add_relation("[arrowhead=normal arrowtail=normal]")
@@ -115 +115 @@
                add_relation(
                   '[style="dotted"] [arrowhead=normal arrowtail=normal]')
-      graph.append("".join(rel))
-
-   graph.append('}')
-   return "".join(graph)
+      graph['models'].append(model)
+   
+   t = Template(dot_template)
+   return t.render(graph)
 
 if __name__ == "__main__":
    import sys
-   app_label = sys.argv[1]
-   print generate_dot(app_label)
+   try:
+      app_label = sys.argv[1]
+      print generate_dot(app_label)
+   except IndexError:
+      print __doc__