MySQLX 2.2.9__tar.gz → 2.3.1__tar.gz

{MySQLX-2.2.9 → MySQLX-2.3.1/MySQLX.egg-info}/PKG-INFO

@@ -1,16 +1,16 @@
 Metadata-Version: 2.1
 Name: MySQLX
-Version: 2.2.9
+Version: 2.3.1
 Summary: A thread safe sql executor for MySQL like MyBatis with connection pool. It helps you automatically manage database connections and transactions.
 Home-page: https://gitee.com/summry/mysqlx
 Author: summy
 Author-email: xiazhongbiao@126.com
-License: UNKNOWN
 Keywords: sql,MySQL,MyBatis,python
-Platform: UNKNOWN
 Requires-Python: >=3.5
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: Jinja2>=2.7.0
+Requires-Dist: sqlexecx>=2.2.4
 
 Mapper file
 '''''''''''
@@ -177,5 +177,3 @@ If you want to operate PostgreSQL database, may be you need PgSQLX: https://pypi
 If you just wanted a simple sql executor, may be you need SQLExecX: https://pypi.org/project/sqlexecx
 
 If you wanted simultaneously support MySQL and PostgreSQL, may be you need BatisX: https://pypi.org/project/batisx
-
-

MySQLX-2.3.1/MySQLX.egg-info/requires.txt

@@ -0,0 +1,2 @@
+Jinja2>=2.7.0
+sqlexecx>=2.2.4

{MySQLX-2.2.9/MySQLX.egg-info → MySQLX-2.3.1}/PKG-INFO

@@ -1,16 +1,16 @@
 Metadata-Version: 2.1
 Name: MySQLX
-Version: 2.2.9
+Version: 2.3.1
 Summary: A thread safe sql executor for MySQL like MyBatis with connection pool. It helps you automatically manage database connections and transactions.
 Home-page: https://gitee.com/summry/mysqlx
 Author: summy
 Author-email: xiazhongbiao@126.com
-License: UNKNOWN
 Keywords: sql,MySQL,MyBatis,python
-Platform: UNKNOWN
 Requires-Python: >=3.5
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: Jinja2>=2.7.0
+Requires-Dist: sqlexecx>=2.2.4
 
 Mapper file
 '''''''''''
@@ -177,5 +177,3 @@ If you want to operate PostgreSQL database, may be you need PgSQLX: https://pypi
 If you just wanted a simple sql executor, may be you need SQLExecX: https://pypi.org/project/sqlexecx
 
 If you wanted simultaneously support MySQL and PostgreSQL, may be you need BatisX: https://pypi.org/project/batisx
-
-

MySQLX-2.3.1/mysqlx/__init__.py

@@ -0,0 +1,75 @@
+"""
+可以设置`SQL_CACHE_SIZE`环境变量来设置缓存大小，默认是128。
+linux or macos:
+export SQL_CACHE_SIZE=256
+windows:
+set SQL_CACHE_SIZE=256
+
+可以设置`LRU_CACHE_SIZE`环境变量来设置缓存大小，默认是64。
+linux or macos:
+export LRU_CACHE_SIZE=128
+windows:
+set LRU_CACHE_SIZE=128
+"""
+
+from sqlexecx import (
+    conn,
+    trans,
+    get_connection,
+    close,
+    Driver,
+    Dialect,
+    Engine,
+    init as _init
+)
+
+from .support import InitArgs
+from .log_support import logger
+from .sql_mapper import sql, mapper
+
+
+def init_db(*args, **kwargs) -> Engine:
+    """
+    Compliant with the Python DB API 2.0 (PEP-249).
+
+    Addition parameters:
+    - mapper_path: str, path of mapper files
+    - driver=None: str|Driver, 'psycopg2' or 'pymysql' or 'mysql.connector' or 'sqlite3' or 'turso'
+    - pool_size=0: int, default 0, size of connection pool
+    - show_sql=False: bool,  if True, print sql
+    - debug=False: bool, if True, print debug context
+
+    Other parameters of connection pool refer to DBUtils: https://webwareforpython.github.io/DBUtils/main.html#pooleddb-pooled-db
+
+    Examples
+    --------
+    >>> from mysqlx import db, trans, init_db
+    >>> init_db('db.sqlite3', mapper_path='./mapper', driver='sqlite3', debug=True)
+    Engine.SQLITE
+    >>> init_db(user='root', password='xxx', host='127.0.0.1', port=3306, database='testdb', driver='pymysql', mapper_path='./mapper')
+    Engine.MYSQL
+    """
+    from .sql_holder import load_mapper
+
+    # Dialect.init(Engine.MYSQL) 
+    mapper_path = kwargs.pop(InitArgs.MAPPER_PATH) if InitArgs.MAPPER_PATH in kwargs else None
+    engine = _init(*args, **kwargs)
+    assert engine in (Engine.MYSQL, Engine.SQLITE, Engine.TURSO)
+    if mapper_path:
+        load_mapper(mapper_path)
+    return engine
+
+
+__all__ = [
+    'conn',
+    'trans',
+    'get_connection',
+    'close',
+    'Driver',
+    'Dialect',
+    'Engine',
+    'init_db',
+    'sql',
+    'mapper'
+]
+    

