| author | Sandro Knauß <knauss@netzguerilla.net> |
| Thu, 27 Sep 2012 17:18:06 +0200 | |
| branch | devel |
| changeset 305 | 887ca66823bb |
| parent 294 | 0e75bd39767d |
| child 313 | a88add2b3eea |
| permissions | -rw-r--r-- |
|
294
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
1 |
# Copyright (c) 2012 netzguerilla.net <iro@netzguerilla.net> |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
2 |
# |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
3 |
# This file is part of Iro. |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
4 |
# |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
5 |
# Permission is hereby granted, free of charge, to any person obtaining a copy of |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
6 |
# this software and associated documentation files (the "Software"), to deal in |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
7 |
# the Software without restriction, including without limitation the rights to use, |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
8 |
# copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
9 |
# #Software, and to permit persons to whom the Software is furnished to do so, |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
10 |
# subject to the following conditions: |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
11 |
# |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
12 |
# The above copyright notice and this permission notice shall be included in |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
13 |
# all copies or substantial portions of the Software. |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
14 |
# |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
15 |
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
16 |
# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
17 |
# PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
18 |
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
19 |
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
20 |
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
21 |
|
| 92 | 22 |
from iro.model import schema |
|
77
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
23 |
|
|
251
3caa803a2dec
getting corresbonding table classes out of schema
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
24 |
tables = schema.Base.metadata.sorted_tables |
|
3caa803a2dec
getting corresbonding table classes out of schema
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
25 |
|
|
3caa803a2dec
getting corresbonding table classes out of schema
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
26 |
tables_cls={} |
|
3caa803a2dec
getting corresbonding table classes out of schema
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
27 |
for i in dir(schema): |
|
3caa803a2dec
getting corresbonding table classes out of schema
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
28 |
if i.startswith("__") or i == "Base": |
|
3caa803a2dec
getting corresbonding table classes out of schema
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
29 |
continue |
|
77
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
30 |
try: |
|
251
3caa803a2dec
getting corresbonding table classes out of schema
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
31 |
a = getattr(schema,i) |
|
3caa803a2dec
getting corresbonding table classes out of schema
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
32 |
tables_cls[a.__tablename__] = a |
|
3caa803a2dec
getting corresbonding table classes out of schema
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
33 |
except AttributeError: |
|
77
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
34 |
pass |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
35 |
|
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
36 |
|
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
37 |
#schema plot |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
38 |
def createSchemaPlot(fname): |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
39 |
from sqlalchemy_schemadisplay3 import create_schema_graph |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
40 |
graph = create_schema_graph(metadata=schema.Base.metadata, |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
41 |
show_datatypes=True, # The image too large if datatypes shown |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
42 |
show_indexes=True, # ditto for indexes |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
43 |
rankdir='LR', # From left to right (instead of top to bottom) |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
44 |
concentrate=True, # Don't try to join the relation lines together |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
45 |
) |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
46 |
|
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
47 |
graph.set_size('6.5,10') |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
48 |
#graph.set_ratio("fill") |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
49 |
graph.write_svg(fname) |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
50 |
|
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
51 |
#umlplot |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
52 |
def createUMLPlot(fname): |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
53 |
from sqlalchemy_schemadisplay3 import create_uml_graph |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
54 |
from sqlalchemy.orm import class_mapper |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
55 |
mappers = [] |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
56 |
for attr in dir(schema.model): |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
57 |
if attr[0] == '_': continue |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
58 |
try: |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
59 |
cls = getattr(schema.model, attr) |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
60 |
mappers.append(class_mapper(cls)) |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
61 |
except: |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
62 |
pass |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
63 |
#pass them to the function and set some formatting options |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
64 |
graph = create_uml_graph(mappers, |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
65 |
show_operations=False, # not necessary in this case |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
66 |
show_multiplicity_one=True, # some people like to see the ones |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
67 |
show_attributes=True, |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
68 |
) |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
69 |
graph.set_size('6,5') |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
70 |
graph.set_ratio("fill") |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
71 |
graph.write_png('test.png') |