annotate scripts/schema_diagram.py @ 6311:be8d5a8e090a

Fix uncaught error when parsing rest headers, document Started this work as better docs for rest response format. But I found 406 error response was not being tested. Also there was no error for bad Content-Type. In rest.py fix uncaught exceptions due to invalid Accept or Content-Type headers. If Content-type is valid but not application/json return code 415. Document use of accept header (was only shown in examples) and support for q parameter. Describe using .xml and .json extensions to select return format for testing from browser (where setting accept header is a problem). Document 406 error code return. Document 415 error code return and acceptable content types. Previously only doc was in examples. Set up tests for 406 and 415 error codes.
author John Rouillard <rouilj@ieee.org>
date Fri, 01 Jan 2021 14:14:34 -0500
parents 23b8e6067f7c
children 9c3ec0a5c7fc
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 #
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
13 from __future__ import print_function
1166
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14 import sys
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
15 import roundup.instance
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
16
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
17 # open the instance
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
18 instance = roundup.instance.open(sys.argv[1])
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
19 db = instance.open()
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
20
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
21 # diagram preamble
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
22 print('digraph schema {')
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
23 print('size="8,6"')
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
24 print('node [shape="record" bgcolor="#ffe4c4" style=filled]')
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
25 print('edge [taillabel="1" headlabel="1" dir=back arrowtail=ediamond]')
1166
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
26
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
27 # get all the classes
5395
23b8e6067f7c Python 3 preparation: update calls to dict methods.
Joseph Myers <jsm@polyomino.org.uk>
parents: 5376
diff changeset
28 types = list(db.classes.keys())
1166
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
29
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
30 # one record node per class
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
31 for i in range(len(types)):
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
32 print('node%d [label=\"{%s|}"]'%(i, types[i]))
1166
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
33
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
34 # now draw in the relations
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
35 for name in db.classes.keys():
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
36 type = db.classes[name]
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
37 attributes = type.getprops()
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
38 for a in attributes.keys():
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
39 attribute = attributes[a]
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
40 if isinstance(attribute, roundup.hyperdb.Link):
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
41 print('node%d -> node%d [label=%s]'%(types.index(name),
1166
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42 types.index(attribute.classname),
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
43 a))
1166
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44 elif isinstance(attribute, roundup.hyperdb.Multilink):
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
45 print('node%d -> node%d [taillabel="*" label=%s]'%(types.index(name),
1166
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
46 types.index(attribute.classname),
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
47 a))
1166
d56b7fc64923 additions
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
48 # all done
5376
64b05e24dbd8 Python 3 preparation: convert print to a function.
Joseph Myers <jsm@polyomino.org.uk>
parents: 1166
diff changeset
49 print('}')

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