mirror of
https://github.com/ivellioscolin/pykd.git
synced 2025-04-21 21:03:23 +08:00
134 lines
4.3 KiB
Python
134 lines
4.3 KiB
Python
#
|
|
#
|
|
#
|
|
|
|
import sys
|
|
|
|
|
|
def usage():
|
|
print "python pytowiki.py module_name output_file"
|
|
|
|
|
|
class CodeplexFormatter:
|
|
|
|
def endl( self ):
|
|
return "\n"
|
|
|
|
def header1( self, s ):
|
|
return "! " + s + self.endl()
|
|
|
|
def header2( self, s ):
|
|
return "!! " + s + self.endl()
|
|
|
|
def header3( self, s ):
|
|
return "!!! " + s + self.endl()
|
|
|
|
def header4( self, s ):
|
|
return "!!!! " + s + self.endl()
|
|
|
|
def bulletItem( self, s ):
|
|
return "* " + s + self.endl()
|
|
|
|
def escapeMarkup( self, s ):
|
|
return "{\"" + s + "\"}"
|
|
|
|
def link( self, text, link ):
|
|
return "[" + text + "|#" + link + "]"
|
|
|
|
def anchor( self, link ):
|
|
return "{anchor:" + link + "}" + self.endl()
|
|
|
|
|
|
|
|
class ModuleInfo:
|
|
|
|
def __init__ (self, module):
|
|
self.funcs = sorted( [ item for item in module.__dict__.values() if type(item).__name__ == "function" ], key=lambda x: x.__name__ )
|
|
self.classes = sorted( [ item for item in module.__dict__.values() if type(item).__name__ == "class" ], key=lambda x: x.__name__ )
|
|
|
|
for cls in self.classes:
|
|
cls.methods = sorted( [ item for item in cls.__dict__.values() if type(item).__name__ == "function" ], key=lambda x: x.__name__ )
|
|
cls.properties = sorted( [ item for item in cls.__dict__.items() if type(item[1]).__name__ == "property" ], key=lambda x: x[0] )
|
|
|
|
|
|
def buildDoc( ioStream, formatter, apiInfo ):
|
|
|
|
ioStream.write( formatter.header2( "Functions" ) )
|
|
|
|
for func in apiInfo.funcs:
|
|
ioStream.write( formatter.bulletItem( formatter.link( func.__name__, func.__name__ ) ) )
|
|
|
|
ioStream.write( formatter.header2( "Classes" ) )
|
|
|
|
for cls in apiInfo.classes:
|
|
ioStream.write( formatter.bulletItem( formatter.link( cls.__name__, cls.__name__ ) ) )
|
|
|
|
|
|
for func in apiInfo.funcs:
|
|
ioStream.write( formatter.anchor( func.__name__ ) )
|
|
ioStream.write( formatter.header3( "Function " + func.__name__ ) )
|
|
if func.__doc__ != None:
|
|
ioStream.write( formatter.escapeMarkup( func.__doc__) + formatter.endl() )
|
|
|
|
|
|
for cls in apiInfo.classes:
|
|
ioStream.write( formatter.anchor( cls.__name__ ) )
|
|
ioStream.write( formatter.header3( "Class " + cls.__name__ ) )
|
|
if cls.__doc__ != None:
|
|
ioStream.write( formatter.escapeMarkup( cls.__doc__) + formatter.endl() )
|
|
|
|
if cls.properties:
|
|
ioStream.write( formatter.header4( "Properties:") )
|
|
for p in cls.properties:
|
|
ioStream.write( formatter.bulletItem( formatter.link( p[0], cls.__name__ + "." + p[0]) ) )
|
|
|
|
if cls.methods:
|
|
ioStream.write( formatter.header4( "Methods:") )
|
|
for m in cls.methods:
|
|
if m.__doc__ != None:
|
|
ioStream.write( formatter.bulletItem( formatter.link( m.__name__, cls.__name__ + "." + m.__name__) ) )
|
|
|
|
if cls.properties:
|
|
for p in cls.properties:
|
|
if p[1].__doc__ != None:
|
|
ioStream.write( formatter.anchor( cls.__name__ + "." + p[0] ) )
|
|
ioStream.write( formatter.header4( formatter.escapeMarkup( "Property " + cls.__name__ + "." + p[0] ) ) )
|
|
ioStream.write( formatter.escapeMarkup( p[1].__doc__ ) + formatter.endl() )
|
|
|
|
if cls.methods:
|
|
for m in cls.methods:
|
|
if m.__doc__ != None:
|
|
ioStream.write( formatter.anchor( cls.__name__ + "." + m.__name__ ) )
|
|
ioStream.write( formatter.header4( formatter.escapeMarkup( "Method " + cls.__name__ + "." + m.__name__ ) ) )
|
|
ioStream.write( formatter.escapeMarkup( m.__doc__ ) + formatter.endl() )
|
|
|
|
|
|
def main():
|
|
|
|
if len(sys.argv) < 3:
|
|
usage()
|
|
return
|
|
|
|
moduleName = sys.argv[1]
|
|
fileName = sys.argv[2]
|
|
|
|
try:
|
|
|
|
module = __import__( moduleName )
|
|
|
|
with file( fileName, "w" ) as wikiIo:
|
|
|
|
apiInfo = ModuleInfo( module )
|
|
|
|
formatter = CodeplexFormatter()
|
|
|
|
buildDoc( wikiIo, formatter, apiInfo )
|
|
|
|
except ImportWarning:
|
|
|
|
print "failed to import module " + moduleName
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|