Deprecate DatabaseJanitor version argument

[w3lld1]

Summary

• I made the unused version argument optional on both janitor classes and emit a DeprecationWarning when callers still provide it.
• I removed the argument from the plugin's internal janitor construction paths and from the public examples.
• I kept supplied values available during the deprecation period, added regression coverage, and recorded the deprecation in a newsfragment. A separate follow-up can remove the compatibility path after the deprecation window.

Validation

• uvx pre-commit run --from-ref upstream/main --to-ref HEAD
• uv run pytest tests/test_janitor.py -q -k 'not test_janitor_populate_async_sql_path and not test_async_janitor_init_and_drop and not test_async_janitor_template_flag_and_context_manager and not test_async_janitor_creates_database_from_template' (31 passed)
• uv run pytest tests/test_factory_errors.py -q (3 passed)
• uv build
• git diff --check upstream/main...HEAD

The four PostgreSQL-backed janitor tests are deferred to CI because this environment does not provide pg_config or a PostgreSQL server.

Fixes #1393

Summary by CodeRabbit

• Deprecation

  • The optional PostgreSQL version argument is now deprecated when supplied to database janitors.
  • Existing version values remain supported and generate a deprecation warning.

• Documentation

  • Usage examples have been updated to omit the deprecated argument.

• Improvements

  • Database janitors now work without requiring an explicit PostgreSQL version, simplifying synchronous and asynchronous setup.

[coderabbitai]

📝 Walkthrough

Walkthrough

The janitor version argument is now optional and deprecated. Production fixtures, examples, and tests no longer pass it by default. Supplied values still trigger a warning and retain version parsing behaviour.

Changes

Janitor version deprecation

Layer / File(s)	Summary
Optional and deprecated API pytest_postgresql/janitor.py, newsfragments/1393.depr.rst	The janitor accepts version=None, types the public attribute as optional, and warns when a version is supplied.
Fixture and example updates pytest_postgresql/factories/client.py, pytest_postgresql/factories/noprocess.py, pytest_postgresql/factories/process.py, README.rst	Janitor construction no longer passes the PostgreSQL process version.
Test coverage updates tests/test_janitor.py, tests/test_noopexecutor.py, tests/test_postgres_options_plugin.py	Tests cover optional construction, deprecation warnings, version conversion, and operations without an explicit version.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

• dbfixtures/pytest-postgresql#1364: Both changes update janitor constructors and version handling.
• dbfixtures/pytest-postgresql#1366: Both changes make janitor version handling optional and deprecated.

Suggested reviewers: fizyk, tboy1337

🚥 Pre-merge checks | ✅ 6

✅ Passed checks (6 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly identifies the main change: deprecating the DatabaseJanitor version argument.
Linked Issues check	✅ Passed	The changes satisfy issue #1393 by deprecating the version argument, making it optional, warning on use, and preserving compatibility.
Out of Scope Changes check	✅ Passed	The changes remain within scope and support deprecation through code updates, documentation, tests, and a newsfragment.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Newsfragment Check	✅ Passed	Added newsfragments/1393.depr.rst; depr is a valid towncrier type, and the pull request includes substantive code and test changes.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@tests/test_janitor.py`:
- Around line 24-27: Replace the Any annotation on version in both deprecation
tests with str | float | Version, and change the parametrized numeric value 10
to 10.0 so it matches the supported input type and BaseDatabaseJanitor.__init__
contract.
- Line 37: Update the version values in the pytest.mark.parametrize decorator to
use a list instead of a tuple, while preserving VERSION, 10, and "10" as the
parameter cases.

🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 3014c437-3346-468e-b559-cc97cffee6cf

📥 Commits

Reviewing files that changed from the base of the PR and between e72b4ef and b023103.

📒 Files selected for processing (9)

• README.rst
• newsfragments/1393.depr.rst
• pytest_postgresql/factories/client.py
• pytest_postgresql/factories/noprocess.py
• pytest_postgresql/factories/process.py
• pytest_postgresql/janitor.py
• tests/test_janitor.py
• tests/test_noopexecutor.py
• tests/test_postgres_options_plugin.py

💤 Files with no reviewable changes (6)

• README.rst
• pytest_postgresql/factories/client.py
• tests/test_postgres_options_plugin.py
• pytest_postgresql/factories/noprocess.py
• pytest_postgresql/factories/process.py
• tests/test_noopexecutor.py

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!