1. windwiny
  2. wxPython

Source

wxPython / wx / tools / Editra / scripts / doxypy.py

  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
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
#!/usr/bin/env python

__applicationName__ = "doxypy"
__blurb__ = """
doxypy is an input filter for Doxygen. It preprocesses python
files so that docstrings of classes and functions are reformatted
into Doxygen-conform documentation blocks.
"""

__doc__ = __blurb__ + \
"""
In order to make Doxygen preprocess files through doxypy, simply
add the following lines to your Doxyfile:
    FILTER_SOURCE_FILES = YES
    INPUT_FILTER = "python /path/to/doxypy.py"
"""

__version__ = "0.4.2"
__date__ = "14th October 2009"
__website__ = "http://code.foosel.org/doxypy"

__author__ = (
    "Philippe 'demod' Neumann (doxypy at demod dot org)",
    "Gina 'foosel' Haeussge (gina at foosel dot net)" 
)

__licenseName__ = "GPL v2"
__license__ = """This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
"""

import sys
import re

from optparse import OptionParser, OptionGroup

class FSM(object):
    """Implements a finite state machine.
    
    Transitions are given as 4-tuples, consisting of an origin state, a target
    state, a condition for the transition (given as a reference to a function
    which gets called with a given piece of input) and a pointer to a function
    to be called upon the execution of the given transition. 
    """
    
    """
    @var transitions holds the transitions
    @var current_state holds the current state
    @var current_input holds the current input
    @var current_transition hold the currently active transition
    """
    
    def __init__(self, start_state=None, transitions=[]):
        self.transitions = transitions
        self.current_state = start_state
        self.current_input = None
        self.current_transition = None
        
    def setStartState(self, state):
        self.current_state = state

    def addTransition(self, from_state, to_state, condition, callback):
        self.transitions.append([from_state, to_state, condition, callback])
        
    def makeTransition(self, input):
        """Makes a transition based on the given input.
        
        @param    input    input to parse by the FSM
        """
        for transition in self.transitions:
            [from_state, to_state, condition, callback] = transition
            if from_state == self.current_state:
                match = condition(input)
                if match:
                    self.current_state = to_state
                    self.current_input = input
                    self.current_transition = transition
                    if options.debug:
                        print >>sys.stderr, "# FSM: executing (%s -> %s) for line '%s'" % (from_state, to_state, input)
                    callback(match)
                    return

