sqlspec 0.11.0__py3-none-any.whl → 0.12.0__py3-none-any.whl

sqlspec/adapters/psycopg/config/_async.py

@@ -1,169 +0,0 @@
-from contextlib import asynccontextmanager
-from dataclasses import dataclass, field
-from typing import TYPE_CHECKING, Any, Optional
-
-from psycopg_pool import AsyncConnectionPool
-
-from sqlspec.adapters.psycopg.config._common import PsycopgGenericPoolConfig
-from sqlspec.adapters.psycopg.driver import PsycopgAsyncConnection, PsycopgAsyncDriver
-from sqlspec.base import AsyncDatabaseConfig
-from sqlspec.exceptions import ImproperConfigurationError
-from sqlspec.typing import dataclass_to_dict
-
-if TYPE_CHECKING:
-    from collections.abc import AsyncGenerator, Awaitable
-
-
-__all__ = (
-    "PsycopgAsyncConfig",
-    "PsycopgAsyncPoolConfig",
-)
-
-
-@dataclass
-class PsycopgAsyncPoolConfig(PsycopgGenericPoolConfig[PsycopgAsyncConnection, AsyncConnectionPool]):
-    """Async Psycopg Pool Config"""
-
-
-@dataclass
-class PsycopgAsyncConfig(AsyncDatabaseConfig[PsycopgAsyncConnection, AsyncConnectionPool, PsycopgAsyncDriver]):
-    """Async Psycopg database Configuration.
-
-    This class provides the base configuration for Psycopg database connections, extending
-    the generic database configuration with Psycopg-specific settings.([1](https://www.psycopg.org/psycopg3/docs/api/connections.html))
-
-    The configuration supports all standard Psycopg connection parameters and can be used
-    with both synchronous and asynchronous connections.([2](https://www.psycopg.org/psycopg3/docs/api/connections.html))
-    """
-
-    pool_config: "Optional[PsycopgAsyncPoolConfig]" = None
-    """Psycopg Pool configuration"""
-    pool_instance: "Optional[AsyncConnectionPool]" = None
-    """Optional pool to use"""
-    connection_type: "type[PsycopgAsyncConnection]" = field(init=False, default_factory=lambda: PsycopgAsyncConnection)  # type: ignore[assignment]
-    """Type of the connection object"""
-    driver_type: "type[PsycopgAsyncDriver]" = field(init=False, default_factory=lambda: PsycopgAsyncDriver)  # type: ignore[type-abstract,unused-ignore]
-    """Type of the driver object"""
-
-    @property
-    def connection_config_dict(self) -> "dict[str, Any]":
-        """Return the connection configuration as a dict.
-
-        Returns:
-            A string keyed dict of config kwargs for the psycopg.connect function.
-
-        Raises:
-            ImproperConfigurationError: If the connection configuration is not provided.
-        """
-        if self.pool_config:
-            # Filter out pool-specific parameters
-            pool_only_params = {
-                "min_size",
-                "max_size",
-                "name",
-                "timeout",
-                "reconnect_timeout",
-                "max_idle",
-                "max_lifetime",
-            }
-            return dataclass_to_dict(
-                self.pool_config,
-                exclude_empty=True,
-                convert_nested=False,
-                exclude=pool_only_params.union({"pool_instance", "connection_type", "driver_type", "open"}),
-            )
-        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 pool_config is not set but pool_instance is provided.
-        """
-        if self.pool_config:
-            return dataclass_to_dict(
-                self.pool_config,
-                exclude_empty=True,
-                convert_nested=False,
-                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_connection(self) -> "PsycopgAsyncConnection":
-        """Create and return a new psycopg async connection from the pool.
-
-        Returns:
-            An AsyncConnection instance.
-
-        Raises:
-            ImproperConfigurationError: If the connection could not be created.
-        """
-        try:
-            pool = await self.provide_pool()
-            return await pool.getconn()
-        except Exception as e:
-            msg = f"Could not configure the Psycopg connection. Error: {e!s}"
-            raise ImproperConfigurationError(msg) from e
-
-    async def create_pool(self) -> "AsyncConnectionPool":
-        """Create and return a connection pool.
-
-        Returns:
-            AsyncConnectionPool: The configured connection pool.
-
-        Raises:
-            ImproperConfigurationError: If neither pool_config nor pool_instance are provided
-                or if pool creation fails.
-        """
-        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 = self.pool_config_dict
-        self.pool_instance = AsyncConnectionPool(open=False, **pool_config)
-        if self.pool_instance is None:  # pyright: ignore[reportUnnecessaryComparison]
-            msg = "Could not configure the 'pool_instance'. Please check your configuration."  # type: ignore[unreachable]
-            raise ImproperConfigurationError(msg)
-        await self.pool_instance.open()
-        return self.pool_instance
-
-    def provide_pool(self, *args: "Any", **kwargs: "Any") -> "Awaitable[AsyncConnectionPool]":
-        """Create and return a connection pool.
-
-        Returns:
-            Awaitable[AsyncConnectionPool]: The configured connection pool.
-        """
-        return self.create_pool()
-
-    @asynccontextmanager
-    async def provide_connection(self, *args: "Any", **kwargs: "Any") -> "AsyncGenerator[PsycopgAsyncConnection, None]":
-        """Create and provide a database connection.
-
-        Yields:
-            AsyncConnection: A database connection from the pool.
-        """
-        pool = await self.provide_pool(*args, **kwargs)
-        async with pool, pool.connection() as connection:
-            yield connection
-
-    @asynccontextmanager
-    async def provide_session(self, *args: "Any", **kwargs: "Any") -> "AsyncGenerator[PsycopgAsyncDriver, None]":
-        """Create and provide a database session.
-
-        Yields:
-            PsycopgAsyncDriver: A driver instance with an active connection.
-        """
-        async with self.provide_connection(*args, **kwargs) as connection:
-            yield self.driver_type(connection)
-
-    async def close_pool(self) -> None:
-        """Close the connection pool."""
-        if self.pool_instance is not None:
-            await self.pool_instance.close()
-            self.pool_instance = None

sqlspec/adapters/psycopg/config/_common.py

@@ -1,56 +0,0 @@
-from dataclasses import dataclass
-from typing import TYPE_CHECKING, Generic, TypeVar, Union
-
-from sqlspec.base import GenericPoolConfig
-from sqlspec.typing import Empty
-
-if TYPE_CHECKING:
-    from collections.abc import Callable
-    from typing import Any
-
-    from psycopg import AsyncConnection, Connection
-    from psycopg_pool import AsyncConnectionPool, ConnectionPool
-
-    from sqlspec.typing import EmptyType
-
-
-__all__ = ("PsycopgGenericPoolConfig",)
-
-
-ConnectionT = TypeVar("ConnectionT", bound="Union[Connection, AsyncConnection]")
-PoolT = TypeVar("PoolT", bound="Union[ConnectionPool, AsyncConnectionPool]")
-
-
-@dataclass
-class PsycopgGenericPoolConfig(GenericPoolConfig, Generic[ConnectionT, PoolT]):
-    """Configuration for Psycopg connection pools.
-
-    This class provides configuration options for both synchronous and asynchronous Psycopg
-    database connection pools. It supports all standard Psycopg connection parameters and pool-specific
-    settings.([1](https://www.psycopg.org/psycopg3/docs/api/pool.html))
-    """
-
-    conninfo: "Union[str, EmptyType]" = Empty
-    """Connection string in libpq format"""
-    kwargs: "Union[dict[str, Any], EmptyType]" = Empty
-    """Additional connection parameters"""
-    min_size: "Union[int, EmptyType]" = Empty
-    """Minimum number of connections in the pool"""
-    max_size: "Union[int, EmptyType]" = Empty
-    """Maximum number of connections in the pool"""
-    name: "Union[str, EmptyType]" = Empty
-    """Name of the connection pool"""
-    timeout: "Union[float, EmptyType]" = Empty
-    """Timeout for acquiring connections"""
-    max_waiting: "Union[int, EmptyType]" = Empty
-    """Maximum number of waiting clients"""
-    max_lifetime: "Union[float, EmptyType]" = Empty
-    """Maximum connection lifetime"""
-    max_idle: "Union[float, EmptyType]" = Empty
-    """Maximum idle time for connections"""
-    reconnect_timeout: "Union[float, EmptyType]" = Empty
-    """Time between reconnection attempts"""
-    num_workers: "Union[int, EmptyType]" = Empty
-    """Number of background workers"""
-    configure: "Union[Callable[[ConnectionT], None], EmptyType]" = Empty
-    """Callback to configure new connections"""

sqlspec/adapters/psycopg/config/_sync.py

@@ -1,168 +0,0 @@
-from contextlib import contextmanager
-from dataclasses import dataclass, field
-from typing import TYPE_CHECKING, Any, Optional
-
-from psycopg_pool import ConnectionPool
-
-from sqlspec.adapters.psycopg.config._common import PsycopgGenericPoolConfig
-from sqlspec.adapters.psycopg.driver import PsycopgSyncConnection, PsycopgSyncDriver
-from sqlspec.base import SyncDatabaseConfig
-from sqlspec.exceptions import ImproperConfigurationError
-from sqlspec.typing import dataclass_to_dict
-
-if TYPE_CHECKING:
-    from collections.abc import Generator
-
-
-__all__ = (
-    "PsycopgSyncConfig",
-    "PsycopgSyncPoolConfig",
-)
-
-
-@dataclass
-class PsycopgSyncPoolConfig(PsycopgGenericPoolConfig[PsycopgSyncConnection, ConnectionPool]):
-    """Sync Psycopg Pool Config"""
-
-
-@dataclass
-class PsycopgSyncConfig(SyncDatabaseConfig[PsycopgSyncConnection, ConnectionPool, PsycopgSyncDriver]):
-    """Sync Psycopg database Configuration.
-    This class provides the base configuration for Psycopg database connections, extending
-    the generic database configuration with Psycopg-specific settings.([1](https://www.psycopg.org/psycopg3/docs/api/connections.html))
-
-    The configuration supports all standard Psycopg connection parameters and can be used
-    with both synchronous and asynchronous connections.([2](https://www.psycopg.org/psycopg3/docs/api/connections.html))
-    """
-
-    pool_config: "Optional[PsycopgSyncPoolConfig]" = None
-    """Psycopg Pool configuration"""
-    pool_instance: "Optional[ConnectionPool]" = None
-    """Optional pool to use"""
-    connection_type: "type[PsycopgSyncConnection]" = field(init=False, default_factory=lambda: PsycopgSyncConnection)  # type: ignore[assignment]
-    """Type of the connection object"""
-    driver_type: "type[PsycopgSyncDriver]" = field(init=False, default_factory=lambda: PsycopgSyncDriver)  # type: ignore[type-abstract,unused-ignore]
-    """Type of the driver object"""
-
-    @property
-    def connection_config_dict(self) -> "dict[str, Any]":
-        """Return the connection configuration as a dict.
-
-        Returns:
-            A string keyed dict of config kwargs for the psycopg.connect function.
-
-        Raises:
-            ImproperConfigurationError: If the connection configuration is not provided.
-        """
-        if self.pool_config:
-            # Filter out pool-specific parameters
-            pool_only_params = {
-                "min_size",
-                "max_size",
-                "name",
-                "timeout",
-                "reconnect_timeout",
-                "max_idle",
-                "max_lifetime",
-            }
-            return dataclass_to_dict(
-                self.pool_config,
-                exclude_empty=True,
-                convert_nested=False,
-                exclude=pool_only_params.union({"pool_instance", "connection_type", "driver_type", "open"}),
-            )
-        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 pool_config is not provided and instead pool_instance is used.
-        """
-        if self.pool_config:
-            return dataclass_to_dict(
-                self.pool_config,
-                exclude_empty=True,
-                convert_nested=False,
-                exclude={"pool_instance", "connection_type", "driver_type", "open"},
-            )
-        msg = "'pool_config' methods can not be used when a 'pool_instance' is provided."
-        raise ImproperConfigurationError(msg)
-
-    def create_connection(self) -> "PsycopgSyncConnection":
-        """Create and return a new psycopg connection from the pool.
-
-        Returns:
-            A Connection instance.
-
-        Raises:
-            ImproperConfigurationError: If the connection could not be created.
-        """
-        try:
-            pool = self.provide_pool()
-            return pool.getconn()
-        except Exception as e:
-            msg = f"Could not configure the Psycopg connection. Error: {e!s}"
-            raise ImproperConfigurationError(msg) from e
-
-    def create_pool(self) -> "ConnectionPool":
-        """Create and return a connection pool.
-
-        Returns:
-            ConnectionPool: The configured connection pool instance.
-
-        Raises:
-            ImproperConfigurationError: If neither pool_config nor pool_instance is provided,
-                or 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 = self.pool_config_dict
-        self.pool_instance = ConnectionPool(open=False, **pool_config)
-        if self.pool_instance is None:  # pyright: ignore[reportUnnecessaryComparison]
-            msg = "Could not configure the 'pool_instance'. Please check your configuration."  # type: ignore[unreachable]
-            raise ImproperConfigurationError(msg)
-        self.pool_instance.open()
-        return self.pool_instance
-
-    def provide_pool(self, *args: "Any", **kwargs: "Any") -> "ConnectionPool":
-        """Create and return a connection pool.
-
-        Returns:
-            ConnectionPool: The configured connection pool instance.
-        """
-        return self.create_pool()
-
-    @contextmanager
-    def provide_connection(self, *args: "Any", **kwargs: "Any") -> "Generator[PsycopgSyncConnection, None, None]":
-        """Create and provide a database connection.
-
-        Yields:
-            PsycopgSyncConnection: A database connection from the pool.
-        """
-        pool = self.provide_pool(*args, **kwargs)
-        with pool, pool.connection() as connection:
-            yield connection
-
-    @contextmanager
-    def provide_session(self, *args: "Any", **kwargs: "Any") -> "Generator[PsycopgSyncDriver, None, None]":
-        """Create and provide a database session.
-
-        Yields:
-            PsycopgSyncDriver: A driver instance with an active connection.
-        """
-        with self.provide_connection(*args, **kwargs) as connection:
-            yield self.driver_type(connection)
-
-    def close_pool(self) -> None:
-        """Close the connection pool."""
-        if self.pool_instance is not None:
-            self.pool_instance.close()
-            self.pool_instance = None