{MySQLX-2.2.9 → MySQLX-2.3.1}/mysqlx/db.py

@@ -1,12 +1,13 @@
-from typing import List, Tuple
+from typing import List, Tuple, Any
 from . import sql_support
 # Don't remove. Import for not repetitive implementation
 from sqlexecx import insert, save, batch_insert, batch_execute, do_execute, do_save_sql, do_get, do_query,\
     do_query_one, do_select, do_select_one, do_select_page, do_query_page, do_select_page, do_query_page, \
-    load, do_load, insert_from_csv, insert_from_df, insert_from_json, truncate_table, drop_table, table
+    load, do_load, insert_from_csv, insert_from_df, insert_from_json, truncate_table, drop_table, table, \
+    do_select_first, do_query_first
 
 
-def execute(sql: str, *args, **kwargs):
+def execute(sql: str, *args, **kwargs) -> int:
     """
     Execute sql return effect rowcount
 
@@ -24,7 +25,7 @@ def execute(sql: str, *args, **kwargs):
     return do_execute(sql, *args)
 
 
-def get(sql: str, *args, **kwargs):
+def get(sql: str, *args, **kwargs) -> Any:
     """
     Execute select SQL and expected one int and only one int result, SQL contain 'limit'.
 
@@ -80,6 +81,24 @@ def query_one(sql: str, *args, **kwargs) -> dict:
     return do_query_one(sql, *args)
 
 
+def query_first(sql: str, *args, **kwargs) -> dict:
+    """
+    Execute select SQL and return first result(dict).
+
+    Examples
+    --------
+    >>> from mysqlx import db
+    >>> sql = 'SELECT id, name, age FROM person WHERE name=?'
+    >>> db.query_first(sql, '张三')
+    {'id': 3, 'name': '张三', 'age': 20}
+    >>> sql = 'SELECT id, name, age FROM person WHERE name=:name'
+    >>> db.query_first(sql, name='张三')
+    {'id': 3, 'name': '张三', 'age': 20}
+    """
+    sql, args = sql_support.try_dynamic_sql('MySQLX.db.query_first', sql, *args, **kwargs)
+    return do_query_first(sql, *args)
+
+
 def select(sql: str, *args, **kwargs) -> List[Tuple]:
     """
     Execute select SQL and return list results(tuple).
@@ -116,6 +135,24 @@ def select_one(sql: str, *args, **kwargs) -> Tuple:
     return do_select_one(sql, *args)
 
 
+def select_first(sql: str, *args, **kwargs) -> Tuple:
+    """
+    Execute select SQL and return first result(tuple).
+
+    Examples
+    --------
+    >>> from mysqlx import db
+    >>> sql = 'SELECT id, name, age FROM person WHERE name=?'
+    >>> db.select_first(sql, '张三')
+    (3, '张三', 20)
+    >>> sql = 'SELECT id, name, age FROM person WHERE name=:name'
+    >>> db.select_first(sql, name='张三')
+    (3, '张三', 20)
+    """
+    sql, args = sql_support.try_dynamic_sql('MySQLX.db.select_first', sql, *args, **kwargs)
+    return do_select_first(sql, *args)
+
+
 def query_page(sql: str, page_num=1, page_size=10, *args, **kwargs) -> List[dict]:
     """
     Execute select SQL and return list or empty list if no result.

