one test per block

Author: euri10

docs/examples/usage/test_configuration_23.py

@@ -1,10 +1,5 @@
 """Test configuration example: Environment-based configuration."""
 
-import os
-from unittest.mock import patch
-
-import pytest
-
 
 def test_extension_config() -> None:
     from sqlspec.adapters.asyncpg import AsyncpgConfig
@@ -30,39 +25,3 @@ def test_extension_config() -> None:
             "enable_correlation_middleware": True,
         }
     }
-
-
-POSTGRES_PORT = 5433
-
-
-@pytest.mark.skipif(os.getenv("TEST_ASYNCPG", "0") != "1", reason="AsyncPG integration tests disabled")
-def test_environment_based_configuration() -> None:
-    """Test environment-based configuration pattern."""
-
-    # Mock environment variables
-    env_vars = {
-        "DB_HOST": "testhost",
-        "DB_PORT": "5433",
-        "DB_USER": "testuser",
-        "DB_PASSWORD": "testpass",
-        "DB_NAME": "testdb",
-    }
-
-    with patch.dict(os.environ, env_vars, clear=False):
-        from sqlspec.adapters.asyncpg import AsyncpgConfig
-
-        config = AsyncpgConfig(
-            pool_config={
-                "host": os.getenv("DB_HOST", "localhost"),
-                "port": int(os.getenv("DB_PORT", "5432")),
-                "user": os.getenv("DB_USER"),
-                "password": os.getenv("DB_PASSWORD"),
-                "database": os.getenv("DB_NAME"),
-            }
-        )
-
-        assert config.pool_config["host"] == "testhost"
-        assert config.pool_config["port"] == POSTGRES_PORT
-        assert config.pool_config["user"] == "testuser"
-        assert config.pool_config["password"] == "testpass"
-        assert config.pool_config["database"] == "testdb"

docs/examples/usage/test_configuration_24.py

@@ -1,22 +1,41 @@
-"""Test configuration example: Best practice - Use connection pooling."""
+"""Test configuration example: Environment-based configuration."""
+
+import os
+from unittest.mock import patch
 
 import pytest
 
-MIN_POOL_SIZE = 10
-MAX_POOL_SIZE = 20
+POSTGRES_PORT = 5433
+
+
+@pytest.mark.skipif(os.getenv("TEST_ASYNCPG", "0") != "1", reason="AsyncPG integration tests disabled")
+def test_environment_based_configuration() -> None:
+    """Test environment-based configuration pattern."""
 
+    # Mock environment variables
+    env_vars = {
+        "DB_HOST": "testhost",
+        "DB_PORT": "5433",
+        "DB_USER": "testuser",
+        "DB_PASSWORD": "testpass",
+        "DB_NAME": "testdb",
+    }
 
-@pytest.mark.skipif(
-    not pytest.importorskip("asyncpg", reason="AsyncPG not installed"), reason="AsyncPG integration tests disabled"
-)
-def test_connection_pooling_best_practice() -> None:
-    """Test connection pooling best practice configuration."""
-    from sqlspec.adapters.asyncpg import AsyncpgConfig
+    with patch.dict(os.environ, env_vars, clear=False):
+        from sqlspec.adapters.asyncpg import AsyncpgConfig
 
-    config = AsyncpgConfig(
-        pool_config={"dsn": "postgresql://localhost/db", "min_size": MIN_POOL_SIZE, "max_size": MAX_POOL_SIZE}
-    )
+        config = AsyncpgConfig(
+            pool_config={
+                "host": os.getenv("DB_HOST", "localhost"),
+                "port": int(os.getenv("DB_PORT", "5432")),
+                "user": os.getenv("DB_USER"),
+                "password": os.getenv("DB_PASSWORD"),
+                "database": os.getenv("DB_NAME"),
+            }
+        )
 
-    assert config.pool_config["min_size"] == MIN_POOL_SIZE
-    assert config.pool_config["max_size"] == MAX_POOL_SIZE
-    assert config.supports_connection_pooling is True
+        assert config.pool_config["host"] == "testhost"
+        assert config.pool_config["port"] == POSTGRES_PORT
+        assert config.pool_config["user"] == "testuser"
+        assert config.pool_config["password"] == "testpass"
+        assert config.pool_config["database"] == "testdb"

docs/examples/usage/test_configuration_25.py

@@ -1,11 +1,22 @@
-"""Test configuration example: Best practice - Enable caching."""
+"""Test configuration example: Best practice - Use connection pooling."""
 
+import pytest
 
-def test_enable_caching_best_practice() -> None:
-    """Test caching best practice configuration."""
-    from sqlspec.core.statement import StatementConfig
+MIN_POOL_SIZE = 10
+MAX_POOL_SIZE = 20
 
