summaryrefslogtreecommitdiff
path: root/doc/en/genapi.py
blob: 0ede44fa2dee730bee5e279094dcd7a376c1dfe6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
import textwrap
import inspect

class Writer(object):
    def __init__(self, clsname):
        self.clsname = clsname

    def __enter__(self):
        self.file = open("%s.api" % self.clsname, "w")
        return self

    def __exit__(self, *args):
        self.file.close()
        print "wrote", self.file.name

    def line(self, line):
        self.file.write(line+"\n")

    def docmethod(self, method):
        doc = " ".join(method.__doc__.split())
        indent = "         "
        w = textwrap.TextWrapper(initial_indent=indent,
                                 subsequent_indent=indent)

        spec = inspect.getargspec(method)
        del spec.args[0]
        self.line(".. py:method:: " + method.__name__ +
                  inspect.formatargspec(*spec))
        self.line("")
        self.line(w.fill(doc))
        self.line("")

def pytest_funcarg__a(request):
    with Writer("request") as writer:
        writer.docmethod(request.getfixturevalue)
        writer.docmethod(request.cached_setup)
        writer.docmethod(request.addfinalizer)
        writer.docmethod(request.applymarker)

def test_hello(a):
    pass