class Doxypy(object):
    def __init__(self):
        string_prefixes = "[uU]?[rR]?"
        
        self.start_single_comment_re = re.compile("^\s*%s(''')" % string_prefixes)
        self.end_single_comment_re = re.compile("(''')\s*$")
        
        self.start_double_comment_re = re.compile("^\s*%s(\"\"\")" % string_prefixes)
        self.end_double_comment_re = re.compile("(\"\"\")\s*$")
        
        self.single_comment_re = re.compile("^\s*%s(''').*(''')\s*$" % string_prefixes)
        self.double_comment_re = re.compile("^\s*%s(\"\"\").*(\"\"\")\s*$" % string_prefixes)
        
        self.defclass_re = re.compile("^(\s*)(def .+:|class .+:)")
        self.empty_re = re.compile("^\s*$")
        self.hashline_re = re.compile("^\s*#.*$")
        self.importline_re = re.compile("^\s*(import |from .+ import)")

        self.multiline_defclass_start_re = re.compile("^(\s*)(def|class)(\s.*)?$")
        self.multiline_defclass_end_re = re.compile(":\s*$")
        
        self.markup_re = re.compile(r"@[a-z]+:")
        self.param_re = re.compile(r"@param\s+[a-zA-Z0-9_]+:")

        ## Transition list format
        #  ["FROM", "TO", condition, action]
        transitions = [
            ### FILEHEAD
            
            # single line comments
            ["FILEHEAD", "FILEHEAD", self.single_comment_re.search, self.appendCommentLine],
            ["FILEHEAD", "FILEHEAD", self.double_comment_re.search, self.appendCommentLine],
            
            # multiline comments
            ["FILEHEAD", "FILEHEAD_COMMENT_SINGLE", self.start_single_comment_re.search, self.appendCommentLine],
            ["FILEHEAD_COMMENT_SINGLE", "FILEHEAD", self.end_single_comment_re.search, self.appendCommentLine],
            ["FILEHEAD_COMMENT_SINGLE", "FILEHEAD_COMMENT_SINGLE", self.catchall, self.appendCommentLine],
            ["FILEHEAD", "FILEHEAD_COMMENT_DOUBLE", self.start_double_comment_re.search, self.appendCommentLine],
            ["FILEHEAD_COMMENT_DOUBLE", "FILEHEAD", self.end_double_comment_re.search, self.appendCommentLine],
            ["FILEHEAD_COMMENT_DOUBLE", "FILEHEAD_COMMENT_DOUBLE", self.catchall, self.appendCommentLine],
            
            # other lines
            ["FILEHEAD", "FILEHEAD", self.empty_re.search, self.appendFileheadLine],
            ["FILEHEAD", "FILEHEAD", self.hashline_re.search, self.appendFileheadLine],
            ["FILEHEAD", "FILEHEAD", self.importline_re.search, self.appendFileheadLine],
            ["FILEHEAD", "DEFCLASS", self.defclass_re.search, self.resetCommentSearch],
            ["FILEHEAD", "DEFCLASS_MULTI", self.multiline_defclass_start_re.search, self.resetCommentSearch],            
            ["FILEHEAD", "DEFCLASS_BODY", self.catchall, self.appendFileheadLine],

            ### DEFCLASS
            
            # single line comments
            ["DEFCLASS", "DEFCLASS_BODY", self.single_comment_re.search, self.appendCommentLine],
            ["DEFCLASS", "DEFCLASS_BODY", self.double_comment_re.search, self.appendCommentLine],
            
            # multiline comments
            ["DEFCLASS", "COMMENT_SINGLE", self.start_single_comment_re.search, self.appendCommentLine],
            ["COMMENT_SINGLE", "DEFCLASS_BODY", self.end_single_comment_re.search, self.appendCommentLine],
            ["COMMENT_SINGLE", "COMMENT_SINGLE", self.catchall, self.appendCommentLine],
            ["DEFCLASS", "COMMENT_DOUBLE", self.start_double_comment_re.search, self.appendCommentLine],
            ["COMMENT_DOUBLE", "DEFCLASS_BODY", self.end_double_comment_re.search, self.appendCommentLine],
            ["COMMENT_DOUBLE", "COMMENT_DOUBLE", self.catchall, self.appendCommentLine],

            # other lines
            ["DEFCLASS", "DEFCLASS", self.empty_re.search, self.appendDefclassLine],
            ["DEFCLASS", "DEFCLASS", self.defclass_re.search, self.resetCommentSearch],
            ["DEFCLASS", "DEFCLASS_MULTI", self.multiline_defclass_start_re.search, self.resetCommentSearch],
            ["DEFCLASS", "DEFCLASS_BODY", self.catchall, self.stopCommentSearch],
            
            ### DEFCLASS_BODY
            
            ["DEFCLASS_BODY", "DEFCLASS", self.defclass_re.search, self.startCommentSearch],
            ["DEFCLASS_BODY", "DEFCLASS_MULTI", self.multiline_defclass_start_re.search, self.startCommentSearch],
            ["DEFCLASS_BODY", "DEFCLASS_BODY", self.catchall, self.appendNormalLine],

            ### DEFCLASS_MULTI
            ["DEFCLASS_MULTI", "DEFCLASS", self.multiline_defclass_end_re.search, self.appendDefclassLine],
            ["DEFCLASS_MULTI", "DEFCLASS_MULTI", self.catchall, self.appendDefclassLine],
        ]
        
        self.fsm = FSM("FILEHEAD", transitions)
        self.outstream = sys.stdout
        
        self.output = []
        self.comment = []
        self.filehead = []
        self.defclass = []
        self.indent = ""

    def __closeComment(self):
        """Appends any open comment block and triggering block to the output."""
        
        if options.autobrief:
            if len(self.comment) == 1 \
            or (len(self.comment) > 2 and self.comment[1].strip() == ''):
                self.comment[0] = self.__docstringSummaryToBrief(self.comment[0])
            
        if self.comment:
            block = self.makeCommentBlock()
            self.output.extend(block)
            
        if self.defclass:
            self.output.extend(self.defclass)

    def __docstringSummaryToBrief(self, line):
        """Adds \\brief to the docstrings summary line.
        
        A \\brief is prepended, provided no other doxygen command is at the
        start of the line.
        """
        stripped = line.strip()
        if stripped and not stripped[0] in ('@', '\\'):
            return "\\brief " + line
        else:
            return line

    def postFilter(self, output, pattern):
        """Do post processing filtering on output"""
        ms = pattern.findall(output)
        if len(ms):
            ms = list(set(ms))
            for m in ms:
                output = output.replace(m, m.rstrip(':'))
        return output

    def __flushBuffer(self):
        """Flushes the current outputbuffer to the outstream."""
        if self.output:
            try:
                if options.debug:
                    print >>sys.stderr, "# OUTPUT: ", self.output
                output = "\n".join(self.output)

                # Do custom post processing to get clearer output by converting
                # epydoc markup to doxygen compatible markup.
                output = output.replace("@keyword", "@param")
                output = output.replace("@summary", "@brief")
                output = output.replace("@postcondition", "@post")
                output = output.replace("@precondition", "@pre")
                for p in (self.markup_re, self.param_re):
                    output = self.postFilter(output, p)
                epre = re.compile("[RL]\{(.+)\}")
                ms = epre.findall(output)
                if len(ms):
                    for m in ms:
                        output = output.replace("L{%s}" % m, m)
                        output = output.replace("R{%s}" % m, m)
                print >> self.outstream, output
                self.outstream.flush()
            except IOError:
                # Fix for FS#33. Catches "broken pipe" when doxygen closes 
                # stdout prematurely upon usage of INPUT_FILTER, INLINE_SOURCES 
                # and FILTER_SOURCE_FILES.
                pass
        self.output = []

    def catchall(self, input):
        """The catchall-condition, always returns true."""
        return True
    
    def resetCommentSearch(self, match):
        """Restarts a new comment search for a different triggering line.
        
        Closes the current commentblock and starts a new comment search.
        """
        if options.debug:
            print >>sys.stderr, "# CALLBACK: resetCommentSearch" 
        self.__closeComment()
        self.startCommentSearch(match)
    
    def startCommentSearch(self, match):
        """Starts a new comment search.
        
        Saves the triggering line, resets the current comment and saves
        the current indentation.
        """
        if options.debug:
            print >>sys.stderr, "# CALLBACK: startCommentSearch"
        self.defclass = [self.fsm.current_input]
        self.comment = []
        self.indent = match.group(1)
    
    def stopCommentSearch(self, match):
        """Stops a comment search.
        
        Closes the current commentblock, resets    the triggering line and
        appends the current line to the output.
        """
        if options.debug:
            print >>sys.stderr, "# CALLBACK: stopCommentSearch" 
        self.__closeComment()
        
        self.defclass = []
        self.output.append(self.fsm.current_input)
    
    def appendFileheadLine(self, match):
        """Appends a line in the FILEHEAD state.
        
        Closes the open comment    block, resets it and appends the current line.
        """ 
        if options.debug:
            print >>sys.stderr, "# CALLBACK: appendFileheadLine" 
        self.__closeComment()
        self.comment = []
        self.output.append(self.fsm.current_input)

    def appendCommentLine(self, match):
        """Appends a comment line.
        
        The comment delimiter is removed from multiline start and ends as
        well as singleline comments.
        """
        if options.debug:
            print >>sys.stderr, "# CALLBACK: appendCommentLine" 
        (from_state, to_state, condition, callback) = self.fsm.current_transition
        
        # single line comment
        if (from_state == "DEFCLASS" and to_state == "DEFCLASS_BODY") \
        or (from_state == "FILEHEAD" and to_state == "FILEHEAD"):
            # remove comment delimiter from begin and end of the line
            activeCommentDelim = match.group(1)
            line = self.fsm.current_input
            self.comment.append(line[line.find(activeCommentDelim)+len(activeCommentDelim):line.rfind(activeCommentDelim)])

            if (to_state == "DEFCLASS_BODY"):
                self.__closeComment()
                self.defclass = []
        # multiline start
        elif from_state == "DEFCLASS" or from_state == "FILEHEAD":
            # remove comment delimiter from begin of the line
            activeCommentDelim = match.group(1)
            line = self.fsm.current_input
            self.comment.append(line[line.find(activeCommentDelim)+len(activeCommentDelim):])
        # multiline end
        elif to_state == "DEFCLASS_BODY" or to_state == "FILEHEAD":
            # remove comment delimiter from end of the line
            activeCommentDelim = match.group(1)
            line = self.fsm.current_input
            self.comment.append(line[0:line.rfind(activeCommentDelim)])
            if (to_state == "DEFCLASS_BODY"):
                self.__closeComment()
                self.defclass = []
        # in multiline comment
        else:
            # just append the comment line
            self.comment.append(self.fsm.current_input)
    
    def appendNormalLine(self, match):
        """Appends a line to the output."""
        if options.debug:
            print >>sys.stderr, "# CALLBACK: appendNormalLine" 
        self.output.append(self.fsm.current_input)
        
    def appendDefclassLine(self, match):
        """Appends a line to the triggering block."""
        if options.debug:
            print >>sys.stderr, "# CALLBACK: appendDefclassLine" 
        self.defclass.append(self.fsm.current_input)
    
    def makeCommentBlock(self):
        """Indents the current comment block with respect to the current
        indentation level.

        @returns a list of indented comment lines
        """
        doxyStart = "##"
        commentLines = self.comment
        
        commentLines = map(lambda x: "%s# %s" % (self.indent, x), commentLines)
        l = [self.indent + doxyStart]
        l.extend(commentLines)
             
        return l
    
    def parse(self, input):
        """Parses a python file given as input string and returns the doxygen-
        compatible representation.
        
        @param    input    the python code to parse
        @returns the modified python code
        """ 
        lines = input.split("\n")
        
        for line in lines:
            self.fsm.makeTransition(line)
            
        if self.fsm.current_state == "DEFCLASS":
            self.__closeComment()
        
        return "\n".join(self.output)
    
    def parseFile(self, filename):
        """Parses a python file given as input string and returns the doxygen-
        compatible representation.
        
        @param    input    the python code to parse
        @returns the modified python code
        """ 
        f = open(filename, 'r')
        
        for line in f:
            self.parseLine(line.rstrip('\r\n'))
        if self.fsm.current_state == "DEFCLASS":
            self.__closeComment()
            self.__flushBuffer()
        f.close()
    
    def parseLine(self, line):
        """Parse one line of python and flush the resulting output to the 
        outstream.
        
        @param    line    the python code line to parse
        """
        self.fsm.makeTransition(line)
        self.__flushBuffer()
    
def optParse():
    """Parses commandline options."""
    parser = OptionParser(prog=__applicationName__, version="%prog " + __version__)
    
    parser.set_usage("%prog [options] filename")
    parser.add_option("--autobrief",
        action="store_true", dest="autobrief",
        help="use the docstring summary line as \\brief description"
    )
    parser.add_option("--debug",
        action="store_true", dest="debug",
        help="enable debug output on stderr"
    )
    
    ## parse options
    global options
    (options, filename) = parser.parse_args()
    
    if not filename:
        print >>sys.stderr, "No filename given."
        sys.exit(-1)
    
    return filename[0]

def main():
    """Starts the parser on the file given by the filename as the first 
    argument on the commandline.
    """
    filename = optParse()
    fsm = Doxypy()
    fsm.parseFile(filename)

if __name__ == "__main__":
    main()