-    statement_config = StatementConfig(dialect="postgres", enable_caching=True)
 
-    assert statement_config.enable_caching is True
-    assert statement_config.dialect == "postgres"
+@pytest.mark.skipif(
+    not pytest.importorskip("asyncpg", reason="AsyncPG not installed"), reason="AsyncPG integration tests disabled"
+)
+def test_connection_pooling_best_practice() -> None:
+    """Test connection pooling best practice configuration."""
+    from sqlspec.adapters.asyncpg import AsyncpgConfig
+
+    config = AsyncpgConfig(
+        pool_config={"dsn": "postgresql://localhost/db", "min_size": MIN_POOL_SIZE, "max_size": MAX_POOL_SIZE}
+    )
+
+    assert config.pool_config["min_size"] == MIN_POOL_SIZE
+    assert config.pool_config["max_size"] == MAX_POOL_SIZE
+    assert config.supports_connection_pooling is True

docs/examples/usage/test_configuration_26.py

@@ -1,33 +1,11 @@
-"""Test configuration example: Best practice - Tune pool sizes."""
+"""Test configuration example: Best practice - Enable caching."""
 
-MIN_POOL_SIZE_CPU = 5
-MAX_POOL_SIZE_CPU = 10
-MIN_IO_BOUND_POOL_SIZE = 20
-MAX_IO_BOUND_POOL_SIZE = 50
-
-
-def test_tune_pool_sizes_best_practice() -> None:
-    """Test pool sizing best practices for different workloads."""
-
-    # CPU-bound workload - smaller pool
-    cpu_bound_pool_config = {"min_size": MIN_POOL_SIZE_CPU, "max_size": MAX_POOL_SIZE_CPU}
-    assert cpu_bound_pool_config["min_size"] == MIN_POOL_SIZE_CPU
-    assert cpu_bound_pool_config["max_size"] == MAX_POOL_SIZE_CPU
-
-    # I/O-bound workload - larger pool
-    io_bound_pool_config = {"min_size": MIN_IO_BOUND_POOL_SIZE, "max_size": MAX_IO_BOUND_POOL_SIZE}
-    assert io_bound_pool_config["min_size"] == MIN_IO_BOUND_POOL_SIZE
-    assert io_bound_pool_config["max_size"] == MAX_IO_BOUND_POOL_SIZE
-
-
-def test_disable_security_checks_best_practice() -> None:
-    """Test disabling security checks when necessary."""
 
+def test_enable_caching_best_practice() -> None:
+    """Test caching best practice configuration."""
     from sqlspec.core.statement import StatementConfig
 
-    # Example: Disabling security checks for trusted internal queries
-    statement_config = StatementConfig(
-        dialect="postgres",
-        enable_validation=False,  # Skip security checks
-    )
-    assert statement_config.enable_validation is False
+    statement_config = StatementConfig(dialect="postgres", enable_caching=True)
+
+    assert statement_config.enable_caching is True
+    assert statement_config.dialect == "postgres"

docs/examples/usage/test_configuration_27.py

@@ -1,26 +1,20 @@
-"""Test configuration example: Best practice - Clean up resources."""
+"""Test configuration example: Best practice - Tune pool sizes."""
 
-import pytest
+MIN_POOL_SIZE_CPU = 5
+MAX_POOL_SIZE_CPU = 10
+MIN_IO_BOUND_POOL_SIZE = 20
+MAX_IO_BOUND_POOL_SIZE = 50
 
 
-@pytest.mark.asyncio
-async def test_cleanup_resources_best_practice() -> None:
-    """Test resource cleanup best practice."""
-    import tempfile
+def test_tune_pool_sizes_best_practice() -> None:
+    """Test pool sizing best practices for different workloads."""
 
-    from sqlspec import SQLSpec
-    from sqlspec.adapters.aiosqlite import AiosqliteConfig
+    # CPU-bound workload - smaller pool
+    cpu_bound_pool_config = {"min_size": MIN_POOL_SIZE_CPU, "max_size": MAX_POOL_SIZE_CPU}
+    assert cpu_bound_pool_config["min_size"] == MIN_POOL_SIZE_CPU
+    assert cpu_bound_pool_config["max_size"] == MAX_POOL_SIZE_CPU
 