{MySQLX-2.2.9 → MySQLX-2.3.1}/mysqlx/dbx.py

@@ -1,10 +1,11 @@
+from typing import Any, List, Tuple
 from . import sql_holder as holder
 from .sql_support import get_batch_args
 from .log_support import logger, sql_id_log, page_sql_id_log
 from . import db
 
 
-def save(sql_id: str, *args, **kwargs):
+def save(sql_id: str, *args, **kwargs) -> Any:
     """
     Execute insert SQL, return primary key.
     :return: Primary key
@@ -14,7 +15,7 @@ def save(sql_id: str, *args, **kwargs):
     return db.do_save_sql(sql, *args)
 
 
-def execute(sql_id: str, *args, **kwargs):
+def execute(sql_id: str, *args, **kwargs) -> int:
     """
     Execute SQL.
     sql: INSERT INTO person(name, age) VALUES(?, ?)  -->  args: ('张三', 20)
@@ -24,7 +25,7 @@ def execute(sql_id: str, *args, **kwargs):
     return db.do_execute(sql, *args)
 
 
-def batch_execute(sql_id: str, *args):
+def batch_execute(sql_id: str, *args) -> int:
     """
     Batch execute
     sql: INSERT INTO person(name, age) VALUES(?, ?)  -->  args: [('张三', 20), ('李四', 28)]
@@ -39,7 +40,7 @@ def batch_execute(sql_id: str, *args):
 
 
 # ----------------------------------------------------------Query function------------------------------------------------------------------
-def get(sql_id: str, *args, **kwargs):
+def get(sql_id: str, *args, **kwargs) -> Any:
     """
     Execute select SQL and expected one int and only one int result. Automatically add 'limit ?' behind the sql statement if not.
     MultiColumnsError: Expect only one column.
@@ -50,7 +51,7 @@ def get(sql_id: str, *args, **kwargs):
     return db.do_get(sql, *args)
 
 
-def query(sql_id: str, *args, **kwargs):
+def query(sql_id: str, *args, **kwargs) -> List[dict]:
     """
     Execute select SQL and return list or empty list if no result.
     sql: SELECT * FROM person WHERE name=? and age=?  -->  args: ('张三', 20)
@@ -60,7 +61,7 @@ def query(sql_id: str, *args, **kwargs):
     return db.do_query(sql, *args)
 
 
-def query_one(sql_id: str, *args, **kwargs):
+def query_one(sql_id: str, *args, **kwargs) -> dict:
     """
     Execute select SQL and expected one row result(dict). Automatically add 'limit ?' behind the sql statement if not.
     If no result found, return None.
@@ -72,7 +73,18 @@ def query_one(sql_id: str, *args, **kwargs):
     return db.do_query_one(sql, *args)
 
 
-def select(sql_id: str, *args, **kwargs):
+def query_first(sql_id: str, *args, **kwargs) -> dict:
+    """
+    Execute select SQL and return first row result(dict).
+    If no result found, return None.
+    sql: SELECT * FROM person WHERE name=? -->  args: ('张三',)
+         SELECT * FROM person WHERE name=:name  -->  kwargs: {'name': '张三'}
+    """
+    sql, args = _get_sql_args_from_id('query_first', sql_id, *args, **kwargs)
+    return db.do_query_first(sql, *args)
+
+
+def select(sql_id: str, *args, **kwargs) -> List[Tuple]:
     """
     Execute select SQL and return list(tuple) or empty list if no result.
     sql: SELECT * FROM person WHERE name=? and age=?  -->  args: ('张三', 20)
@@ -82,7 +94,7 @@ def select(sql_id: str, *args, **kwargs):
     return db.do_select(sql, *args)
 
 
-def select_one(sql_id: str, *args, **kwargs):
+def select_one(sql_id: str, *args, **kwargs) -> Tuple:
     """
     Execute select SQL and expected one row result(tuple). Automatically add 'limit ?' behind the sql statement if not.
     If no result found, return None.
