| author | Sandro Knauß <knauss@netzguerilla.net> |
| Sat, 24 Mar 2012 01:05:34 +0100 | |
| branch | devel |
| changeset 250 | 91890ea7ed81 |
| parent 92 | f479738b4879 |
| child 251 | 3caa803a2dec |
| permissions | -rwxr-xr-x |
| 72 | 1 |
#!/usr/bin/env python2.7 |
2 |
# -*- coding: utf-8 -*- |
|
3 |
||
4 |
from genshi.template import TemplateLoader |
|
5 |
||
6 |
loader = TemplateLoader('doc/tmpl', auto_reload=True) |
|
7 |
||
8 |
import re |
|
9 |
import inspect |
|
|
250
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
10 |
from iro.view.xmlrpc_old import User as Current |
| 92 | 11 |
from iro.controller.viewinterface import Interface as New |
| 72 | 12 |
|
| 92 | 13 |
from createerm import createSchemaPlot, tables |
| 72 | 14 |
|
15 |
||
|
76
9f7da8dc8df8
using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents:
74
diff
changeset
|
16 |
|
| 72 | 17 |
class Link(): |
18 |
def __init__(self,name,title): |
|
19 |
self.name=name |
|
20 |
self.title=title |
|
21 |
||
22 |
def getLink(self): |
|
23 |
return self.name |
|
24 |
||
25 |
def __getitem__(self,name): |
|
26 |
if name == "link": |
|
27 |
return self.getLink() |
|
28 |
return AttributeError(name) |
|
29 |
||
30 |
class Site(Link): |
|
31 |
pass |
|
32 |
||
33 |
class Keyword(): |
|
34 |
def __init__(self,name,typ,description): |
|
35 |
self.name=name |
|
36 |
self.typ=typ |
|
37 |
self.description=description |
|
38 |
||
39 |
def section(text): |
|
40 |
ret={} |
|
41 |
li=[] |
|
42 |
kw=None |
|
43 |
for line in text.split("\n"): |
|
44 |
if re.match("^\s*$",line): |
|
45 |
continue |
|
46 |
||
47 |
if line[0] not in (" ","\t"): |
|
48 |
if kw: |
|
49 |
ret[kw.name]=kw |
|
50 |
li.append(kw) |
|
| 73 | 51 |
l=re.match(r"^(?P<name>[a-zA-Z0-9-_.]*)\[(?P<typ>[a-zA-Z0-9-_|]*)\]:(?P<d>.*)$",line) |
| 72 | 52 |
kw=Keyword(name=l.group("name"),typ=l.group("typ"),description=l.group("d")) |
53 |
else: |
|
54 |
kw.description+="\n"+line.strip() |
|
55 |
if kw: |
|
56 |
ret[kw.name]=kw |
|
57 |
li.append(kw) |
|
58 |
return ret,li |
|
59 |
||
60 |
||
61 |
||
62 |
def keywords(f): |
|
|
76
9f7da8dc8df8
using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents:
74
diff
changeset
|
63 |
doc=f.__doc__.decode('utf8') |
| 72 | 64 |
kwds=re.search("Keywords:\n(?P<keywords>(?P<whitespace>\s*)(.+\n)*)\n",doc) |
65 |
k=kwds.group("keywords") |
|
66 |
#get rid of beginning whitespaces |
|
67 |
k=re.sub(re.compile(r"^"+kwds.group("whitespace"),re.M),"",k) |
|
68 |
return section(k) |
|
69 |
||
70 |
def ret(f): |
|
|
76
9f7da8dc8df8
using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents:
74
diff
changeset
|
71 |
doc=f.__doc__.decode('utf8') |
| 72 | 72 |
kwds=re.search("Return:\n(?P<ret>(?P<whitespace>\s*)(.+\n)*)\n",doc) |
73 |
k=kwds.group("ret") |
|
74 |
#get rid of beginning whitespaces |
|
75 |
k=re.sub(re.compile(r"^"+kwds.group("whitespace"),re.M),"",k) |
|
76 |
return section(k) |
|
77 |
||
78 |
||
79 |
||
80 |
class Arg(): |
|
81 |
def __init__(self,name,f): |
|
82 |
self.name=name |
|
83 |
k,_ = keywords(f) |
|
84 |
kwd=k[name] |
|
85 |
self.typ=kwd.typ |
|
86 |
self.description=kwd.description |
|
87 |
||
88 |
||
89 |
||
90 |
class Method(Link): |
|
| 73 | 91 |
def __init__(self,name,methods): |
92 |
title=name[0].upper()+name[1:] |
|
| 72 | 93 |
Link.__init__(self,name,title) |
| 73 | 94 |
m=methods[name] |
|
74
c471fed3cab8
update document creation:
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
95 |
(args, varargs, keywords, defaults)=inspect.getargspec(m) |
|
250
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
96 |
a=[] |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
97 |
for b in args: |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
98 |
if b in ("self","session"): |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
99 |
continue |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
100 |
if b == "user": |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
101 |
a.append("apikey") |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
102 |
else: |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
103 |
a.append(b) |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
104 |
|
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
105 |
args = a |
|
74
c471fed3cab8
update document creation:
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
106 |
self.func_line=inspect.formatargspec(args, varargs, keywords, defaults) |
|
76
9f7da8dc8df8
using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents:
74
diff
changeset
|
107 |
self.description = m.__doc__.split("\n")[0].decode("utf8") |
|
74
c471fed3cab8
update document creation:
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
108 |
self.args=[Arg(a,m) for a in args] |
| 72 | 109 |
_, self.rets=ret(m) |
110 |
||
|
77
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
111 |
class Table(Link): |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
112 |
def __init__(self,cls): |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
113 |
name=cls.__name__ |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
114 |
self.tablename=cls.__tablename__ |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
115 |
title=self.tablename[0].upper()+self.tablename[1:] |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
116 |
Link.__init__(self,name,title) |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
117 |
self.description = cls.__doc__.split("\n")[0].decode("utf8") |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
118 |
|
| 72 | 119 |
|
120 |
def main(): |
|
121 |
sites=[Site("index.html","Iro"), |
|
122 |
Site("current.html","API Documentation"), |
|
123 |
Site("new.html","geplante API Documentation"), |
|
|
77
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
124 |
Site("database.html","Datenbank Schema"), |
| 72 | 125 |
Site("impressum.html","Impressum"), |
126 |
] |
|
127 |
||
| 73 | 128 |
current_methods = dict(inspect.getmembers(Current(None,None))) |
129 |
current=[ |
|
130 |
Method("startSMS",current_methods), |
|
131 |
Method("startFAX",current_methods), |
|
132 |
Method("startMail",current_methods), |
|
133 |
||
134 |
Method("status",current_methods), |
|
135 |
Method("stop",current_methods), |
|
| 72 | 136 |
|
| 73 | 137 |
Method("getProvider",current_methods), |
138 |
Method("getDefaultProvider",current_methods), |
|
139 |
] |
|
140 |
||
141 |
new_methods = dict(inspect.getmembers(New())) |
|
142 |
newm=[ |
|
143 |
Method("sms",new_methods), |
|
144 |
Method("fax",new_methods), |
|
145 |
Method("mail",new_methods), |
|
| 72 | 146 |
|
| 73 | 147 |
Method("status",new_methods), |
148 |
Method("stop",new_methods), |
|
149 |
||
150 |
Method("routes",new_methods), |
|
151 |
Method("defaultRoute",new_methods), |
|
| 72 | 152 |
] |
|
77
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
153 |
|
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
154 |
t = [Table(f.class_) for f in tables] |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
155 |
createSchemaPlot('doc/images/db-schema.svg') |
| 73 | 156 |
|
| 72 | 157 |
for site in sites: |
158 |
print("generiere %s" % site.name) |
|
159 |
tmpl = loader.load(site.name) |
|
160 |
def a(s): |
|
161 |
if s == site: |
|
162 |
return {"class":"menu active"} |
|
|
77
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
163 |
stream = tmpl.generate(sites=sites,active=a,current=current,new=newm,tables=t) |
| 72 | 164 |
with open('doc/'+site.name, "w") as g: |
165 |
g.write(stream.render('html', doctype='html')) |
|
166 |
||
167 |
if __name__ == '__main__': |
|
168 |
main() |