python的sql解析库-sqlparse

sqlparse 是一个 Python 库，是一个用于 Python 的非验证 SQL 解析器, 用于解析 SQL 语句并提供一个简单的 API 来访问解析后的 SQL 结构。可以资助解析复杂的 SQL 查询，提取信息，大概对 SQL 语句进行一些基本的分析和操纵。
  一、基本方法:

sqlparse的__init__方法中提供了四个基础方法
1.parse(sql)

用于将一个或多个 SQL 语句的字符串解析成 Python 对象，这些对象构成了一个抽象语法树（AST）
源码

1. def parse(sql, encoding=None):
2.     """Parse sql and return a list of statements.
4.     :param sql: A string containing one or more SQL statements.
5.     :param encoding: The encoding of the statement (optional).
6.     :returns: A tuple of :class:`~sqlparse.sql.Statement` instances.
7.     """
8.     return tuple(parsestream(sql, encoding))

复制代码

按照符号分割sql后返回一个元组, 可以递归获取所有的值

1. import sqlparse
3. SQL = """CREATE TABLE foo (
4.                  id integer primary key comment 'id_comm',
5.                  title varchar(200) not null comment 'id_comm',
6.                  description text comment 'id_comm');"""
8. parsed = sqlparse.parse(SQL)[0]
10. print(parsed)

复制代码

2.format(sql)

格式化代码, 返回格式化后的代码字符串
源码:

1. def format(sql, encoding=None, **options):
2.     """Format *sql* according to *options*.
4.     Available options are documented in :ref:`formatting`.
6.     In addition to the formatting options this function accepts the
7.     keyword "encoding" which determines the encoding of the statement.
9.     :returns: The formatted SQL statement as string.
10.     """

复制代码

参数说明:

• sql: 需要格式化的 SQL 语句字符串。
  
• reindent=True: 自动重新缩进 SQL 语句，使代码块对齐。
  
• keyword_case=‘upper’: 将 SQL 关键字转换为大写。可选值有’lower’、‘upper’ 或 ‘capitalize’。
  
• 其他可选参数还包括 indent_width（用于设置缩进的空格数，默认为 2）、wrap_after（设置换行的字符数限定）等，以进一步定制输出样式。
  

1. import sqlparse
3. sql = """select * from tbl where id > 10;"""
5. format = sqlparse.format(sql, reindent=True, keyword_case='upper')
7. print(format)
9. # SELECT *
10. # FROM tbl
11. # WHERE id > 10;

复制代码

3.split()

按照符号分割sql语句, 返回一个sql列表
源码:

1. def split(sql, encoding=None):
2.     """Split *sql* into single statements.
4.     :param sql: A string containing one or more SQL statements.
5.     :param encoding: The encoding of the statement (optional).
6.     :returns: A list of strings.
7.     """

复制代码

1. import sqlparse
3. sql = """select * from tbl where id > 10;select * from tbl where id > 20;"""
5. split = sqlparse.split(sql)
7. print(split)
8. # ['select * from tbl where id > 10;', 'select * from tbl where id > 20;']

复制代码

4.parsestream()

类似parse方法, 流式解析sql, 它的计划初志是为了处理从流式输入（如文件、网络连接或任何可迭代的对象）读取的 SQL 代码，而不是一次性加载整个 SQL 字符串到内存中。如许，在处理大型 SQL 文件或连续的数据流时，可以更有效地管理内存。
源码:

1. def parsestream(stream, encoding=None):
2.     """Parses sql statements from file-like object.
4.     :param stream: A file-like object.
5.     :param encoding: The encoding of the stream contents (optional).
6.     :returns: A generator of :class:`~sqlparse.sql.Statement` instances.
7.     """

复制代码

1. with open('../static/pre_sql.sql', 'r', encoding='utf-8') as file:
2.     for statement in sqlparse.parse(file):
3.         print(statement)

复制代码

二、Token

源码:

1. class Token:
2.     """Base class for all other classes in this module.
4.     It represents a single token and has two instance attributes:
5.     ``value`` is the unchanged value of the token and ``ttype`` is
6.     the type of the token.
7.     """
8.    
9.     def __init__(self, ttype, value):
10.     value = str(value)
11.     self.value = value
12.     self.ttype = ttype
13.     self.parent = None
14.     self.is_group = False
15.     self.is_keyword = ttype in T.Keyword
16.     self.is_whitespace = self.ttype in T.Whitespace
17.     self.normalized = value.upper() if self.is_keyword else value

复制代码

sqlparse.sql.Token: 这是最基本的Token类，表示SQL语句中的一个原子部门，如一个单词大概符号。它包含以部属性：

• value: 该Token的实际文本内容，好比一个关键字像SELECT或一个标识符如表名。
  