@@ -94,7 +106,18 @@ def select_one(sql_id: str, *args, **kwargs):
     return db.do_select_one(sql, *args)
 
 
-def query_page(sql_id: str, page_num=1, page_size=10, *args, **kwargs):
+def select_first(sql_id: str, *args, **kwargs) -> Tuple:
+    """
+    Execute select SQL and return first row result(tuple).
+    If no result found, return None.
+    sql: SELECT * FROM person WHERE name=?  -->  args: ('张三',)
+         SELECT * FROM person WHERE name=:name  -->  kwargs: {'name': '张三'}
+    """
+    sql, args = _get_sql_args_from_id('select_first', sql_id, *args, **kwargs)
+    return db.do_select_first(sql, *args)
+
+
+def query_page(sql_id: str, page_num=1, page_size=10, *args, **kwargs) -> List[dict]:
     """
     Execute select SQL and return list or empty list if no result. Automatically add 'limit ?,?' after sql statement if not.
     sql: SELECT * FROM person WHERE name=? and age=?  -->  args: ('张三', 20)
@@ -105,7 +128,7 @@ def query_page(sql_id: str, page_num=1, page_size=10, *args, **kwargs):
     return db.do_query_page(sql, page_num, page_size, *args)
 
 
-def select_page(sql_id: str, page_num=1, page_size=10, *args, **kwargs):
+def select_page(sql_id: str, page_num=1, page_size=10, *args, **kwargs) -> List[Tuple]:
     """
     Execute select SQL and return list or empty list if no result. Automatically add 'limit ?,?' after sql statement if not.
     sql: SELECT * FROM person WHERE name=? and age=?  -->  args: ('张三', 20)

{MySQLX-2.2.9 → MySQLX-2.3.1}/mysqlx/sql_holder.py

@@ -64,11 +64,11 @@ def do_get_sql(sql_model, batch, param_names, *args, **kwargs):
         return sql_model.sql, args
 
 
-def build_sql_id(namespace, _id):
+def build_sql_id(namespace, _id) -> str:
     return f'{namespace}.{_id}'
 
 
-def get_sql_model(sql_id: str):
+def get_sql_model(sql_id: str) -> SqlModel:
     global _SQL_CONTAINER
     return _SQL_CONTAINER[sql_id]
 

{MySQLX-2.2.9 → MySQLX-2.3.1}/mysqlx/sql_id_exec.py

@@ -1,3 +1,4 @@
+from typing import Any
 from . import dbx
 from sqlexecx.sql_exec import SqlExec
 from sqlexecx.page_exec import PageExec
@@ -5,7 +6,7 @@ from sqlexecx.page_exec import PageExec
 
 class SqlIdExec(SqlExec):
 
-    def save(self, *args, **kwargs):
+    def save(self, *args, **kwargs) -> Any:
         """
         Insert data into table, return primary key.
 
@@ -15,7 +16,7 @@ class SqlIdExec(SqlExec):
         return self.exec.save(self.sql, *args, **kwargs)
 
 
-def sql(sql_id: str):
+def sql(sql_id: str) -> SqlIdExec:
     """
     Get a SqlIdExec instance
 
@@ -29,7 +30,7 @@ def sql(sql_id: str):
     return SqlIdExec(dbx, sql_id)
 
 
-def page(page_num: int, page_size: int):
+def page(page_num: int, page_size: int) -> PageExec:
     """
     Get a PageExec instance
 

{MySQLX-2.2.9 → MySQLX-2.3.1}/mysqlx/sql_mapper.py

@@ -105,7 +105,7 @@ def get_select_func(func):
         return sqlexecx.do_query
 
 
-def before(func, namespace, _id, *args, **kwargs):
+def before(func, namespace, _id, *args, **kwargs) -> (str, str):
     file_name = os.path.basename(func.__code__.co_filename)[:-3]
     _namespace = namespace if namespace else file_name
     _id = _id if _id else func.__name__

{MySQLX-2.2.9 → MySQLX-2.3.1}/mysqlx/sql_page_exec.py

@@ -3,7 +3,7 @@ from sqlexecx.sql_exec import SqlExec
 from sqlexecx.page_exec import PageExec
 
 
-def sql(sql: str):
+def sql(sql: str) -> SqlExec:
     """
     Get a SqlExec instance
 
