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實體化，以防止瀏覽器解析。