python将sql导出为md

发表于 更新于 分类于
本文字数： 4.7k 阅读时长 ≈ 4 分钟

python 将 sql 导出为 md

环境

  • python38

使用

  1. 建造 python 项目，或者 git 克隆AutoBuildDocFromDB

    克隆代码需要修改，读取写入文件编码方式

  2. 在项目目录下运行:python build.py sql_dir其中 sql_dir 为您的 sql 文件路径。
  3. 生成成功的 md 文件，在项目的 md 文件夹中，文件名同您的 sql 文件名。

项目

项目结构

项目结构

代码

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
# -*- coding:utf-8 -*-
# Author : 我才是二亮 (unstring@163.com)
from os import error
import sys, os.path
from FileParserClass import FileParser
from MarkdownBuildClass import MarkDownBuild

if __name__ == '__main__':

    md_dir = './md/'

    content = ''
    file = ''
    if (len(sys.argv) < 2):
        exit('请输入SQL文件路径')

    dir = sys.argv[1]
    try:
        file = open(dir,encoding='utf-8')
        print (dir)
    except error:
        exit(error)
    try:
        content = file.read()
    except error:
        exit(error)
    finally:
        file.close()

    file_parser = FileParser()
    # 将文件分离为每张表
    table_list = file_parser.separatTable(content)
    # 解析出表中表名及表详情
    table_name = file_parser.parserTableName(table_list)
    # 解析出每张表字段情况并与表名表详情组合
    table_data = file_parser.parserColumn(table_list, table_name)

    markdown_build = MarkDownBuild()

    text = markdown_build.buildMarkdown(table_data)
    file_name = os.path.basename(dir).split('.')[0] + '.md'
    # 写文件
    file_obj = ''
    try:
        file_obj = open(md_dir + file_name, 'w',encoding='utf-8')
    except:
        exit('文件创建失败')

    try:
        file_obj.write(text)
    except:
        exit('文件写入失败')
    finally:
        file_obj.close()

    print ('数据库文档已经成功创建,文件在md目录下.')
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
# -*- coding:utf-8 -*-
import re
class FileParser:

    def __init__(self):
        pass


    # 定义分离SQL文件匹配模式
    # table_pattern = r'CREATE TABLE([\s\S]*?)LOCK TABLES'    #分离表
    table_pattern = r'CREATE TABLE([\s\S]*?);'
    name_pattern = r'.*?`(.*?)`.*?' # 获取表名称或字段名称
    table_content_pattern = r'COMMENT=\'(.*?)\''   #获取表详情

    def separatTable(self, content):
        '''将SQL文件中各个表分离开来
        :param content:文件内容
        :return:表分离后的内容
        '''
        pattren = re.compile(self.table_pattern)
        table_list = re.findall(pattren, content)
        return table_list

    def parserTableName(self, table_list):
        '''
        解析出数据库中所有表的表名
        列表中前者为表名,后者为表含义
        :param table_list:
        :return:
        '''
        dirty_table_name = []
        dirty_table_content = []
        table_name = []
        # 取出表名和表含义行脏数据
        for table in table_list:
            tmp = table.split('\n')
            dirty_table_name.append(tmp[0])
            dirty_table_content.append(tmp[-1])

        for i in range(len(dirty_table_name)):
            tmp = []
            # 从脏数据中取出表名
            # print dirty_table_name[i].strip()
            name = re.match(self.name_pattern, dirty_table_name[i].strip())
            if name != None:
                # print name.group(1)
                tmp.append(name.group(1))

            # 从脏数据中取出表含义
            content = re.match(self.table_content_pattern, dirty_table_content[i].split(' ')[-1])
            if content != None:
                tmp.append(content.group(1))
            else:
                tmp.append('')
            table_name.append(tmp)
        return table_name

    def parserColumn(self, table_list, table_name):
        '''
        获取字段情况
        :param table_list: separatTable中分离出的数据
        :param table_name: parserTableName中解析出的数据
        :return:
        '''
        dirty_column_list = []
        for table in table_list:
            dirty_column_list.append(table.split('\n')[1:-1])
        table_data = []

        for i in range(len(dirty_column_list)):
            dirty_column = []
            dirty_column = dirty_column_list[i]
            column_tmp = []
            '''
            先取两边空格
            用空格分割
            第一个有没有``,有取出来,无舍弃
            '''
            for column in dirty_column:
                tmp_list = column.strip().split(' ')
                column_name = re.match(r'`(.*?)`', tmp_list[0])
                if column_name != None:
                    column_name = column_name.group(1)
                    column_type = tmp_list[1]
                    # TODO:此处无法正确匹配,使用取列表最后一项,可能会有bug
                    column_comment = re.match(r'.*?COMMENT \'(.*?)\'.*?', column.strip())
                    if column_comment is not None:
                        column_comment = column_comment.group(1)
                    else:
                        column_comment = ''


                    # if '\'' in tmp_list[-1]:
                    #     column_comment = tmp_list[-1][1:-2]
                    # else:
                    #     column_comment = ''
                    column_tmp.append([column_name, column_type, column_comment])
            table_data.append([table_name[i], column_tmp])
        return table_data
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# -*- coding:utf-8 -*-
class MarkDownBuild:

    table_header = '|字段名称|字段类型|字段含义|\n|:---:|:---:|:---:|\n'
    table_content_template = '|%s|%s|%s|\n'

    def __init__(self):
        pass

    def buildMarkdown(self, table_data):
        text = '# 数据库文档\n\n'
        text += '<a name="返回顶部"></a>\n\n## 数据表列表\n\n'
        for table in table_data:
            text = text + '* [' + table[0][0] + '(' + table[0][1] + ')](#' + table[0][0] + '_pointer)\n\n'
        text += '\n\n## 数据表说明\n\n'
        for table in table_data:
            text = text + '<a name="'+table[0][0]+'_pointer"></a>\n\n'
            text = text + '* ' + table[0][0] + '表(' + table[0][1] + ')[↑](#返回顶部)\n\n'
            text += self.table_header
            for column in table[1]:
                text = text + '|' + column[0] + '|' + column[1] + '|' + column[2] + '|\n'
            text += '\n'
        return text
相关文章