@@ -17,7 +17,7 @@ def sql(sql: str):
     return SqlExec(db, sql)
 
 
-def page(page_num: int, page_size: int):
+def page(page_num: int, page_size: int) -> PageExec:
     """
     Get a PageExec instance
 

{MySQLX-2.2.9 → MySQLX-2.3.1}/mysqlx/sql_support.py

@@ -8,7 +8,6 @@ from .constant import DYNAMIC_REGEX, SQL_CACHE_SIZE
 from sqlexecx.sql_support import get_named_sql_args, is_mapping, get_mapping_sql_args, try_mapping, get_batch_args
 
 sql_cache_size = int(os.getenv('SQL_CACHE_SIZE', SQL_CACHE_SIZE))
-print(f'======== SQL_CACHE_SIZE: {sql_cache_size}')
 
 
 def simple_sql(sql: str, *args, **kwargs):
@@ -53,3 +52,4 @@ def try_page_mapping(function, sql, page_num, page_size, *args, **kwargs):
     page_log(function, sql, page_num, page_size, *args, **kwargs)
     sql = dynamic_sql(sql, **kwargs)
     return get_mapping_sql_args(sql, *args, **kwargs)
+    

{MySQLX-2.2.9 → MySQLX-2.3.1}/mysqlx/support.py

@@ -34,3 +34,4 @@ class InitArgs(_InitArgs):
         MAPPER_PATH = 'mapper_path'
     """
     MAPPER_PATH = 'mapper_path'
+    

{MySQLX-2.2.9 → MySQLX-2.3.1}/setup.py

@@ -19,9 +19,9 @@ setup(
     long_description_content_type='text/markdown',
     install_requires=[
         'Jinja2>=2.7.0',
-        'sqlexecx>=2.1.9',
+        'sqlexecx>=2.2.4',
     ],
-    version='2.2.9',
+    version='2.3.1',
     url='https://gitee.com/summry/mysqlx',
     author='summy',
     author_email='xiazhongbiao@126.com',

MySQLX-2.2.9/MySQLX.egg-info/requires.txt

@@ -1,2 +0,0 @@
-Jinja2>=2.7.0
-sqlexecx>=2.1.9

MySQLX-2.2.9/mysqlx/__init__.py

@@ -1,42 +0,0 @@
-from sqlexecx import (
-    conn,
-    trans,
-    get_connection,
-    close,
-    Driver,
-    Dialect,
-    Engine,
-    init as _init
-)
-
-from .support import InitArgs
-from .sql_mapper import sql, mapper
-
-
-def init_db(*args, **kwargs):
-    """
-    Compliant with the Python DB API 2.0 (PEP-249).
-
-    from mysqlx import init_db
-    init_db('test.db', driver='sqlite3', show_sql=True, debug=True)
-    or
-    init_db("postgres://user:password@127.0.0.1:5432/testdb", mapper_path='./mapper', driver='psycopg2', pool_size=5, show_sql=True, debug=True)
-    or
-    init_db(user='root', password='xxx', host='127.0.0.1', port=3306, database='testdb', mapper_path='./mapper', driver='pymysql', pool_size=5, show_sql=True, debug=True)
-
-    Addition parameters:
-    :param mapper_path: str, path of mapper files
-    :param driver=None: str, import driver, 'import pymysql'
-    :param pool_size=0: int, default 0, size of connection pool
-    :param show_sql=False: bool,  if True, print sql
-    :param debug=False: bool, if True, print debug context
-
-    Other parameters of connection pool refer to DBUtils: https://webwareforpython.github.io/DBUtils/main.html#pooleddb-pooled-db
-    """
-    from .sql_holder import load_mapper
-
-    # Dialect.init(Engine.MYSQL)
-    mapper_path = kwargs.pop(InitArgs.MAPPER_PATH) if InitArgs.MAPPER_PATH in kwargs else None
-    _init(*args, **kwargs)
-    if mapper_path:
-        load_mapper(mapper_path)