Merge pull request #1431 from dbfixtures/issue-1397

Enable PT ruff rulesets - closes #1397

Author: fizyk

newsfragments/1397.misc.1.rst

@@ -0,0 +1,2 @@
+``postgresql_proc`` now tears down through a fixture ``yield`` instead of ``request.addfinalizer``.
+Consuming it as a pytest fixture is unaffected.

newsfragments/1397.misc.rst

@@ -0,0 +1,2 @@
+Enabled Ruff's `PT <https://docs.astral.sh/ruff/rules/#flake8-pytest-style-pt>`_ rules
+to keep pytest usage consistent across the plugin and its test suite.

pyproject.toml

@@ -81,6 +81,7 @@ select = [
     "I",   # isort
     "D",   # pydocstyle
     "FBT", # flake8-boolean-trap
+    "PT",  # flake8-pytest-style
 ]
 
 [tool.pyproject-fmt]

pytest_postgresql/config.py

@@ -4,8 +4,8 @@
 from pathlib import Path
 from typing import Any
 
+import pytest
 from _pytest._py.path import LocalPath
-from pytest import FixtureRequest
 
 
 @dataclass(frozen=True)
@@ -29,7 +29,7 @@ class PostgreSQLConfig:
     drop_test_database: bool
 
 
-def get_config(request: FixtureRequest) -> PostgreSQLConfig:
+def get_config(request: pytest.FixtureRequest) -> PostgreSQLConfig:
     """Return a PostgreSQLConfig instance with configuration options."""
 
     def get_postgresql_option(option: str) -> Any:

pytest_postgresql/factories/client.py

@@ -22,7 +22,6 @@
 import psycopg
 import pytest
 from psycopg import AsyncConnection, Connection
-from pytest import FixtureRequest
 
 from pytest_postgresql._asyncio_compat import mark_postgresql_async_fixture, supports_loop_factories
 from pytest_postgresql.config import get_config
@@ -37,11 +36,11 @@
 pytest_asyncio = _pytest_asyncio
 
 
-def _postgresql_async_unavailable_stub() -> Callable[[FixtureRequest], AsyncIterator[AsyncConnection]]:
+def _postgresql_async_unavailable_stub() -> Callable[[pytest.FixtureRequest], AsyncIterator[AsyncConnection]]:
     """Return a sync fixture stub that raises when pytest-asyncio is missing or too old."""
 
     @pytest.fixture
-    def postgresql_async_stub(request: FixtureRequest) -> None:
+    def postgresql_async_stub(request: pytest.FixtureRequest) -> None:
         """Sync stub that raises ImportError when pytest-asyncio is absent or too old."""
         raise ImportError(
             "pytest-asyncio >= 1.4 is required for async fixtures. "
@@ -50,7 +49,7 @@ def postgresql_async_stub(request: FixtureRequest) -> None:
 
     mark_postgresql_async_fixture(postgresql_async_stub)
     return cast(
-        Callable[[FixtureRequest], AsyncIterator[AsyncConnection]],
+        Callable[[pytest.FixtureRequest], AsyncIterator[AsyncConnection]],
         postgresql_async_stub,
     )
 
@@ -59,7 +58,7 @@ def postgresql(
     process_fixture_name: str,
     dbname: str | None = None,
     isolation_level: "psycopg.IsolationLevel | None" = None,
-) -> Callable[[FixtureRequest], Iterator[Connection]]:
+) -> Callable[[pytest.FixtureRequest], Iterator[Connection]]:
     """Return connection fixture factory for PostgreSQL.
 
     :param process_fixture_name: name of the process fixture
@@ -70,7 +69,7 @@ def postgresql(
     """
 
     @pytest.fixture
-    def postgresql_factory(request: FixtureRequest) -> Iterator[Connection]:
+    def postgresql_factory(request: pytest.FixtureRequest) -> Iterator[Connection]:
         """Fixture connection factory for PostgreSQL.
 
         :param request: fixture request object
@@ -120,7 +119,7 @@ def postgresql_async(
     process_fixture_name: str,
     dbname: str | None = None,
     isolation_level: "psycopg.IsolationLevel | None" = None,
-) -> Callable[[FixtureRequest], AsyncIterator[AsyncConnection]]:
+) -> Callable[[pytest.FixtureRequest], AsyncIterator[AsyncConnection]]:
     """Return async connection fixture factory for PostgreSQL.
 
     Requires ``pytest-asyncio`` >= 1.4 (install via ``pip install pytest-postgresql[async]``).
