annotate scripts/schema_diagram.py @ 5132:0142b4fb5a2d

issue2550648 - partial fix for problem in this issue. Ezio Melotti reported that the expression editor allowed the user to generate an expression using retired values. To align the expression editor with the simple dropdown search item, retired values are now removed from the expression editor. Do we really want this though? Supposed a keyword is retired and I want to search for an issue with that retired keyword? Do we have a best policy document that says to remove retired keywords from all places it could possibly be used? It could be argued that the simple search dropdown is wrong and should allow selecting retired values.
author John Rouillard <rouilj@ieee.org>
date Fri, 08 Jul 2016 19:31:02 -0400
parents d56b7fc64923
children 64b05e24dbd8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1166
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
1 #! /usr/bin/python
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
2 #
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
3 # Schema diagram generator contributed by Stefan Seefeld of the fresco
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
4 # project http://www.fresco.org/.
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
5 #
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6 # It generates a 'dot file' that is then fed into the 'dot'
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 # tool (http://www.graphviz.org) to generate a graph:
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 #
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9 # %> ./schema.py
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10 # %> dot -Tps schema.dot -o schema.ps
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11 # %> gv schema.ps
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12 #
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
13 import sys
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14 import roundup.instance
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
15
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
16 # open the instance
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17 instance = roundup.instance.open(sys.argv[1])
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18 db = instance.open()
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20 # diagram preamble
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21 print 'digraph schema {'
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
22 print 'size="8,6"'
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
23 print 'node [shape="record" bgcolor="#ffe4c4" style=filled]'
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
24 print 'edge [taillabel="1" headlabel="1" dir=back arrowtail=ediamond]'
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
25
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26 # get all the classes
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27 types = db.classes.keys()
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
28
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29 # one record node per class
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30 for i in range(len(types)):
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
31 print 'node%d [label=\"{%s|}"]'%(i, types[i])
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
32
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
33 # now draw in the relations
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
34 for name in db.classes.keys():
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
35 type = db.classes[name]
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36 attributes = type.getprops()
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
37 for a in attributes.keys():
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
38 attribute = attributes[a]
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39 if isinstance(attribute, roundup.hyperdb.Link):
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
40 print 'node%d -> node%d [label=%s]'%(types.index(name),
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
41 types.index(attribute.classname),
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42 a)
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
43 elif isinstance(attribute, roundup.hyperdb.Multilink):
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44 print 'node%d -> node%d [taillabel="*" label=%s]'%(types.index(name),
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45 types.index(attribute.classname),
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
46 a)
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
47 # all done
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48 print '}'

Roundup Issue Tracker: http://roundup-tracker.org/