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