@@ -135,7 +134,7 @@ def postgresql_async(
         return _postgresql_async_unavailable_stub()
 
     @pytest_asyncio.fixture
-    async def postgresql_async_factory(request: FixtureRequest) -> AsyncIterator[AsyncConnection]:
+    async def postgresql_async_factory(request: pytest.FixtureRequest) -> AsyncIterator[AsyncConnection]:
         """Async connection fixture factory for PostgreSQL.
 
         :param request: fixture request object
@@ -180,6 +179,6 @@ async def postgresql_async_factory(request: FixtureRequest) -> AsyncIterator[Asy
 
     mark_postgresql_async_fixture(postgresql_async_factory)
     return cast(
-        Callable[[FixtureRequest], AsyncIterator[AsyncConnection]],
+        Callable[[pytest.FixtureRequest], AsyncIterator[AsyncConnection]],
         postgresql_async_factory,
     )

pytest_postgresql/factories/noprocess.py

@@ -22,7 +22,6 @@
 from typing import Callable, Iterator
 
 import pytest
-from pytest import FixtureRequest
 
 from pytest_postgresql.config import get_config
 from pytest_postgresql.executors import NoopExecutor
@@ -49,7 +48,7 @@ def postgresql_noproc(
     load: list[Callable | str | Path] | None = None,
     load_autocommit: bool | None = None,
     depends_on: str | None = None,
-) -> Callable[[FixtureRequest], Iterator[NoopExecutor]]:
+) -> Callable[[pytest.FixtureRequest], Iterator[NoopExecutor]]:
     """Postgresql noprocess factory.
 
     :param host: hostname
@@ -72,7 +71,7 @@ def postgresql_noproc(
     """
 
     @pytest.fixture(scope="session")
-    def postgresql_noproc_fixture(request: FixtureRequest) -> Iterator[NoopExecutor]:
+    def postgresql_noproc_fixture(request: pytest.FixtureRequest) -> Iterator[NoopExecutor]:
         """Noop Process fixture for PostgreSQL.
 
         :param request: fixture request object

pytest_postgresql/factories/process.py

@@ -23,12 +23,11 @@
 import platform
 import tempfile
 from pathlib import Path
-from typing import Callable, Iterable
+from typing import Callable, Iterable, Iterator
 
 import port_for
 import pytest
 from port_for import PortForException, get_port
-from pytest import FixtureRequest, TempPathFactory
 
 from pytest_postgresql.config import PostgreSQLConfig, get_config
 from pytest_postgresql.executors import PostgreSQLExecutor
@@ -81,7 +80,7 @@ def postgresql_proc(
     postgres_options: str | None = None,
     load: list[Callable | str | Path] | None = None,
     load_autocommit: bool | None = None,
-) -> Callable[[FixtureRequest, TempPathFactory], PostgreSQLExecutor]:
+) -> Callable[[pytest.FixtureRequest, pytest.TempPathFactory], Iterator[PostgreSQLExecutor]]:
     """Postgresql process factory.
 
     :param executable: path to postgresql_ctl
@@ -108,7 +107,10 @@ def postgresql_proc(
     """
 
     @pytest.fixture(scope="session")
-    def postgresql_proc_fixture(request: FixtureRequest, tmp_path_factory: TempPathFactory) -> PostgreSQLExecutor:
+    def postgresql_proc_fixture(
+        request: pytest.FixtureRequest,
+        tmp_path_factory: pytest.TempPathFactory,
+    ) -> Iterator[PostgreSQLExecutor]:
         """Process fixture for PostgreSQL.
 
         :param request: fixture request object
@@ -221,16 +223,9 @@ def _cleanup_executor_resources() -> None:
             for load_element in pg_load:
                 janitor.load(load_element)
 
-            def cleanup() -> None:
-                try:
-                    janitor.drop()
-                finally:
-                    _cleanup_executor_resources()
-
-            request.addfinalizer(cleanup)
-            return postgresql_executor
-        except Exception:
+            yield postgresql_executor
+            janitor.drop()
+        finally:
             _cleanup_executor_resources()
-            raise
 
     return postgresql_proc_fixture

tests/examples/test_assert_load_autocommit_is_true.py

@@ -3,12 +3,12 @@
 That shows that it is not the default (False), and that we parsed it as a bool.
 """
 
-from pytest import FixtureRequest
+import pytest
 
 from pytest_postgresql.config import get_config
 
 
-def test_assert_load_autocommit_is_true(request: FixtureRequest) -> None:
+def test_assert_load_autocommit_is_true(request: pytest.FixtureRequest) -> None:
     """Asserts that load_autocommit is True."""
     config = get_config(request)
     assert config.load_autocommit is True

tests/examples/test_assert_port_search_count_is_ten.py

@@ -3,12 +3,12 @@
 That shows that it is not the default (5), and that we parsed it as an integer.
 """
 
-from pytest import FixtureRequest
+import pytest
 
 from pytest_postgresql.config import get_config
 
 
-def test_assert_port_search_count_is_ten(request: FixtureRequest) -> None:
+def test_assert_port_search_count_is_ten(request: pytest.FixtureRequest) -> None:
     """Asserts that port_search_count is 10."""
     config = get_config(request)
     assert config.port_search_count == 10

tests/test_config.py

@@ -9,12 +9,12 @@
 
 
 @pytest.mark.parametrize(
-    "path, want",
-    (
+    ("path", "want"),
+    [
         ("test.sql", Path("test.sql")),
         ("load.function", "load.function"),
         (LocalPath("test.sql"), Path("test.sql").absolute()),  # type: ignore[no-untyped-call]
-    ),
+    ],
 )
 def test_detect_paths(path: str | LocalPath, want: Path | str) -> None:
     """Check the correctness of detect_paths function."""