sqlspec 0.8.0__py3-none-any.whl → 0.9.0__py3-none-any.whl

sqlspec/adapters/psqlpy/config.py

@@ -0,0 +1,258 @@
+"""Configuration for the psqlpy PostgreSQL adapter."""
+
+from contextlib import asynccontextmanager
+from dataclasses import dataclass, field
+from typing import TYPE_CHECKING, Any, Optional, Union
+
+from psqlpy import Connection, ConnectionPool
+
+from sqlspec.adapters.psqlpy.driver import PsqlpyDriver
+from sqlspec.base import AsyncDatabaseConfig, GenericPoolConfig
+from sqlspec.exceptions import ImproperConfigurationError
+from sqlspec.typing import Empty, EmptyType, dataclass_to_dict
+
+if TYPE_CHECKING:
+    from collections.abc import AsyncGenerator, Awaitable
+
+
+__all__ = (
+    "PsqlpyConfig",
+    "PsqlpyPoolConfig",
+)
+
+
+@dataclass
+class PsqlpyPoolConfig(GenericPoolConfig):
+    """Configuration for psqlpy connection pool.
+
+    Ref: https://psqlpy-python.github.io/components/connection_pool.html#all-available-connectionpool-parameters
+    """
+
+    dsn: Optional[Union[str, EmptyType]] = Empty
+    """DSN of the PostgreSQL."""
+    # Required connection parameters
+    username: Optional[Union[str, EmptyType]] = Empty
+    """Username of the user in the PostgreSQL."""
+    password: Optional[Union[str, EmptyType]] = Empty
+    """Password of the user in the PostgreSQL."""
+    db_name: Optional[Union[str, EmptyType]] = Empty
+    """Name of the database in PostgreSQL."""
+
+    # Single or Multi-host parameters (mutually exclusive)
+    host: Optional[Union[str, EmptyType]] = Empty
+    """Host of the PostgreSQL (use for single host)."""
+    port: Optional[Union[int, EmptyType]] = Empty
+    """Port of the PostgreSQL (use for single host)."""
+    hosts: Optional[Union[list[str], EmptyType]] = Empty
+    """List of hosts of the PostgreSQL (use for multiple hosts)."""
+    ports: Optional[Union[list[int], EmptyType]] = Empty
+    """List of ports of the PostgreSQL (use for multiple hosts)."""
+
+    # Pool size
+    max_db_pool_size: int = 10
+    """Maximum size of the connection pool. Defaults to 10."""
+
+    # Optional timeouts
+    connect_timeout_sec: Optional[Union[int, EmptyType]] = Empty
+    """The time limit in seconds applied to each socket-level connection attempt."""
+    connect_timeout_nanosec: Optional[Union[int, EmptyType]] = Empty
+    """Nanoseconds for connection timeout, can be used only with `connect_timeout_sec`."""
+    tcp_user_timeout_sec: Optional[Union[int, EmptyType]] = Empty
+    """The time limit that transmitted data may remain unacknowledged before a connection is forcibly closed."""
+    tcp_user_timeout_nanosec: Optional[Union[int, EmptyType]] = Empty
+    """Nanoseconds for tcp_user_timeout, can be used only with `tcp_user_timeout_sec`."""
+
+    # Optional keepalives
+    keepalives: bool = True
+    """Controls the use of TCP keepalive. Defaults to True (on)."""
+    keepalives_idle_sec: Optional[Union[int, EmptyType]] = Empty
+    """The number of seconds of inactivity after which a keepalive message is sent to the server."""
+    keepalives_idle_nanosec: Optional[Union[int, EmptyType]] = Empty
+    """Nanoseconds for keepalives_idle_sec."""
+    keepalives_interval_sec: Optional[Union[int, EmptyType]] = Empty
+    """The time interval between TCP keepalive probes."""
+    keepalives_interval_nanosec: Optional[Union[int, EmptyType]] = Empty
+    """Nanoseconds for keepalives_interval_sec."""
+    keepalives_retries: Optional[Union[int, EmptyType]] = Empty
+    """The maximum number of TCP keepalive probes that will be sent before dropping a connection."""
+
+    # Other optional parameters
+    load_balance_hosts: Optional[Union[str, EmptyType]] = Empty
+    """Controls the order in which the client tries to connect to the available hosts and addresses ('disable' or 'random')."""
+    conn_recycling_method: Optional[Union[str, EmptyType]] = Empty
+    """How a connection is recycled."""
+    ssl_mode: Optional[Union[str, EmptyType]] = Empty
+    """SSL mode."""
+    ca_file: Optional[Union[str, EmptyType]] = Empty
+    """Path to ca_file for SSL."""
+    target_session_attrs: Optional[Union[str, EmptyType]] = Empty
+    """Specifies requirements of the session (e.g., 'read-write')."""
+    options: Optional[Union[str, EmptyType]] = Empty
+    """Command line options used to configure the server."""
+    application_name: Optional[Union[str, EmptyType]] = Empty
+    """Sets the application_name parameter on the server."""
+
+
+@dataclass
+class PsqlpyConfig(AsyncDatabaseConfig[Connection, ConnectionPool, PsqlpyDriver]):
+    """Configuration for psqlpy database connections, managing a connection pool.
+
+    This configuration class wraps `PsqlpyPoolConfig` and manages the lifecycle
+    of a `psqlpy.ConnectionPool`.
+    """
+
+    pool_config: Optional[PsqlpyPoolConfig] = field(default=None)
+    """Psqlpy Pool configuration"""
+    driver_type: type[PsqlpyDriver] = field(default=PsqlpyDriver, init=False, hash=False)
+    """Type of the driver object"""
+    connection_type: type[Connection] = field(default=Connection, init=False, hash=False)
+    """Type of the connection object"""
+    pool_instance: Optional[ConnectionPool] = field(default=None, hash=False)
+    """The connection pool instance. If set, this will be used instead of creating a new pool."""
+
+    @property
+    def connection_config_dict(self) -> "dict[str, Any]":
+        """Return the minimal connection configuration as a dict for standalone use.
+
+        Returns:
+            A string keyed dict of config kwargs for a psqlpy.Connection.
+
+        Raises:
+            ImproperConfigurationError: If essential connection parameters are missing.
+        """
+        if self.pool_config:
+            # Exclude pool-specific keys and internal metadata
+            pool_specific_keys = {
+                "max_db_pool_size",
+                "load_balance_hosts",
+                "conn_recycling_method",
+                "pool_instance",
+                "connection_type",
+                "driver_type",
+            }
+            return dataclass_to_dict(
+                self.pool_config,
+                exclude_empty=True,
+                convert_nested=False,
+                exclude_none=True,
+                exclude=pool_specific_keys,
+            )
+        msg = "You must provide a 'pool_config' for this adapter."
+        raise ImproperConfigurationError(msg)
+
+    @property
+    def pool_config_dict(self) -> "dict[str, Any]":
+        """Return the pool configuration as a dict.
+
+        Raises:
+            ImproperConfigurationError: If no pool_config is provided but a pool_instance
+
+        Returns:
+            A string keyed dict of config kwargs for creating a psqlpy pool.
+        """
+        if self.pool_config:
+            # Extract the config from the pool_config
+            return dataclass_to_dict(
+                self.pool_config,
+                exclude_empty=True,
+                convert_nested=False,
+                exclude_none=True,
+                exclude={"pool_instance", "connection_type", "driver_type"},
+            )
+
+        msg = "'pool_config' methods can not be used when a 'pool_instance' is provided."
+        raise ImproperConfigurationError(msg)
+
+    async def create_pool(self) -> "ConnectionPool":
+        """Return a pool. If none exists yet, create one.
+
+        Ensures that the pool is initialized and returns the instance.
+
+        Returns:
+            The pool instance used by the plugin.
+
+        Raises:
+            ImproperConfigurationError: If the pool could not be configured.
+        """
+        if self.pool_instance is not None:
+            return self.pool_instance
+
+        if self.pool_config is None:
+            msg = "One of 'pool_config' or 'pool_instance' must be provided."
+            raise ImproperConfigurationError(msg)
+
+        # pool_config is guaranteed to exist due to __post_init__
+        try:
+            # psqlpy ConnectionPool doesn't have an explicit async connect/startup method
+            # It creates connections on demand.
+            self.pool_instance = ConnectionPool(**self.pool_config_dict)
+        except Exception as e:
+            msg = f"Could not configure the 'pool_instance'. Error: {e!s}. Please check your configuration."
+            raise ImproperConfigurationError(msg) from e
+
+        return self.pool_instance
+
+    def provide_pool(self, *args: "Any", **kwargs: "Any") -> "Awaitable[ConnectionPool]":
+        """Create or return the pool instance.
+
+        Returns:
+            An awaitable resolving to the Pool instance.
+        """
+
+        async def _create() -> "ConnectionPool":
+            return await self.create_pool()
+
+        return _create()
+
+    def create_connection(self) -> "Awaitable[Connection]":
+        """Create and return a new, standalone psqlpy connection using the configured parameters.
+
+        Note: This method is not supported by the psqlpy adapter as connection
+        creation is primarily handled via the ConnectionPool.
+        Use `provide_connection` or `provide_session` for pooled connections.
+
+        Returns:
+            An awaitable that resolves to a new Connection instance.
+
+        Raises:
+            NotImplementedError: This method is not implemented for psqlpy.
+        """
+
+        async def _create() -> "Connection":
+            # psqlpy does not seem to offer a public API for creating
+            # standalone async connections easily outside the pool context.
+            msg = (
+                "Creating standalone connections is not directly supported by the psqlpy adapter. "
+                "Please use the pool via `provide_connection` or `provide_session`."
+            )
+            raise NotImplementedError(msg)
+
+        return _create()
+
+    @asynccontextmanager
+    async def provide_connection(self, *args: "Any", **kwargs: "Any") -> "AsyncGenerator[Connection, None]":
+        """Acquire a connection from the pool.
+
+        Yields:
+            A connection instance managed by the pool.
+        """
+        db_pool = await self.provide_pool(*args, **kwargs)
+        async with db_pool.acquire() as conn:
+            yield conn
+
+    def close_pool(self) -> None:
+        """Close the connection pool."""
+        if self.pool_instance is not None:
+            # psqlpy pool close is synchronous
+            self.pool_instance.close()
+            self.pool_instance = None
+
+    @asynccontextmanager
+    async def provide_session(self, *args: Any, **kwargs: Any) -> "AsyncGenerator[PsqlpyDriver, None]":
+        """Create and provide a database session using a pooled connection.
+
+        Yields:
+            A Psqlpy driver instance wrapping a pooled connection.
+        """
+        async with self.provide_connection(*args, **kwargs) as connection:
+            yield self.driver_type(connection)