-    with tempfile.NamedTemporaryFile(suffix=".db", delete=True) as tmp:
-        spec = SQLSpec()
-        db = spec.add_config(AiosqliteConfig(pool_config={"database": tmp.name}))
-
-        # Use the connection
-        async with spec.provide_session(db) as session:
-            await session.execute("CREATE TABLE test (id INTEGER)")
-
-        # Clean up resources - important for async adapters
-        await spec.close_all_pools()
-
-        # Verify pools are closed
-        assert db.pool_instance is None or not hasattr(db.pool_instance, "_pool")
+    # I/O-bound workload - larger pool
+    io_bound_pool_config = {"min_size": MIN_IO_BOUND_POOL_SIZE, "max_size": MAX_IO_BOUND_POOL_SIZE}
+    assert io_bound_pool_config["min_size"] == MIN_IO_BOUND_POOL_SIZE
+    assert io_bound_pool_config["max_size"] == MAX_IO_BOUND_POOL_SIZE

docs/examples/usage/test_configuration_28.py

@@ -0,0 +1,13 @@
+"""Test configuration example: Best practice - Tune pool sizes."""
+
+def test_disable_security_checks_best_practice() -> None:
+    """Test disabling security checks when necessary."""
+
+    from sqlspec.core.statement import StatementConfig
+
+    # Example: Disabling security checks for trusted internal queries
+    statement_config = StatementConfig(
+        dialect="postgres",
+        enable_validation=False,  # Skip security checks
+    )
+    assert statement_config.enable_validation is False

docs/examples/usage/test_configuration_29.py

@@ -0,0 +1,26 @@
+"""Test configuration example: Best practice - Clean up resources."""
+
+import pytest
+
+
+@pytest.mark.asyncio
+async def test_cleanup_resources_best_practice() -> None:
+    """Test resource cleanup best practice."""
+    import tempfile
+
+    from sqlspec import SQLSpec
+    from sqlspec.adapters.aiosqlite import AiosqliteConfig
+
+    with tempfile.NamedTemporaryFile(suffix=".db", delete=True) as tmp:
+        spec = SQLSpec()
+        db = spec.add_config(AiosqliteConfig(pool_config={"database": tmp.name}))
+
+        # Use the connection
+        async with spec.provide_session(db) as session:
+            await session.execute("CREATE TABLE test (id INTEGER)")
+
+        # Clean up resources - important for async adapters
+        await spec.close_all_pools()
+
+        # Verify pools are closed
+        assert db.pool_instance is None or not hasattr(db.pool_instance, "_pool")

docs/usage/configuration.rst

@@ -292,18 +292,18 @@ Litestar Plugin Configuration
 .. literalinclude:: /examples/usage/test_configuration_23.py
    :language: python
    :caption: `litestar plugin configuration`
-   :lines: 10-31
+   :lines: 2-26
    :dedent: 2
 
 Environment-Based Configuration
 -------------------------------
 
 Use environment variables for configuration:
 
-.. literalinclude:: /examples/usage/test_configuration_23.py
+.. literalinclude:: /examples/usage/test_configuration_24.py
    :language: python
    :caption: `environnment-based configuration`
-   :lines: 49-59
+   :lines: 25-41
    :dedent: 4
 
 Configuration Best Practices
@@ -313,7 +313,7 @@ Configuration Best Practices
 
 Always use pooling in production:
 
-.. literalinclude:: /examples/usage/test_configuration_24.py
+.. literalinclude:: /examples/usage/test_configuration_25.py
    :language: python
    :caption: `connection pooling`
    :lines: 11-13
@@ -323,7 +323,7 @@ Always use pooling in production:
 
 Enable caching to avoid recompiling SQL statements:
 
-.. literalinclude:: /examples/usage/test_configuration_25.py
+.. literalinclude:: /examples/usage/test_configuration_26.py
    :language: python
    :caption: `enable caching`
    :lines: 6-8
@@ -333,28 +333,28 @@ Enable caching to avoid recompiling SQL statements:
 
 Size pools based on your workload:
 
-.. literalinclude:: /examples/usage/test_configuration_26.py
+.. literalinclude:: /examples/usage/test_configuration_27.py
    :language: python
    :caption: `tune pool sizes`
-   :lines: 6-14
+   :lines: 3-20
    :dedent: 2
 
 **4. Disable Validation in Production**
 
 For trusted, performance-critical queries:
 
-.. literalinclude:: /examples/usage/test_configuration_26.py
+.. literalinclude:: /examples/usage/test_configuration_28.py
    :language: python
    :caption: `no validation`
-   :lines: 19-25
+   :lines: 6-12
    :dedent: 2
 
 
 **5. Clean Up Resources**
 
 Always close pools on shutdown:
 
-.. literalinclude:: /examples/usage/test_configuration_27.py
+.. literalinclude:: /examples/usage/test_configuration_29.py
    :language: python
    :caption: `cleanup resources`
    :lines: 10-27