• token_type: 表示Token类型的枚举值，好比Keyword、Identifier、Punctuation等。
  
• position 或 start_pos: 表示Token在原始SQL文本中的起始位置信息，有助于追踪Token的来源。
  相干Token子类和概念
  
• sqlparse.sql.Identifier: 专门表示SQL中的标识符，如表名、列名等。这类Token可能会有额外的属性来表示是否为 quoted identifier（被引号困绕的标识符）。
  
• sqlparse.sql.Keyword: 表示SQL关键字，如SELECT, FROM, WHERE等。
  
• sqlparse.sql.Punctuation: 表示SQL中的标点符号，如逗号,、分号;等。
  
• sqlparse.sql.Comment: 用于表示SQL中的解释内容，可以是行内解释（-- …）或块解释（/* … */）。
  
• sqlparse.sql.Comparison: 包含比力操纵符（如=, !=, IN, BETWEEN等）以及它们双方的操纵数，用于构建更复杂的表达式分析。
  
• sqlparse.sql.Statement: 表示整个SQL语句，通常是由多个Token和其他Statement对象构成的树状结构，便于递归遍历整个SQL语句的结构。
  这里就需要引入sql解析的过程
  

   sql -> 语法分析器(Lexer) -> Token流 -> 语法分析器(Parse) -> 抽象语法树(AST) -> 树结构(Tree Parse)
  每个解析结果都会附带一个tokens 的属性，它是一个生成器，用于迭代解析后的Token序列, 包含了一些类型信息, 其中的类型信息有:

1. # Special token types
2. Text = Token.Text
3. Whitespace = Text.Whitespace
4. Newline = Whitespace.Newline
5. Error = Token.Error
6. # Text that doesn't belong to this lexer (e.g. HTML in PHP)
7. Other = Token.Other
9. # Common token types for source code
10. Keyword = Token.Keyword
11. Name = Token.Name
12. Literal = Token.Literal
13. String = Literal.String
14. Number = Literal.Number
15. Punctuation = Token.Punctuation
16. Operator = Token.Operator
17. Comparison = Operator.Comparison
18. Wildcard = Token.Wildcard
19. Comment = Token.Comment
20. Assignment = Token.Assignment
22. # Generic types for non-source code
23. Generic = Token.Generic
24. Command = Generic.Command
26. # String and some others are not direct children of Token.
27. # alias them:
28. Token.Token = Token
29. Token.String = String
30. Token.Number = Number
32. # SQL specific tokens
33. DML = Keyword.DML
34. DDL = Keyword.DDL
35. CTE = Keyword.CTE

复制代码

1. Text: 基础文本类型，通常用于表示SQL语句中的普通文本部分。
2.     Whitespace: 空白字符，包括空格、制表符等，用于分隔SQL语句的不同部分。
3.         Newline: 特指换行符，用于标识新的一行开始。
4.     Error: 表示解析过程中遇到的无法识别或错误的文本。
5.     Other: 表示不属于当前解析器（如SQL解析器）预期的文本，例如在嵌入式SQL中可能遇到的其他语言（如HTML在PHP中的情况）。
6. Keyword: SQL关键字，如 SELECT, FROM, WHERE 等。
7.     DML: 数据操作语言（Data Manipulation Language）关键字，如 INSERT, UPDATE, DELETE, SELECT。
8.     DDL: 数据定义语言（Data Definition Language）关键字，如 CREATE, ALTER, DROP。
9.     CTE: 公共表达式（Common Table Expression）关键字，如 WITH。
10. Name: 数据库对象名称，如表名、列名等。
11. Literal: 字面量值，直接写在SQL中的数据值。
12.     String: 字符串字面量，如 'example string'。
13.     Number: 数字字面量，如 42, 3.14。
14. Punctuation: 标点符号，如逗号、括号等，用于分隔或包围SQL的各个部分。
15. Operator: 操作符，如 +, -, *, /, = 等。
16.     Comparison: 比较操作符，如 =, !=, <, > 等。
17. Wildcard: 通配符，如 % 在某些SQL上下文中的使用。
18. Comment: 注释，SQL中的单行或多行注释。
19. Assignment: 赋值操作符，如 := 在某些SQL方言中用于赋值。
20. Generic: 通用类型，适用于非特定源代码的分隔。
21.     Command: 命令，可能特指一些SQL命令或交互式shell命令。

复制代码

