使用Python写iOS Word文档

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

方法功能描述

方法定义
类名:
UIView
方法名:
layoutSubviews
方法入参:
无
抛出异常:
无
方法返回值:
void
方法逻辑

1

- (instancetype)initWithFrame:(CGRect)frame

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

def getOCFileMethdLineCountArray(iOSUrlFilePath):
    arr = []
    iOSUrlFile_object = open(iOSUrlFilePath, 'r')
    methodName = ''
  
    try: 
        for lineIdx,line in enumerate(iOSUrlFile_object):

            # 仅判断符号条件的方法
            if line.startswith('+(') or line.startswith('-(') or line.startswith('+ (') or line.startswith('- (') :
                methodName += line
                # 匹配到方法的大括号
                if '{' in methodName:
                    arr.append((os.path.basename(iOSUrlFilePath).split('.')[0] ,methodName))
                    methodName = ''

                    
    finally:
        iOSUrlFile_object.close()
    return arr

1
2
3
4
5
6
7
8
9

-(NSString *)bankCard:(Int)card apiKey:(NSString *)apiKey secretKey:(NSString *)secretKey cardImageUrl:(NSString * _Nonnull)imageUrl block:(cardOCRBlock _Nullable)completion {
-(NSString *)stringUrlEncodeing:(NSString *)str {
-(id)init{
-(void)cancelRequest {
- (id)initWithFrame:(CGRect)frame{
- (void)updateWithConfig: (void(^)(Config *config))block  {
- (NSMutableArray<UIButton *> *)itemBtns{
- (void)layoutSubviews {
- (void(^)(TestModel * ))initWithBlock:(void(^)(NSString*))block{

 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

def anyliseOC(text):
    
    methodName = ''
    params = []
    returnValue = ''

    # 去掉关键字
    repArray = ['_Nonnull','_Nullable','__nullable','__nonnull','+','-']
    ss1 = text.replace('{','')
    for rep in repArray:
        ss1 = ss1.replace(rep,'')
    # 反向解析参数
    rfIndex = ss1.rfind(':')
    if rfIndex != -1:
        while rfIndex != -1:
            # 最后的参数部分
            pas = ss1[rfIndex+1:].strip()
            # 去掉参数类型的左右两端小括号
            pas = pas.replace('(','',1)
            rIdx = pas.rfind(')')
            if rIdx != -1:
                pas = pas[:rIdx] + pas[rIdx+1:]
            # 多个空格合并成一个空格,执行2次空格替换。
            pas = pas.replace('  ',' ').replace('  ',' ').strip()
            # 添加参数数组中
            params.insert(0,pas)

            # 截掉解析过的尾部
            ss1 = ss1[:rfIndex+1].strip()
            # 最后方法名。向前解析，是否遇到空格或右括号
            spIndex = ss1.rfind(' ',0,rfIndex)
            spIndex1 = ss1.rfind(')',0, rfIndex)
            # 先找到有括号
            if spIndex1 > spIndex:
                spIndex = spIndex1
            # 解析到方法名
            if spIndex != -1:
                fc = ss1[spIndex+1:rfIndex+1]
                methodName = fc + methodName 

            # 截掉解析过的尾部
            ss1 = ss1[:spIndex+1]

            # 开始下一次解析
            rfIndex = ss1.rfind(':')
            
        
    else:
        # 没有参数的方法
        # 方法名。向前解析，是否遇到空格或右括号
            ss1 = ss1.strip()
            spIndex = ss1.rfind(' ')
            spIndex1 = ss1.rfind(')')
            # 先找到有括号
            if spIndex1 > spIndex:
                spIndex = spIndex1
            # 解析到方法名
            if spIndex != -1:
                fc = ss1[spIndex+1:]
                methodName = fc + methodName 
            
            # 截掉解析过的尾部
            ss1 = ss1[:spIndex]
            
    # 返回值处理两端的括号，最后的* 
    returnValue = ss1.strip()
    if returnValue.startswith('('):
        returnValue = returnValue[1:].strip()
    if returnValue.endswith(')'):
        returnValue = returnValue[:-1].strip()
    if returnValue.endswith('*'):
        returnValue = returnValue[:-1].strip()
    print('方法名：{}'.format(methodName))
    print('参数：{}'.format(params))
    print('返回值：{}'.format(returnValue))

 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

def getSwiftFileMethdLineCountArray(iOSUrlFilePath):
    arr = []

    iOSUrlFile_object = open(iOSUrlFilePath, 'r')
    # methodName = ''
    
    fc1 = re.compile(r'[,:=]+')
    try: 
        lines = enumerate(iOSUrlFile_object)
        classLine = ''
        startClass = False
        funcLine = ''
        startFunc = False
        for lineIdx,line in lines:
            # 去除空格,换行符,制表符
            # line = "".join(line.split())
            #判断是否是空行或注释行
            if not len(line)  or line.replace(' ','').startswith('/*') or line.replace(' ','').startswith(' *') or line.replace(' ','').startswith('>>>') or line.replace(' ','').startswith('//') or line.replace(' ','').startswith('*/') or line.replace(' ','').startswith('///'):  
                continue
            else:
                line = line.replace('  ','')
                
                if  line.startswith('init') or \
                    line.startswith('deinit') or \
                    " init" in line or \
                    "init " in line or \
                    "func " in line or \
                    " func" in line or \
                    "func\n" in line or \
                    startFunc :
                    # 如果init前面含有符号,这应该是使用，而不是声明。
                    indexf = line.find(' init')
                    if indexf < 0:
                        indexf = line.find('init ')
                    if indexf >= 0 and re.search(fc1,line[:indexf]) is not None :
                        continue

                    funcLine += line.replace('\n',' ').replace('  ','')
                    if line.find('{') < 0:
                        startFunc = True
                        continue
                    else:
                        startFunc = False
                        arr.append((os.path.basename(iOSUrlFilePath).split('.')[0] ,funcLine))
                        funcLine = ''
    finally:
        iOSUrlFile_object.close()
    return arr

 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

def anyliseSwift(oriText):
    
    # 去除方法名中的一些关键字
    oriText = oriText.replace('@escaping','').replace('public','')\
        .replace('override','').replace('required','').replace('open','')\
            .replace('private','').replace('convenience','').strip()
    # 获取方法完整名。
    funcName = u''
    beganIndex = oriText.find('func ')
    endIndex = oriText.find('{')
    if beganIndex != -1 :
        # 加上func字符串长度
        funcName = oriText[beganIndex + 5:endIndex].strip()
    else:
        # 没有func开头的方法名不在额外处理
        funcName = oriText[:endIndex].strip()

    # 获取返回值
    retIndex = oriText.rfind('->')
    retValue = u"无"
    if retIndex != -1:
        retValue = oriText[retIndex+2:endIndex].strip()
    # 这里会因为闭包解析出错，小括号会被拆分,造成左右不等量，处理一下。
    if retValue.count('(') != retValue.count(')'):
        retValue = u"无"
        retIndex = endIndex

    # 获取参数
    pStart = oriText.find('(')
    pEnd = oriText.rfind(')',0, retIndex)
    fullParam = oriText[pStart+1:pEnd].strip()
    params = fullParam.split(',')
    if len(params[0]) == 0:
        params[0] = u'无'
    else:
        #格式化每个参数
        for i,p in enumerate(params):
            # 去掉开头的下划线，去掉第一个分号，双空格替换成一个。
            if p.startswith('_'):
                p = p[1:]
            p = p.strip().replace(':',' ',1).replace('  ',' ')
            # 去掉方法中的参数说明。
            if len(p.split(' ')) == 3:
                idx = p.find(' ')
                p = p[idx:].strip()
            params[i] = p
    
    return (funcName,params,retValue)

  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

# 方法的固定功能说明。
def generateSumary(oriText,className):
    if oriText.find('init') >= 0:
        return u"类初始化。"
    elif oriText.lower().find('viewdidload') >= 0:
        return u"页面加载完成。"
    elif oriText.lower().find('viewdidappear') >= 0:
        return "页面已经显示。"
    elif oriText.lower().find('viewwillappear') >= 0:
        return "页面将要显示。"
    elif oriText.lower().find('viewwilldisappear') >= 0:
        return u"页面将要消失。"
    elif oriText.lower().find('viewdiddisappear') >= 0:
        return u"页面已经消失。"
    else:
        return u""

# 设置段落格式
def setText(doc,text,size,bold):
    p1 = doc.add_paragraph()
    p1.paragraph_format.first_line_indent = Cm(0.74)  
    p1.paragraph_format.line_spacing = 1.5 # 1.5倍行距 
    l1 = p1.add_run(text)
    l1.font.size = size
    l1.font.name = u"宋体"
    l1.bold = bold
        

# 具体内容添加
def addDetail(doc,text1,textArr):
    setText(doc,text1,Pt(14),True)
    for text in textArr:
        # print(text+'\n')
        setText(doc,text,Pt(14),False)

# 将源文件分析完成后，输出到目标目录下
def writeToWord(sourcePath,outPath):
    # 创建空文档
    document = Document()
    document.styles['Normal'].font.name = u'宋体'
    document.styles['Normal']._element.rPr.rFonts.set(qn('w:eastAsia'), u'宋体')
    # 添加标题，设置级别level，0为Title，1或省略为Heading 1，0<=level<=9
    # document.add_heading('Document Title', 0)

    path = sourcePath+''
    arrT = []

    for dirpath, dirname, filenames in os.walk(path):   
        for filename in filenames:
            if '.m' in filename or '.mm' in filename:
                filePath = os.path.join(dirpath, filename)
                MacroWithCountDicts = getOCFileMethdLineCountArray(filePath)
                print('=====================')
                print('{} 有 {} 个方法'.format(filename,len(MacroWithCountDicts)))
                arrT += MacroWithCountDicts

            elif '.swift' in filename:
                filePath = os.path.join(dirpath, filename)
                MacroWithCountDicts = getSwiftFileMethdLineCountArray(filePath)
                print('=====================')
                print('{} 有 {} 个方法'.format(filename,len(MacroWithCountDicts)))
                arrT += MacroWithCountDicts


    print("********************************")
    print("一共有 {} 个方法".format(len(arrT)))
    print("********************************")
    for result in arrT:
        fullFuncName = result[1]
        allMsg = []
        if fullFuncName.strip().startswith('+') or fullFuncName.strip().startswith('-'):
            allMsg = anyliseOC(fullFuncName)
        else:
            allMsg = anyliseSwift(fullFuncName)

        className = result[0]
        funcName = allMsg[0]
        paras = allMsg[1]
        returnStr = allMsg[2]
        # # 函数名设置为4级标题
        document.add_heading(funcName,level=4)

        # #功能设置为5级标题
        document.add_heading(u"方法功能描述",level=5)

        setText(document,generateSumary(funcName,className),Pt(14),False)

        # 方法定义设置为5级标题
        document.add_heading(u"方法定义",level=5)
        addDetail(document,u"类名:",[className])
        addDetail(document,u"方法名:",[funcName])
        addDetail(document,u"方法入参:",paras)
        addDetail(document,u"抛出异常:",[u"无"])
        addDetail(document,u"方法返回值:",[returnStr])

        # 方法的逻辑设置为5级标题
        document.add_heading(u"方法逻辑",level=5)
        # 一些固定方法填充内容。
        # if 'NSCoder' in funcName:
        #     setText(document,u"调用fatalError方法。",Pt(14),False)
        # elif 'init' in funcName:
        #     setText(document,u"父类初始化，",Pt(14),False)
        # else:
        setText(document,u"",Pt(14),False)

    try:
        document.save(outPath+"生成iOS方法文档.docx")
    except Exception:
        print(u"检查下当前目录是否存在,是否包含/")
    else:
        print(u"完成,请打开"+outPath+u"目录下的文件")