mininet/util/doxify.py at devel/monitor · eSoares/mininet · GitHub

8000 mininet/util/doxify.py at devel/monitor · eSoares/mininet · GitHub

{"props":{"color_mode":"dark","logged_in":false,"marketing_page":false,"home_path":"/","login_path":"/login?return_to=https%3A%2F%2FGitHub.com%2FeSoares%2Fmininet%2Fblob%2Fdevel%2Fmonitor%2Futil%2Fdoxify.py","signup_path":"/signup?ref_cta=Sign+up\u0026ref_loc=header+logged+out\u0026ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fblob%2Fshow\u0026source=header-repo\u0026source_repo=eSoares%2Fmininet","signup_enabled":true,"is_signup_controller":false,"show_search_and_nav":true,"hide_search":false,"private_mode_enabled":false,"should_use_dotcom_links":true,"auth_hydro_click":"{\"event_type\":\"authentication.click\",\"payload\":{\"location_in_page\":\"site header menu\",\"repository_id\":null,\"auth_type\":\"SIGN_UP\",\"originating_url\":\"https://GitHub.com/eSoares/mininet/blob/devel/monitor/util/doxify.py\",\"user_id\":null}}","auth_hydro_click_hmac":"d9fe4e22da405b5d827f88ff870fd683dc0b811f036cc91318774ad23f39d5e2"}}

Repository navigation

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

#!/usr/bin/python

"""

Convert simple documentation to epydoc/pydoctor-compatible markup

"""

from sys import stdin, stdout, argv

import os

from tempfile import mkstemp

from subprocess import call

import re

spaces = re.compile( r'\s+' )

singleLineExp = re.compile( r'\s+"([^"]+)"' )

commentStartExp = re.compile( r'\s+"""' )

commentEndExp = re.compile( r'"""$' )

returnExp = re.compile( r'\s+(returns:.*)' )

lastindent = ''

comment = False

def fixParam( line ):

"Change foo: bar to @foo bar"

result = re.sub( r'(\w+):', r'@param \1', line )

result = re.sub( r' @', r'@', result)

return result

def fixReturns( line ):

"Change returns: foo to @return foo"

return re.sub( 'returns:', r'@returns', line )

def fixLine( line ):

global comment

match = spaces.match( line )

if not match:

return line

else:

indent = match.group(0)

if singleLineExp.match( line ):

return re.sub( '"', '"""', line )

if commentStartExp.match( line ):

comment = True

if comment:

line = fixReturns( line )

line = fixParam( line )

if commentEndExp.search( line ):

comment = False

return line

def test():

"Test transformations"

assert fixLine(' "foo"') == ' """foo"""'

assert fixParam( 'foo: bar' ) == '@param foo bar'

assert commentStartExp.match( ' """foo"""')

def funTest():

testFun = (

'def foo():\n'

' "Single line comment"\n'

' """This is a test"""\n'

' bar: int\n'

' baz: string\n'

' returns: junk"""\n'

' if True:\n'

' print "OK"\n'

).splitlines( True )

fixLines( testFun )

def fixLines( lines, fid ):

for line in lines:

os.write( fid, fixLine( line ) )

if __name__ == '__main__':

if False:

funTest()

infile = open( argv[1] )

outfid, outname = mkstemp()

fixLines( infile.readlines(), outfid )

infile.close()

os.close( outfid )

call( [ 'doxypy', outname ] )

0