Python SQL解析库sqlparse详解

一、简介

sqlparse是一个基于Python的SQL解析库，可以将SQL语句解析为Python语法树。它支持大部分常用的SQL语句（SELECT, INSERT, UPDATE, DELETE, CREATE等），并能够解析SQL语句的各个部分（语句头、表名、列名、值等）。

sqlparse可以作为其他Python程序的组件，用于解析和分析SQL语句，也可以作为SQL编辑器的插件，实现SQL语法高亮和格式化等功能。

import sqlparse

sql = 'SELECT * FROM students WHERE age > 18'
parsed = sqlparse.parse(sql)
stmt = parsed[0]

print(stmt.tokens)

二、SQL解析

1. 解析SQL语句

使用sqlparse.parse()函数可以将SQL语句解析为Python语法树，返回一个语句列表（可能包含多个语句）。

解析出来的语法树是一个有层次结构的对象，可以通过遍历语法树来获取语句中的各个部分。

import sqlparse

sql = 'SELECT * FROM students WHERE age > 18'
parsed = sqlparse.parse(sql)
stmt = parsed[0]

print(stmt)
print(type(stmt))

2. 获取语法结构

sqlparse可以将SQL语句解析为各个语法结构（Keyword、Identifier、Whitespace、Punctuation等），可以通过遍历语法树来获取语句中的各个语法结构。

import sqlparse

sql = 'SELECT * FROM students WHERE age > 18'
parsed = sqlparse.parse(sql)
stmt = parsed[0]

for token in stmt.tokens:
    print(type(token), token)

3. 获取语句头

SQL语句的语句头包含关键字（如SELECT、INSERT、UPDATE、DELETE）和语法结构（如表名、列名、条件等），可以通过语法树来获取语句头的各个部分。

import sqlparse

sql = 'SELECT * FROM students WHERE age > 18'
parsed = sqlparse.parse(sql)
stmt = parsed[0]
header = stmt.tokens[:6]

for token in header:
    print(token)

4. 获取表名、列名、值等

通过遍历语法树，可以获取SQL语句中的各个部分，如表名、列名、值等。

import sqlparse

sql = 'INSERT INTO students (id, name, age) VALUES (1, "Alice", 20)'
parsed = sqlparse.parse(sql)
stmt = parsed[0]

table = stmt.tokens[2]
columns = stmt.tokens[4].tokens[1::2]
values = stmt.tokens[6].tokens[1::2]

print(table)
print(columns)
print(values)

三、SQL格式化

除了可以解析SQL语句外，sqlparse还支持将SQL语句格式化为易于阅读的形式，包括缩进、大小写、空格等。

import sqlparse

sql = 'SELECT * FROM students WHERE age > 18'
formatted = sqlparse.format(sql, keyword_case='upper', indent_width=4)

print(formatted)

四、SQL语法高亮

sqlparse支持将SQL语句转换为HTML代码，并添加语法高亮等样式。

import sqlparse

sql = 'SELECT * FROM students WHERE age > 18'
html = sqlparse.format(sql, reindent=True, formatter=sqlparse.formatter.HTMLFormatter())

print(html)

需要注意的是，由于生成的代码中可能包含HTML标签，需要进行HTML实体化，以防止浏览器解析。