sqlspec/adapters/psqlpy/driver.py

@@ -0,0 +1,335 @@
+# ruff: noqa: PLR0915, PLR0914, PLR0912, C901
+"""Psqlpy Driver Implementation."""
+
+import logging
+import re
+from typing import TYPE_CHECKING, Any, Optional, Union, cast
+
+from psqlpy.exceptions import RustPSQLDriverPyBaseError
+
+from sqlspec.base import AsyncDriverAdapterProtocol, T
+from sqlspec.exceptions import SQLParsingError
+from sqlspec.statement import PARAM_REGEX, SQLStatement
+
+if TYPE_CHECKING:
+    from psqlpy import Connection, QueryResult
+
+    from sqlspec.typing import ModelDTOT, StatementParameterType
+
+__all__ = ("PsqlpyDriver",)
+
+
+# Regex to find '?' placeholders, skipping those inside quotes or SQL comments
+QMARK_REGEX = re.compile(
+    r"""(?P<dquote>"[^"]*") | # Double-quoted strings
+         (?P<squote>\'[^\']*\') | # Single-quoted strings
+         (?P<comment>--[^\n]*|/\*.*?\*/) | # SQL comments (single/multi-line)
+         (?P<qmark>\?) # The question mark placeholder
+      """,
+    re.VERBOSE | re.DOTALL,
+)
+logger = logging.getLogger("sqlspec")
+
+
+class PsqlpyDriver(AsyncDriverAdapterProtocol["Connection"]):
+    """Psqlpy Postgres Driver Adapter."""
+
+    connection: "Connection"
+    dialect: str = "postgres"
+
+    def __init__(self, connection: "Connection") -> None:
+        self.connection = connection
+
+    def _process_sql_params(
+        self,
+        sql: str,
+        parameters: "Optional[StatementParameterType]" = None,
+        /,
+        **kwargs: Any,
+    ) -> "tuple[str, Optional[Union[tuple[Any, ...], list[Any], dict[str, Any]]]]":
+        """Process SQL and parameters for psqlpy.
+
+        psqlpy uses $1, $2 style parameters natively.
+        This method converts '?' (tuple/list) and ':name' (dict) styles to $n.
+        It relies on SQLStatement for initial parameter validation and merging.
+        """
+        stmt = SQLStatement(sql=sql, parameters=parameters, dialect=self.dialect, kwargs=kwargs or None)
+        sql, parameters = stmt.process()
+
+        # Case 1: Parameters are a dictionary
+        if isinstance(parameters, dict):
+            processed_sql_parts: list[str] = []
+            ordered_params = []
+            last_end = 0
+            param_index = 1
+            found_params_regex: list[str] = []
+
+            for match in PARAM_REGEX.finditer(sql):
+                if match.group("dquote") or match.group("squote") or match.group("comment"):
+                    continue
+
+                if match.group("var_name"):  # Finds :var_name
+                    var_name = match.group("var_name")
+                    found_params_regex.append(var_name)
+                    start = match.start("var_name") - 1
+                    end = match.end("var_name")
+
+                    if var_name not in parameters:
+                        msg = f"Named parameter ':{var_name}' missing from parameters. SQL: {sql}"
+                        raise SQLParsingError(msg)
+
+                    processed_sql_parts.extend((sql[last_end:start], f"${param_index}"))
+                    ordered_params.append(parameters[var_name])
+                    last_end = end
+                    param_index += 1
+
+            processed_sql_parts.append(sql[last_end:])
+            final_sql = "".join(processed_sql_parts)
+
+            if not found_params_regex and parameters:
+                logger.warning(
+                    "Dict params provided (%s), but no :name placeholders found. SQL: %s",
+                    list(parameters.keys()),
+                    sql,
+                )
+                return sql, ()
+
+            provided_keys = set(parameters.keys())
+            found_keys = set(found_params_regex)
+            unused_keys = provided_keys - found_keys
+            if unused_keys:
+                logger.warning("Unused parameters provided: %s. SQL: %s", unused_keys, sql)
+
+            return final_sql, tuple(ordered_params)
+
+        # Case 2: Parameters are a sequence/scalar
+        if isinstance(parameters, (list, tuple)):
+            sequence_processed_parts: list[str] = []
+            param_index = 1
+            last_end = 0
+            qmark_found = False
+
+            for match in QMARK_REGEX.finditer(sql):
+                if match.group("dquote") or match.group("squote") or match.group("comment"):
+                    continue
+
+                if match.group("qmark"):
+                    qmark_found = True
+                    start = match.start("qmark")
+                    end = match.end("qmark")
+                    sequence_processed_parts.extend((sql[last_end:start], f"${param_index}"))
+                    last_end = end
+                    param_index += 1
+
+            sequence_processed_parts.append(sql[last_end:])
+            final_sql = "".join(sequence_processed_parts)
+
+            if parameters and not qmark_found:
+                logger.warning("Sequence parameters provided, but no '?' placeholders found. SQL: %s", sql)
+                return sql, parameters
+
+            expected_params = param_index - 1
+            actual_params = len(parameters)
+            if expected_params != actual_params:
+                msg = f"Parameter count mismatch: Expected {expected_params}, got {actual_params}. SQL: {final_sql}"
+                raise SQLParsingError(msg)
+
+            return final_sql, parameters
+
+        # Case 3: Parameters are None
+        if PARAM_REGEX.search(sql) or QMARK_REGEX.search(sql):
+            # Perform a simpler check if any placeholders might exist if no params are given
+            for match in PARAM_REGEX.finditer(sql):
+                if not (match.group("dquote") or match.group("squote") or match.group("comment")) and match.group(
+                    "var_name"
+                ):
+                    msg = f"SQL contains named parameters (:name) but no parameters provided. SQL: {sql}"
+                    raise SQLParsingError(msg)
+            for match in QMARK_REGEX.finditer(sql):
+                if not (match.group("dquote") or match.group("squote") or match.group("comment")) and match.group(
+                    "qmark"
+                ):
+                    msg = f"SQL contains positional parameters (?) but no parameters provided. SQL: {sql}"
+                    raise SQLParsingError(msg)
+
+        return sql, ()
+
+    async def select(
+        self,
+        sql: str,
+        parameters: Optional["StatementParameterType"] = None,
+        /,
+        *,
+        connection: Optional["Connection"] = None,
+        schema_type: "Optional[type[ModelDTOT]]" = None,
+        **kwargs: Any,
+    ) -> "list[Union[ModelDTOT, dict[str, Any]]]":
+        connection = self._connection(connection)
+        sql, parameters = self._process_sql_params(sql, parameters, **kwargs)
+        parameters = parameters or []  # psqlpy expects a list/tuple
+
+        results: QueryResult = await connection.fetch(sql, parameters=parameters)
+
+        if schema_type is None:
+            return cast("list[dict[str, Any]]", results.result())  # type: ignore[return-value]
+        return results.as_class(as_class=schema_type)
+
+    async def select_one(
+        self,
+        sql: str,
+        parameters: Optional["StatementParameterType"] = None,
+        /,
+        *,
+        connection: Optional["Connection"] = None,
+        schema_type: "Optional[type[ModelDTOT]]" = None,
+        **kwargs: Any,
+    ) -> "Union[ModelDTOT, dict[str, Any]]":
+        connection = self._connection(connection)
+        sql, parameters = self._process_sql_params(sql, parameters, **kwargs)
+        parameters = parameters or []
+
+        result = await connection.fetch(sql, parameters=parameters)
+
+        if schema_type is None:
+            result = cast("list[dict[str, Any]]", result.result())  # type: ignore[assignment]
+            return cast("dict[str, Any]", result[0])  # type: ignore[index]
+        return result.as_class(as_class=schema_type)[0]
+
+    async def select_one_or_none(
+        self,
+        sql: str,
+        parameters: Optional["StatementParameterType"] = None,
+        /,
+        *,
+        connection: Optional["Connection"] = None,
+        schema_type: "Optional[type[ModelDTOT]]" = None,
+        **kwargs: Any,
+    ) -> "Optional[Union[ModelDTOT, dict[str, Any]]]":
+        connection = self._connection(connection)
+        sql, parameters = self._process_sql_params(sql, parameters, **kwargs)
+        parameters = parameters or []
+
+        result = await connection.fetch(sql, parameters=parameters)
+        if schema_type is None:
+            result = cast("list[dict[str, Any]]", result.result())  # type: ignore[assignment]
+            if len(result) == 0:  # type: ignore[arg-type]
+                return None
+            return cast("dict[str, Any]", result[0])  # type: ignore[index]
+        result = cast("list[ModelDTOT]", result.as_class(as_class=schema_type))  # type: ignore[assignment]
+        if len(result) == 0:  # type: ignore[arg-type]
+            return None
+        return cast("ModelDTOT", result[0])  # type: ignore[index]
+
+    async def select_value(
+        self,
+        sql: str,
+        parameters: "Optional[StatementParameterType]" = None,
+        /,
+        *,
+        connection: "Optional[Connection]" = None,
+        schema_type: "Optional[type[T]]" = None,
+        **kwargs: Any,
+    ) -> "Union[T, Any]":
+        connection = self._connection(connection)
+        sql, parameters = self._process_sql_params(sql, parameters, **kwargs)
+        parameters = parameters or []
+
+        value = await connection.fetch_val(sql, parameters=parameters)
+
+        if schema_type is None:
+            return value
+        return schema_type(value)  # type: ignore[call-arg]
+
+    async def select_value_or_none(
+        self,
+        sql: str,
+        parameters: "Optional[StatementParameterType]" = None,
+        /,
+        *,
+        connection: "Optional[Connection]" = None,
+        schema_type: "Optional[type[T]]" = None,
+        **kwargs: Any,
+    ) -> "Optional[Union[T, Any]]":
+        connection = self._connection(connection)
+        sql, parameters = self._process_sql_params(sql, parameters, **kwargs)
+        parameters = parameters or []
+        try:
+            value = await connection.fetch_val(sql, parameters=parameters)
+        except RustPSQLDriverPyBaseError:
+            return None
+
+        if value is None:
+            return None
+        if schema_type is None:
+            return value
+        return schema_type(value)  # type: ignore[call-arg]
+
+    async def insert_update_delete(
+        self,
+        sql: str,
+        parameters: Optional["StatementParameterType"] = None,
+        /,
+        *,
+        connection: Optional["Connection"] = None,
+        **kwargs: Any,
+    ) -> int:
+        connection = self._connection(connection)
+        sql, parameters = self._process_sql_params(sql, parameters, **kwargs)
+        parameters = parameters or []
+
+        await connection.execute(sql, parameters=parameters)
+        # For INSERT/UPDATE/DELETE, psqlpy returns an empty list but the operation succeeded
+        # if no error was raised
+        return 1
+
+    async def insert_update_delete_returning(
+        self,
+        sql: str,
+        parameters: Optional["StatementParameterType"] = None,
+        /,
+        *,
+        connection: Optional["Connection"] = None,
+        schema_type: "Optional[type[ModelDTOT]]" = None,
+        **kwargs: Any,
+    ) -> "Optional[Union[dict[str, Any], ModelDTOT]]":
+        connection = self._connection(connection)
+        sql, parameters = self._process_sql_params(sql, parameters, **kwargs)
+        parameters = parameters or []
+
+        result = await connection.execute(sql, parameters=parameters)
+        if schema_type is None:
+            result = result.result()  # type: ignore[assignment]
+            if len(result) == 0:  # type: ignore[arg-type]
+                return None
+            return cast("dict[str, Any]", result[0])  # type: ignore[index]
+        result = result.as_class(as_class=schema_type)  # type: ignore[assignment]
+        if len(result) == 0:  # type: ignore[arg-type]
+            return None
+        return cast("ModelDTOT", result[0])  # type: ignore[index]
+
+    async def execute_script(
+        self,
+        sql: str,
+        parameters: Optional["StatementParameterType"] = None,
+        /,
+        *,
+        connection: Optional["Connection"] = None,
+        **kwargs: Any,
+    ) -> str:
+        connection = self._connection(connection)
+        sql, parameters = self._process_sql_params(sql, parameters, **kwargs)
+        parameters = parameters or []
+
+        await connection.execute(sql, parameters=parameters)
+        return sql
+
+    def _connection(self, connection: Optional["Connection"] = None) -> "Connection":
+        """Get the connection to use.
+
+        Args:
+            connection: Optional connection to use. If not provided, use the default connection.
+
+        Returns:
+            The connection to use.
+        """
+        return connection or self.connection