1. Whitespace：空白字符（如空格、制表符、换行符等）
2. Keyword：SQL 关键字（如 SELECT、FROM、WHERE 等）
3. Name：标识符（如表名、列名等）
4. String.Single：单引号字符串字面量
5. String.Double：双引号字符串字面量（在某些 SQL 方言中用于标识符）
6. String.Backtick：反引号字符串字面量（如 MySQL 中的表名和列名）
7. Identifier: 表示SQL中的标识符，包括但不限于表名、列名、数据库名等。
8. Compound: 复合Token，可能包含多个子Token，用于更复杂的结构，如 Case 语句、 When 条件等。
9. Number.Integer：整数
10. Number.Float：浮点数
11. Number.Hex：十六进制数
12. Operator：操作符（如 =、<>、+、- 等）
13. Punctuation：标点符号（如逗号、分号、括号等）
14. Comment.Single：单行注释
15. Comment.Multiline：多行注释
16. Wildcard：通配符（如 *）
17. Function：函数名（如 COUNT()、MAX() 等）
18. DML、DDL、DCL 等：表示数据操作语言、数据定义语言、数据控制语言等的高级分类

复制代码

三、其他类型

有些属于token的属性
但有些不属于token, 好比Where、IdentifierList、Identifier、Parenthesis、Comment等

1. sql = 'select 1 as id, name, case when name = "" then 3 else 4 end as score from tbl where id > 10 limit 100'
3. stmts = sqlparse.parse(sql)[0].tokens
5. for stmt in stmts:
7.     print(f"{type(stmt)}::{stmt.ttype}::",stmt)
8. # <class 'sqlparse.sql.Token'>::Token.Keyword.DML:: select
9. # <class 'sqlparse.sql.Token'>::Token.Text.Whitespace::  
10. # <class 'sqlparse.sql.IdentifierList'>::None:: 1 as id, name, case when name = "" then 3 else 4 end as score
11. # <class 'sqlparse.sql.Token'>::Token.Text.Whitespace::  
12. # <class 'sqlparse.sql.Token'>::Token.Keyword:: from
13. # <class 'sqlparse.sql.Token'>::Token.Text.Whitespace::  
14. # <class 'sqlparse.sql.Identifier'>::None:: tbl
15. # <class 'sqlparse.sql.Token'>::Token.Text.Whitespace::  
16. # <class 'sqlparse.sql.Where'>::None:: where id > 10
17. # <class 'sqlparse.sql.Token'>::Token.Keyword:: limit
18. # <class 'sqlparse.sql.Token'>::Token.Text.Whitespace::  
19. # <class 'sqlparse.sql.Token'>::Token.Literal.Number.Integer:: 100

复制代码

  当查询有多列大概有多表时, 会将其封装为IdentifierList, 单表时候会被封装为Identifier, 过滤条件被封装为Where, 括号会被封装为Parenthesis, 解释会被封装为Comment
  四、案例: 提取所有查询的字段和表名

1. import sqlparse
2. import re
4. sql = 'insert into table inser_tbl partition (dt = dt) select 1 as id, name, case when （name = "" or name = "") then 3 else 4 end as score from tbl where id > 10 limit 100'
6. stmts = sqlparse.parse(sql)[0].tokens
8. cols = []
9. tbls = []
10. froms = []
11. wheres = []
12. last_key = ''
13. for stmt in stmts:
14.     if stmt.value == 'insert' or stmt.value == 'select' or stmt.value == 'from':
15.         last_key = stmt.value
16.     # 剔除空格和换行
17.     if stmt.ttype is sqlparse.tokens.Text.Whitespace:
18.         continue
19.     # 关键字
20.     elif stmt.ttype is sqlparse.tokens.Keyword.DML:
21.         dml = stmt.value
22.         last_key = dml
23.     # 字段
24.     elif isinstance(stmt, sqlparse.sql.IdentifierList):
25.         # 判断上一个是什么类型
26.         if last_key == 'select':
27.             for identifier in stmt.get_identifiers():
28.                 col_name = identifier.value
29.                 if re.search('as', col_name, re.I):
30.                     col_name = re.search('as (.*)', col_name, re.I).group(1).strip()
31.                 cols.append(col_name)
32.         elif last_key == 'from':
33.             for identifier in stmt.get_identifiers():
34.                 froms.append(identifier.value)
35.         else:
36.             for identifier in stmt.get_identifiers():
37.                 tbls.append(identifier.value)
38.     elif isinstance(stmt, sqlparse.sql.Identifier):
39.         if last_key == 'select':
40.             cols.append(stmt.value)
41.         elif last_key == 'from':
42.             froms.append(stmt.value)
43.         else:
44.             tbls.append(stmt.value)
45.     elif isinstance(stmt, sqlparse.sql.Where):
46.         wheres.append(stmt.value)
47.     # 表名
48. print("cols:", cols)
49. print("tbls:", tbls)
50. print("froms:", froms)
51. print("wheres:", wheres)
53. # cols: ['id', 'name', 'score']
54. # tbls: ['inser_tbl']
55. # froms: ['tbl']
56. # wheres: ['where id > 10 ']

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。