Merge pull request #4 from qidi1/change_path

rename src to sql_parser

Author: qidi1

README.md

@@ -11,21 +11,21 @@ pip install sqlgpt-parser
 ### Parser SQL
 
 ```python
->>> from sql_parser.mysql_parser import parser as mysql_parser
+>>> from sqlgpt_parser.sql_parser.mysql_parser import parser as mysql_parser
 >>> mysql_parser.parse("select * from t")
 Query(query_body=QuerySpecification(select=Select(distinct=False, select_items=[SingleColumn(expression=QualifiedNameReference(name=QualifiedName.of("*")))]), from_=Table(name=QualifiedName.of("t"), for_update=False), order_by=[], limit=0, offset=0, for_update=False, nowait_or_wait=False), order_by=[], limit=0, offset=0)
->>> from sql_parser.oceanbase_parser import parser as oceanbase_parser
+>>> from sqlgpt_parser.sql_parser.oceanbase_parser import parser as oceanbase_parser
 >>> oceanbase_parser.parse("select * from t")
 Query(query_body=QuerySpecification(select=Select(distinct=False, select_items=[SingleColumn(expression=QualifiedNameReference(name=QualifiedName.of("*")))]), from_=Table(name=QualifiedName.of("t"), for_update=False), order_by=[], limit=0, offset=0, for_update=False, nowait_or_wait=False), order_by=[], limit=0, offset=0)
->>> from sql_parser.odps_parser import parser as odps_parser
+>>> from sqlgpt_parser.sql_parser.odps_parser import parser as odps_parser
 >>> odps_parser.parse("select * from t")
 Query(query_body=QuerySpecification(select=Select(distinct=False, select_items=[SingleColumn(expression=QualifiedNameReference(name=QualifiedName.of("*")))]), from_=Table(name=QualifiedName.of("t"), for_update=False), order_by=[], limit=0, offset=0, for_update=False, nowait_or_wait=False), order_by=[], limit=0, offset=0)
 ```
 
 ### Format SQL
 ```python
->>> from sql_parser.format.formatter import format_sql
->>> from sql_parser.mysql_parser import parser
+>>> from sqlgpt_parser.format.formatter import format_sql
+>>> from sqlgpt_parser.mysql_parser import parser
 >>> result=parser.parse("select * from t")
 >>> format_sql(result)
 'SELECT\n  *\nFROM\n  t'

docs/docs-ch/Parser Module Development Guide.md

@@ -245,8 +245,9 @@ The comment in `p_delete` corresponds to the syntax rule for the `DELETE` statem
 Once the grammar rules are written, they can be used to parse SQL statements. Taking `mysql_parser` as an example, you can use this grammar rule for parsing SQL statements.
 
 ```python
-from src.parser.mysql_parser.parser import parser as mysql_parser
-from src.parser.mysql_parser.lexer import lexer as mysql_lexer
+from sqlgpt_parser.parser.mysql_parser.parser import parser as mysql_parser
+from sqlgpt_parser.parser.mysql_parser.lexer import lexer as mysql_lexer
+
 sql = "DELETE FROM t WHERE a=1"
 result = mysql_parser.parse(sql, lexer=mysql_lexer)
 ```

docs/docs-ch/SQL Parser 开发指南.md

@@ -2,7 +2,7 @@
 
 `parser` 是 `sqlgpt-parser` 的基础模块，它将 SQL 语句按照预定义 SQL 语法规则解析，从文本转换成抽象语法树（`AST`）。
 
- `sqlgpt-parser` 的 `parser`  基于  [PLY](https://github.com/dabeaz/ply)  编写。PLY 是一个用于构建词法和语法分析器的 Python 工具。它能够根据指定的模式对输入的文本进行分析，它会在程序运行之前，自动编译项目 [sql-parser](../../src/sql_parser/)  文件夹下的词法规则和语法规则文件，生成可执行代码。
+ `sqlgpt-parser` 的 `parser`  基于  [PLY](https://github.com/dabeaz/ply)  编写。PLY 是一个用于构建词法和语法分析器的 Python 工具。它能够根据指定的模式对输入的文本进行分析，它会在程序运行之前，自动编译项目 [sql-parser](../../sqlgpt_parser/sql_parser/)  文件夹下的词法规则和语法规则文件，生成可执行代码。
 
 ## 词法解析与语法解析
 
@@ -161,7 +161,7 @@ def p_expr_paren(p):
 
 ## `sqlgpt-parser`的 `parser` 实现
 
-`sqlgpt-parser` 中共有三个 SQL  语法解析器 ，分别在  [mysql_parser](../../src/sql_parser/mysql_parser)、 [oceanbase_parser](../../src/sql_parser/oceanbase_parser) 和  [odps_parser](../../src/sql_parser/odps_parser) 文件夹下，三个文件夹都包含`lexer.py`，`reserved.py`，`parser.py` 三个文件。
+`sqlgpt-parser` 中共有三个 SQL  语法解析器 ，分别在  [mysql_parser](../../sqlgpt_parser/sql_parser/mysql_parser)、 [oceanbase_parser](../../sqlgpt_parser/sql_parser/oceanbase_parser) 和  [odps_parser](../../sqlgpt_parser/sql_parser/odps_parser) 文件夹下，三个文件夹都包含`lexer.py`，`reserved.py`，`parser.py` 三个文件。
 
 `lexer.py` 和`reserved.py` 文件都用于词法解析。`reserved.py` 中定义了 SQL 的关键字，关键字定义在`reserved` 和 `nonreserved` 两个变量中 ，`reserved` 里面包含了所有 `sql` 中不可用作列名、表名或者别名的关键字，`nonreserved` 则是可以用作列名、表名或者别名的关键字。
 
@@ -260,7 +260,8 @@ def p_delete(p):
 完成语法规则的编写后就可以使用，该语法规则解析 `SQL` 语句，以 `mysql_parser` 为例。
 
 ```python