sqlspec/adapters/psycopg/__init__.py

@@ -1,11 +1,16 @@
-from sqlspec.adapters.psycopg.config import PsycopgAsync, PsycopgAsyncPool, PsycopgSync, PsycopgSyncPool
+from sqlspec.adapters.psycopg.config import (
+    PsycopgAsyncConfig,
+    PsycopgAsyncPoolConfig,
+    PsycopgSyncConfig,
+    PsycopgSyncPoolConfig,
+)
 from sqlspec.adapters.psycopg.driver import PsycopgAsyncDriver, PsycopgSyncDriver
 
 __all__ = (
-    "PsycopgAsync",
+    "PsycopgAsyncConfig",
     "PsycopgAsyncDriver",
-    "PsycopgAsyncPool",
-    "PsycopgSync",
+    "PsycopgAsyncPoolConfig",
+    "PsycopgSyncConfig",
     "PsycopgSyncDriver",
-    "PsycopgSyncPool",
+    "PsycopgSyncPoolConfig",
 )

sqlspec/adapters/psycopg/config/__init__.py

@@ -1,9 +1,9 @@
-from sqlspec.adapters.psycopg.config._async import PsycopgAsync, PsycopgAsyncPool
-from sqlspec.adapters.psycopg.config._sync import PsycopgSync, PsycopgSyncPool
+from sqlspec.adapters.psycopg.config._async import PsycopgAsyncConfig, PsycopgAsyncPoolConfig
+from sqlspec.adapters.psycopg.config._sync import PsycopgSyncConfig, PsycopgSyncPoolConfig
 
 __all__ = (
-    "PsycopgAsync",
-    "PsycopgAsyncPool",
-    "PsycopgSync",
-    "PsycopgSyncPool",
+    "PsycopgAsyncConfig",
+    "PsycopgAsyncPoolConfig",
+    "PsycopgSyncConfig",
+    "PsycopgSyncPoolConfig",
 )