feat: refactor parameter mapping (#32)

Enhance the way SQL Parameters are parsed and bound in statements.

Author: cofin

.pre-commit-config.yaml

@@ -2,7 +2,7 @@ default_language_version:
   python: "3"
 repos:
   - repo: https://github.com/compilerla/conventional-pre-commit
-    rev: v4.0.0
+    rev: v4.2.0
     hooks:
       - id: conventional-pre-commit
         stages: [commit-msg]
@@ -17,7 +17,7 @@ repos:
       - id: mixed-line-ending
       - id: trailing-whitespace
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.11.6"
+    rev: "v0.11.9"
     hooks:
       - id: ruff
         args: ["--fix"]

README.md

@@ -196,6 +196,7 @@ This list is not final. If you have a driver you'd like to see added, please ope
 | [`spanner`](https://googleapis.dev/python/spanner/latest/index.html)                                         | Spanner    | Sync    | 🗓️  |
 | [`sqlserver`](https://docs.microsoft.com/en-us/sql/connect/python/pyodbc/python-sql-driver-for-pyodbc?view=sql-server-ver16) | SQL Server | Sync    | 🗓️  |
 | [`mysql`](https://dev.mysql.com/doc/connector-python/en/connector-python-api-mysql-connector-python.html)     | MySQL      | Sync    | 🗓️  |
+| [`asyncmy`](https://github.com/long2ice/asyncmy)                                                           | MySQL      | Async   | ✅         |
 | [`snowflake`](https://docs.snowflake.com)                                                                    | Snowflake  | Sync    | 🗓️  |
 
 ## Proposed Project Structure

docs/PYPI_README.md

@@ -196,6 +196,7 @@ This list is not final. If you have a driver you'd like to see added, please ope
 | [`spanner`](https://googleapis.dev/python/spanner/latest/index.html)                                         | Spanner    | Sync    | 🗓️  |
 | [`sqlserver`](https://docs.microsoft.com/en-us/sql/connect/python/pyodbc/python-sql-driver-for-pyodbc?view=sql-server-ver16) | SQL Server | Sync    | 🗓️  |
 | [`mysql`](https://dev.mysql.com/doc/connector-python/en/connector-python-api-mysql-connector-python.html)     | MySQL      | Sync    | 🗓️  |
+| [`asyncmy`](https://github.com/long2ice/asyncmy)                                                           | MySQL      | Async   | ✅         |
 | [`snowflake`](https://docs.snowflake.com)                                                                    | Snowflake  | Sync    | 🗓️  |
 
 ## Proposed Project Structure

docs/examples/litestar_asyncpg.py

@@ -0,0 +1,46 @@
+"""Litestar Asyncpg
+
+This example demonstrates how to use a Asyncpg database in a Litestar application.
+
+The example uses the `SQLSpec` extension to create a connection to a Asyncpg database.
+
+The Asyncpg database also demonstrates how to use the plugin loader and `secrets` configuration manager built into SQLSpec.
+"""
+# /// script
+# dependencies = [
+#   "sqlspec[psycopg,asyncpg,performance]",
+#   "litestar[standard]",
+# ]
+# ///
+
+from litestar import Litestar, get
+
+from sqlspec.adapters.asyncpg import AsyncpgConfig, AsyncpgDriver, AsyncpgPoolConfig
+from sqlspec.extensions.litestar import DatabaseConfig, SQLSpec
+
+
+@get("/")
+async def simple_asyncpg(db_session: AsyncpgDriver) -> dict[str, str]:
+    return await db_session.select_one("SELECT 'Hello, world!' AS greeting")
+
+
+sqlspec = SQLSpec(
+    config=[
+        DatabaseConfig(
+            config=AsyncpgConfig(
+                pool_config=AsyncpgPoolConfig(dsn="postgres://app:app@localhost:15432/app", min_size=1, max_size=3),
+            ),
+            commit_mode="autocommit",
+        )
+    ]
+)
+app = Litestar(route_handlers=[simple_asyncpg], plugins=[sqlspec])
+
+if __name__ == "__main__":
+    import os
+
+    from litestar.cli import litestar_group
+
+    os.environ["LITESTAR_APP"] = "docs.examples.litestar_asyncpg:app"
+
+    litestar_group()

docs/examples/litestar_psycopg.py

@@ -0,0 +1,48 @@
+"""Litestar Psycopg
+
+This example demonstrates how to use a Psycopg database in a Litestar application.
+
+The example uses the `SQLSpec` extension to create a connection to a Psycopg database.
+
+The Psycopg database also demonstrates how to use the plugin loader and `secrets` configuration manager built into SQLSpec.
+"""
+# /// script
+# dependencies = [
+#   "sqlspec[psycopg]",
+#   "litestar[standard]",
+# ]
+# ///
+
+from litestar import Litestar, get
+
+from sqlspec.adapters.psycopg import PsycopgAsyncConfig, PsycopgAsyncDriver, PsycopgAsyncPoolConfig
+from sqlspec.extensions.litestar import DatabaseConfig, SQLSpec
+
+
+@get("/")
+async def simple_psycopg(db_session: PsycopgAsyncDriver) -> dict[str, str]:
+    return await db_session.select_one("SELECT 'Hello, world!' AS greeting")
+
+
+sqlspec = SQLSpec(
+    config=[
+        DatabaseConfig(
+            config=PsycopgAsyncConfig(
+                pool_config=PsycopgAsyncPoolConfig(
+                    conninfo="postgres://app:app@localhost:15432/app", min_size=1, max_size=3
+                ),
+            ),
+            commit_mode="autocommit",
+        )
+    ],
+)
+app = Litestar(route_handlers=[simple_psycopg], plugins=[sqlspec])
+
+if __name__ == "__main__":
+    import os
+
+    from litestar.cli import litestar_group
+
+    os.environ["LITESTAR_APP"] = "docs.examples.litestar_psycopg:app"
+
+    litestar_group()

pyproject.toml

@@ -7,7 +7,12 @@ maintainers = [{ name = "Litestar Developers", email = "[email protected]" }]
 name = "sqlspec"
 readme = "README.md"
 requires-python = ">=3.9, <4.0"
-version = "0.10.1"
+version = "0.11.0"
+
+[project.urls]
+Discord = "https://discord.gg/litestar"
+Issue = "https://github.com/litestar-org/sqlspec/issues/"
+Source = "https://github.com/litestar-org/sqlspec"
 
 [project.optional-dependencies]
 adbc = ["adbc_driver_manager", "pyarrow"]
@@ -249,6 +254,10 @@ module = [
   "pyarrow.*",
 ]
 
+[[tool.mypy.overrides]]
+disable_error_code = "ignore-without-code"
+module = "sqlspec.extensions.litestar.providers"
+
 [tool.pyright]
 disableBytesTypePromotions = true
 exclude = ["**/node_modules", "**/__pycache__", ".venv", "tools", "docs"]
@@ -260,6 +269,8 @@ reportPrivateUsage = false
 reportUnknownArgumentType = false
 reportUnknownMemberType = false
 reportUnknownVariableType = false
+reportUnnecessaryComparison = false
+reportUnnecessaryIsInstance = false
 reportUnnecessaryTypeIgnoreComments = true
 root = "."
 
@@ -318,7 +329,13 @@ select = ["ALL"]
 convention = "google"
 
 [tool.ruff.lint.mccabe]
-max-complexity = 18
+max-complexity = 25
+
+[tool.ruff.lint.pylint]
+max-bool-expr = 10
+max-branches = 20
+max-locals = 20
+max-returns = 15
 
 [tool.ruff.lint.pep8-naming]
 classmethod-decorators = ["classmethod"]

sqlspec/adapters/adbc/config.py

@@ -38,7 +38,7 @@ class AdbcConfig(NoPoolSyncConfig["AdbcConnection", "AdbcDriver"]):
     pool_instance: None = field(init=False, default=None, hash=False)
     """No connection pool is used for ADBC connections"""
 
-    def _set_adbc(self) -> str:  # noqa: PLR0912
+    def _set_adbc(self) -> str:
         """Identify the driver type based on the URI (if provided) or preset driver name.
 
         Raises: