sqlcycli 1.0.1__tar.gz

sqlcycli-1.0.1/LICENSE

@@ -0,0 +1,42 @@
+MIT License
+
+sqlcycli - Copyright (c) 2023 Jifu Chen.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+--------------------------------------------------------------------------------
+Copyright (c) 2010, 2013 PyMySQL contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

sqlcycli-1.0.1/MANIFEST.in

@@ -0,0 +1,12 @@
+include LICENSE
+include README.md
+
+include src/sqlcycli/aio/*.pxd
+include src/sqlcycli/aio/*.py
+include src/sqlcycli/aio/*.pyx
+include src/sqlcycli/constants/*.pxd
+include src/sqlcycli/constants/*.py
+include src/sqlcycli/constants/*.pyx
+include src/sqlcycli/*.pxd
+include src/sqlcycli/*.py
+include src/sqlcycli/*.pyx

sqlcycli-1.0.1/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.1
+Name: sqlcycli
+Version: 1.0.1
+Summary: Fast MySQL driver build in Cython (Sync and Async).
+Home-page: https://github.com/AresJef/SQLCyCli
+Author: Jiefu Chen
+Author-email: keppa1991@163.com
+License: MIT license
+Keywords: mysql,mariadb,pymysql,aiomysql,cython,asyncio
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: Unix
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cytimes>=1.0.3
+Requires-Dist: numpy>=1.25.2
+Requires-Dist: orjson>=3.10.2
+Requires-Dist: pandas>=2.1.0
+Requires-Dist: mysqlclient>=2.2.0
+
+## Fast MySQL driver build in Cython (Sync and Async).
+
+Created to be used in a project, this package is published to github for ease of management and installation across different modules.
+
+### Installation
+Install from `PyPi`
+``` bash
+pip install sqlcycli
+```
+
+Install from `github`
+``` bash
+pip install git+https://github.com/AresJef/SQLCyCli.git
+```
+
+### Requirements
+- Python 3.10 or higher.
+- MySQL 5.5 or higher.
+
+### Features
+- Written in [Cython](https://cython.org/) for optimal performance (especially for SELECT/INSERT query).
+- All classes and methods are well documented and static typed.
+- Supports both `Sync` and `Async` connection to the server.
+- API Compatiable with [PyMySQL](https://github.com/PyMySQL/PyMySQL) and [aiomysql](https://github.com/aio-libs/aiomysql).
+- Support conversion (escape) for most of the native python types, and objects from libaray [numpy](https://github.com/numpy/numpy) and [pandas](https://github.com/pandas-dev/pandas). Does `NOT` support custom conversion (escape).
+
+### Benchmark
+The following result comes from [benchmark](./src/benchmark.py):
+- Device: MacbookPro M1Pro(2E8P) 32GB
+- Python: 3.12.4
+- MySQL: 8.3.0
+- mysqlclient: 2.2.4
+- PyMySQL: 1.1.1
+- aiomysql: 0.2.0
+- asyncmy: 0.2.9
+```
+# Unit: second | Lower is better
+name        type    rows    insert-per-row  insert-bulk select-per-row  select-all  update-per-row  update-all  delete-per-row  delete-all
+mysqlclient sync    50000   1.734200        0.427027    1.756226        0.117552    1.901870        0.365056    1.651022        0.131151
+SQLCyCli    sync    50000   2.203967        0.293410    2.331576        0.062152    2.279076        0.352106    2.115025        0.107902
+PyMySQL     sync    50000   2.607349        0.412063    4.219286        0.321089    2.572826        0.345419    2.304015        0.104720
+SQLCyCli    async   50000   3.342991        0.270254    4.297667        0.141201    3.466729        0.346168    3.343880        0.105293
+aiomysql    async   50000   3.464662        0.384193    5.115068        0.322858    3.582689        0.345661    3.444377        0.104894
+asyncmy     async   50000   3.851011        0.416715    5.604330        0.314939    3.824736        0.346903    3.580444        0.104748
+```
+
+### Usage
+#### Use `connect()` to create one connection (`Sync` or `Async`) to the server.
+```python
+import asyncio
+import sqlcycli
+
+HOST = "localhost"
+PORT = 3306
+USER = "root"
+PSWD = "password"
+
+# Synchronous Connection
+def test_sync_connection() -> None:
+    with sqlcycli.connect(HOST, PORT, USER, PSWD) as conn:
+        with conn.cursor() as cur:
+            cur.execute("SELECT 1")
+            res = cur.fetchone()
+            assert res == (1,)
+    # Connection closed
+    assert conn.closed()
+
+# Asynchronous Connection
+async def test_async_connection() -> None:
+    async with sqlcycli.connect(HOST, PORT, USER, PSWD) as conn:
+        async with conn.cursor() as cur:
+            await cur.execute("SELECT 1")
+            res = await cur.fetchone()
+            assert res == (1,)
+    # Connection closed
+    assert conn.closed()
+
+if __name__ == "__main__":
+    test_sync_connection()
+    asyncio.run(test_async_connection())
+```
+
+#### Use `create_pool()` to create a Pool for managing and maintaining `Async` connections to the server.
+```python
+import asyncio
+import sqlcycli
+
+HOST = "localhost"
+PORT = 3306
+USER = "root"
+PSWD = "password"
+
+# Pool (Context Manager: Connected)
+async def test_pool_context_connected() -> None:
+    async with sqlcycli.create_pool(HOST, PORT, USER, PSWD, min_size=1) as pool:
+        # Pool is connected: 1 free connection (min_size=1)
+        assert not pool.closed() and pool.free == 1
+        async with pool.acquire() as conn:
+            async with conn.cursor() as cur:
+                await cur.execute("SELECT 1")
+                res = await cur.fetchone()
+                assert res == (1,)
+    # Pool closed
+    assert pool.closed() and pool.total == 0
+
+# Pool (Context Manager: Disconnected)
+async def test_pool_context_disconnected() -> None:
+    with sqlcycli.create_pool(HOST, PORT, USER, PSWD, min_size=1) as pool:
+        # Pool is not connected: 0 free connection (min_size=1)
+        assert pool.closed() and pool.free == 0
+        # Connect automatically
+        async with pool.acquire() as conn:
+            async with conn.cursor() as cur:
+                await cur.execute("SELECT 1")
+                res = await cur.fetchone()
+                assert res == (1,)
+        # 1 free connection
+        assert pool.free == 1
+    # Pool closed
+    assert pool.closed() and pool.total == 0
+
+# Pool (Create Directly: Connected)
+async def test_pool_direct_connected() -> None:
+    pool = await sqlcycli.create_pool(HOST, PORT, USER, PSWD, min_size=1)
+    # Pool is connected: 1 free connection (min_size=1)
+    assert not pool.closed() and pool.free == 1
+    async with pool.acquire() as conn:
+        async with conn.cursor() as cur:
+            await cur.execute("SELECT 1")
+            res = await cur.fetchone()
+            assert res == (1,)
+    # Close pool manually
+    await pool.close()
+    assert pool.closed() and pool.total == 0
+
+if __name__ == "__main__":
+    asyncio.run(test_pool_context_connected())
+    asyncio.run(test_pool_context_disconnected())
+    asyncio.run(test_pool_direct_connected())
+```
+
+### Acknowledgements
+SQLCyCli is build on top of the following open-source repositories:
+- [aiomysql](https://github.com/aio-libs/aiomysql)
+- [PyMySQL](https://github.com/PyMySQL/PyMySQL)
+
+SQLCyCli is based on the following open-source repositories:
+- [cytimes](https://github.com/AresJef/cyTimes)
+- [numpy](https://github.com/numpy/numpy)
+- [orjson](https://github.com/ijl/orjson)
+- [pandas](https://github.com/pandas-dev/pandas)
+- [mysqlclient](https://github.com/PyMySQL/mysqlclient)

sqlcycli-1.0.1/README.md

@@ -0,0 +1,152 @@
+## Fast MySQL driver build in Cython (Sync and Async).
+
+Created to be used in a project, this package is published to github for ease of management and installation across different modules.
+
+### Installation
+Install from `PyPi`
+``` bash
+pip install sqlcycli
+```
+
+Install from `github`
+``` bash
+pip install git+https://github.com/AresJef/SQLCyCli.git
+```
+
+### Requirements
+- Python 3.10 or higher.
+- MySQL 5.5 or higher.
+
+### Features
+- Written in [Cython](https://cython.org/) for optimal performance (especially for SELECT/INSERT query).
+- All classes and methods are well documented and static typed.
+- Supports both `Sync` and `Async` connection to the server.
+- API Compatiable with [PyMySQL](https://github.com/PyMySQL/PyMySQL) and [aiomysql](https://github.com/aio-libs/aiomysql).
+- Support conversion (escape) for most of the native python types, and objects from libaray [numpy](https://github.com/numpy/numpy) and [pandas](https://github.com/pandas-dev/pandas). Does `NOT` support custom conversion (escape).
+
+### Benchmark
+The following result comes from [benchmark](./src/benchmark.py):
+- Device: MacbookPro M1Pro(2E8P) 32GB
+- Python: 3.12.4
+- MySQL: 8.3.0
+- mysqlclient: 2.2.4
+- PyMySQL: 1.1.1
+- aiomysql: 0.2.0
+- asyncmy: 0.2.9
+```
+# Unit: second | Lower is better
+name        type    rows    insert-per-row  insert-bulk select-per-row  select-all  update-per-row  update-all  delete-per-row  delete-all
+mysqlclient sync    50000   1.734200        0.427027    1.756226        0.117552    1.901870        0.365056    1.651022        0.131151
+SQLCyCli    sync    50000   2.203967        0.293410    2.331576        0.062152    2.279076        0.352106    2.115025        0.107902
+PyMySQL     sync    50000   2.607349        0.412063    4.219286        0.321089    2.572826        0.345419    2.304015        0.104720
+SQLCyCli    async   50000   3.342991        0.270254    4.297667        0.141201    3.466729        0.346168    3.343880        0.105293
+aiomysql    async   50000   3.464662        0.384193    5.115068        0.322858    3.582689        0.345661    3.444377        0.104894
+asyncmy     async   50000   3.851011        0.416715    5.604330        0.314939    3.824736        0.346903    3.580444        0.104748
+```
+
+### Usage
+#### Use `connect()` to create one connection (`Sync` or `Async`) to the server.
+```python
+import asyncio
+import sqlcycli
+
+HOST = "localhost"
+PORT = 3306
+USER = "root"
+PSWD = "password"
+
+# Synchronous Connection
+def test_sync_connection() -> None:
+    with sqlcycli.connect(HOST, PORT, USER, PSWD) as conn:
+        with conn.cursor() as cur:
+            cur.execute("SELECT 1")
+            res = cur.fetchone()
+            assert res == (1,)
+    # Connection closed
+    assert conn.closed()
+
+# Asynchronous Connection
+async def test_async_connection() -> None:
+    async with sqlcycli.connect(HOST, PORT, USER, PSWD) as conn:
+        async with conn.cursor() as cur:
+            await cur.execute("SELECT 1")
+            res = await cur.fetchone()
+            assert res == (1,)
+    # Connection closed
+    assert conn.closed()
+
+if __name__ == "__main__":
+    test_sync_connection()
+    asyncio.run(test_async_connection())
+```
+
+#### Use `create_pool()` to create a Pool for managing and maintaining `Async` connections to the server.
+```python
+import asyncio
+import sqlcycli
+
+HOST = "localhost"
+PORT = 3306
+USER = "root"
+PSWD = "password"
+
+# Pool (Context Manager: Connected)
+async def test_pool_context_connected() -> None:
+    async with sqlcycli.create_pool(HOST, PORT, USER, PSWD, min_size=1) as pool:
+        # Pool is connected: 1 free connection (min_size=1)
+        assert not pool.closed() and pool.free == 1
+        async with pool.acquire() as conn:
+            async with conn.cursor() as cur:
+                await cur.execute("SELECT 1")
+                res = await cur.fetchone()
+                assert res == (1,)
+    # Pool closed
+    assert pool.closed() and pool.total == 0
+
+# Pool (Context Manager: Disconnected)
+async def test_pool_context_disconnected() -> None:
+    with sqlcycli.create_pool(HOST, PORT, USER, PSWD, min_size=1) as pool:
+        # Pool is not connected: 0 free connection (min_size=1)
+        assert pool.closed() and pool.free == 0
+        # Connect automatically
+        async with pool.acquire() as conn:
+            async with conn.cursor() as cur:
+                await cur.execute("SELECT 1")
+                res = await cur.fetchone()
+                assert res == (1,)
+        # 1 free connection
+        assert pool.free == 1
+    # Pool closed
+    assert pool.closed() and pool.total == 0
+
+# Pool (Create Directly: Connected)
+async def test_pool_direct_connected() -> None:
+    pool = await sqlcycli.create_pool(HOST, PORT, USER, PSWD, min_size=1)
+    # Pool is connected: 1 free connection (min_size=1)
+    assert not pool.closed() and pool.free == 1
+    async with pool.acquire() as conn:
+        async with conn.cursor() as cur:
+            await cur.execute("SELECT 1")
+            res = await cur.fetchone()
+            assert res == (1,)
+    # Close pool manually
+    await pool.close()
+    assert pool.closed() and pool.total == 0
+
+if __name__ == "__main__":
+    asyncio.run(test_pool_context_connected())
+    asyncio.run(test_pool_context_disconnected())
+    asyncio.run(test_pool_direct_connected())
+```
+
+### Acknowledgements
+SQLCyCli is build on top of the following open-source repositories:
+- [aiomysql](https://github.com/aio-libs/aiomysql)
+- [PyMySQL](https://github.com/PyMySQL/PyMySQL)
+
+SQLCyCli is based on the following open-source repositories:
+- [cytimes](https://github.com/AresJef/cyTimes)
+- [numpy](https://github.com/numpy/numpy)
+- [orjson](https://github.com/ijl/orjson)
+- [pandas](https://github.com/pandas-dev/pandas)
+- [mysqlclient](https://github.com/PyMySQL/mysqlclient)

sqlcycli-1.0.1/pyproject.toml

@@ -0,0 +1,8 @@
+[build-system]
+requires = [
+    "setuptools>=68.0.0",
+    "wheel>=0.41.0",
+    "Cython==3.0.10",
+    "numpy>=1.25.2",
+]
+build-backend = "setuptools.build_meta"

sqlcycli-1.0.1/setup.cfg

@@ -0,0 +1,41 @@
+[metadata]
+name = sqlcycli
+version = 1.0.1
+author = Jiefu Chen
+author_email = keppa1991@163.com
+description = Fast MySQL driver build in Cython (Sync and Async).
+url = https://github.com/AresJef/SQLCyCli
+long_description = file: README.md
+long_description_content_type = text/markdown
+keywords = mysql, mariadb, pymysql, aiomysql, cython, asyncio
+license = MIT license
+classifiers = 
+	Programming Language :: Python :: 3
+	Operating System :: Unix
+	Operating System :: MacOS :: MacOS X
+	Operating System :: Microsoft :: Windows
+
+[options]
+zip_safe = False
+include_package_data = True
+package_dir = 
+	= src
+packages = find:
+python_requires = >=3.10
+install_requires = 
+	cytimes>=1.0.3
+	numpy>=1.25.2
+	orjson>=3.10.2
+	pandas>=2.1.0
+	mysqlclient>=2.2.0
+
+[options.packages.find]
+where = src
+
+[build_ext]
+inplace = 1
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

sqlcycli-1.0.1/setup.py

@@ -0,0 +1,107 @@
+import os, numpy as np, platform
+from setuptools import setup, Extension
+from Cython.Build import cythonize
+
+# Package name
+__package__ = "sqlcycli"
+
+
+# Create Extension
+def extension(filename: str, include_np: bool, *extra_compile_args: str) -> Extension:
+    # Extra arguments
+    extra_args = list(extra_compile_args) if extra_compile_args else None
+    # Name
+    name: str = "%s.%s" % (__package__, filename.split(".")[0])
+    source: str = os.path.join("src", __package__, filename)
+    # Create extension
+    if include_np:
+        return Extension(
+            name,
+            sources=[source],
+            extra_compile_args=extra_args,
+            include_dirs=[np.get_include()],
+            define_macros=[("NPY_NO_DEPRECATED_API", "NPY_1_7_API_VERSION")],
+        )
+    else:
+        return Extension(name, sources=[source], extra_compile_args=extra_args)
+
+
+# Create Constant Extension
+def folder_extension(
+    folder: str,
+    filename: str,
+    include_np: bool,
+    *extra_compile_args: str,
+) -> Extension:
+    # Extra arguments
+    extra_args = list(extra_compile_args) if extra_compile_args else None
+    # Name
+    name: str = "%s.%s.%s" % (__package__, folder, filename.split(".")[0])
+    source: str = os.path.join("src", __package__, folder, filename)
+    # Create extension
+    if include_np:
+        return Extension(
+            name,
+            sources=[source],
+            extra_compile_args=extra_args,
+            include_dirs=[np.get_include()],
+            define_macros=[("NPY_NO_DEPRECATED_API", "NPY_1_7_API_VERSION")],
+        )
+    else:
+        return Extension(name, sources=[source], extra_compile_args=extra_args)
+
+
+# Build Extensions
+if platform.system() == "Windows":
+    extensions = [
+        # fmt: off
+        folder_extension("aio", "connection.py", True),
+        folder_extension("aio", "pool.py", True),
+        # fmt: on
+        folder_extension("constants", "_CLIENT.py", False),
+        folder_extension("constants", "_COMMAND.py", False),
+        folder_extension("constants", "_FIELD_TYPE.py", False),
+        folder_extension("constants", "_SERVER_STATUS.py", False),
+        extension("_auth.py", True),
+        extension("_connect.py", False),
+        extension("_optionfile.py", False),
+        extension("_ssl.py", False),
+        extension("charset.py", False),
+        extension("connection.py", True),
+        extension("errors.py", True),
+        extension("protocol.py", True),
+        extension("transcode.py", True),
+        extension("typeref.py", False),
+        extension("utils.py", True),
+    ]
+else:
+    extensions = [
+        # fmt: off
+        folder_extension("aio", "connection.py", True, "-Wno-unreachable-code", "-Wno-incompatible-pointer-types"),
+        folder_extension("aio", "pool.py", True, "-Wno-unreachable-code", "-Wno-incompatible-pointer-types"),
+        # fmt: on
+        folder_extension("constants", "_CLIENT.py", False),
+        folder_extension("constants", "_COMMAND.py", False),
+        folder_extension("constants", "_FIELD_TYPE.py", False),
+        folder_extension("constants", "_SERVER_STATUS.py", False),
+        extension("_auth.py", True, "-Wno-unreachable-code"),
+        extension("_connect.py", False, "-Wno-unreachable-code"),
+        extension("_optionfile.py", False, "-Wno-unreachable-code"),
+        extension("_ssl.py", False, "-Wno-unreachable-code"),
+        extension("charset.py", False, "-Wno-unreachable-code"),
+        extension("connection.py", True, "-Wno-unreachable-code"),
+        extension("errors.py", True, "-Wno-unreachable-code"),
+        extension("protocol.py", True, "-Wno-unreachable-code"),
+        extension("transcode.py", True, "-Wno-unreachable-code"),
+        extension("typeref.py", False),
+        extension("utils.py", True, "-Wno-unreachable-code"),
+    ]
+
+# Build
+setup(
+    ext_modules=cythonize(
+        extensions,
+        compiler_directives={"language_level": "3"},
+        annotate=True,
+    ),
+)

sqlcycli-1.0.1/src/sqlcycli/__init__.py

@@ -0,0 +1,46 @@
+from sqlcycli import constants, errors
+from sqlcycli._auth import AuthPlugin
+from sqlcycli._optionfile import OptionFile
+from sqlcycli._ssl import SSL, SSL_ENABLED
+from sqlcycli.charset import Charset, all_charsets
+from sqlcycli.protocol import MysqlPacket, FieldDescriptorPacket
+from sqlcycli.connection import (
+    Cursor,
+    DictCursor,
+    DfCursor,
+    SSCursor,
+    SSDictCursor,
+    SSDfCursor,
+    BaseConnection,
+    Connection,
+)
+from sqlcycli import aio
+from sqlcycli.aio.pool import Pool, PoolConnection
+from sqlcycli._connect import connect, create_pool
+
+
+__all__ = [
+    "constants",
+    "errors",
+    "AuthPlugin",
+    "OptionFile",
+    "SSL",
+    "SSL_ENABLED",
+    "Charset",
+    "all_charsets",
+    "MysqlPacket",
+    "FieldDescriptorPacket",
+    "Cursor",
+    "DictCursor",
+    "DfCursor",
+    "SSCursor",
+    "SSDictCursor",
+    "SSDfCursor",
+    "BaseConnection",
+    "Connection",
+    "aio",
+    "Pool",
+    "PoolConnection",
+    "connect",
+    "create_pool",
+]