-from src.sql_parser.mysql_parser import parser as mysql_parser
+from sqlgpt_parser.sql_parser.mysql_parser import parser as mysql_parser
+
 sql = "DELETE FROM t WHERE a=1"
 result = mysql_parser.parse(sql)
 ```

docs/docs-en/SQL Parser Development Guide.md

@@ -2,7 +2,7 @@
 
 The `parser` module is the foundational module of `sqlgpt-parser`. It parses SQL statements according to predefined SQL grammar rules, converting them from text into an abstract syntax tree (`AST`).
 
-The `parser` module in `sqlgpt-parser` is written using [PLY](https://github.com/dabeaz/ply). PLY is a Python tool for building lexical and parsing analyzers. It can analyze input text based on specified patterns and automatically compile the lexical and grammar rule files in the [sql-parser](../../src/sql_parser/) folder of the project before the program runs, generating executable code.
+The `parser` module in `sqlgpt-parser` is written using [PLY](https://github.com/dabeaz/ply). PLY is a Python tool for building lexical and parsing analyzers. It can analyze input text based on specified patterns and automatically compile the lexical and grammar rule files in the [sql-parser](../../sqlgpt_parser/sql_parser/) folder of the project before the program runs, generating executable code.
 
 ## Lexical Analysis and Syntax Analysis
 
@@ -158,7 +158,7 @@ PLY uses the notation `p[position]` to access the stack, where `p[0]` correspond
 
 ## Implementation of the `parser` for `sqlgpt-parser`
 
-There are a total of three SQL parsers in `sqlgpt-parser`, located in the [mysql_parser](../../src/sql_parser/mysql_parser), [oceanbase_parser](../../src/sql_parser/oceanbase_parser), and [odps_parser](../../src/sql_parser/odps_parser) folders. Each of these folders contains three files: `lexer.py`, `reserved.py`, and `parser.py`.
+There are a total of three SQL parsers in `sqlgpt-parser`, located in the [mysql_parser](../../sqlgpt_parser/sql_parser/mysql_parser), [oceanbase_parser](../../sqlgpt_parser/sql_parser/oceanbase_parser), and [odps_parser](../../sqlgpt_parser/sql_parser/odps_parser) folders. Each of these folders contains three files: `lexer.py`, `reserved.py`, and `parser.py`.
 
 The `lexer.py` and `reserved.py` files are both used for lexical analysis. In `reserved.py`, SQL keywords are defined and stored in two variables: `reserved` and `nonreserved`. The `reserved` variable contains all the keywords that cannot be used as column names, table names, or aliases in SQL. On the other hand, `nonreserved` contains keywords that can be used as column names, table names, or aliases.
 
@@ -245,7 +245,8 @@ The comment in `p_delete` corresponds to the syntax rule for the `DELETE` statem
 Once the grammar rules are written, they can be used to parse SQL statements. Taking `mysql_parser` as an example, you can use this grammar rule for parsing SQL statements.
 
 ```python
-from src.sql_parser.mysql_parser import parser as mysql_parser
+from sqlgpt_parser.sql_parser.mysql_parser import parser as mysql_parser
+
 sql = "DELETE FROM t WHERE a=1"
 result = mysql_parser.parse(sql)
 ```

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "sqlgpt-parser"
-version = "0.0.1a1"
+version = "0.0.1a2"
 authors = [
   { name="luliwjc", email="[email protected]" },
   { name="Ifffff", email="[email protected]" },
@@ -24,8 +24,6 @@ dependencies = [
     "ply == 3.11",
 ]
 
-[tool.flit.module]
-name = "sql_parser"
 [project.urls]
 "Homepage" = "https://github.com/eosphoros-ai/sqlgpt-parser"
 "Bug Tracker" = "https://github.com/eosphoros-ai/sqlgpt-parser/issues"

sqlgpt_parser/__init__.py

@@ -9,13 +9,13 @@
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 """
-from src.sql_parser.tree import JsonTableColumn
-from src.sql_parser.tree.explain import ExplainFormat, ExplainType
-from src.sql_parser.tree.grouping import SimpleGroupBy
-from src.sql_parser.tree.join_criteria import JoinOn, JoinUsing, NaturalJoin
-from src.sql_parser.tree.table import Table, TableSubquery
-from src.sql_parser.tree.visitor import AstVisitor
-from src.sql_parser.parser_utils import FIELD_REFERENCE_PREFIX
+from sqlgpt_parser.sql_parser.tree import JsonTableColumn
+from sqlgpt_parser.sql_parser.tree.explain import ExplainFormat, ExplainType
+from sqlgpt_parser.sql_parser.tree.grouping import SimpleGroupBy
+from sqlgpt_parser.sql_parser.tree.join_criteria import JoinOn, JoinUsing, NaturalJoin
+from sqlgpt_parser.sql_parser.tree.table import Table, TableSubquery
+from sqlgpt_parser.sql_parser.tree.visitor import AstVisitor
+from sqlgpt_parser.sql_parser.parser_utils import FIELD_REFERENCE_PREFIX
 
 
 class Formatter(AstVisitor):

sqlgpt_parser/format/__init__.py

@@ -9,7 +9,4 @@
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 """
-
-import sys
-
-sys.path.insert(0, '..')
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)