feat: Psycopg 3 support via the psycopg_async driver#217
Open
rayakame wants to merge 11 commits into
Open
Conversation
Add sql_driver "psycopg_async", generating asyncio code for Psycopg 3 with full asyncpg command parity: one, many, exec, execresult, execrows and copyfrom, which streams rows through cursor.copy(). psycopg rejects PostgreSQL-native $N placeholders and scans the whole query text for pyformat ones, so parameterized queries are rewritten at generation time: a scanner aware of string literals, escape strings, quoted identifiers, dollar quoting and nested block comments turns $N into %(pN)s and doubles every literal percent, and parameters bind as a dict keyed by sqlc's parameter number, which also handles reuse. Parameterless SQL stays untouched, since psycopg leaves it unscanned. The type contract matches asyncpg exactly. The shared postgresql mapping is reused, bytea, inet and cidr convert inline, and returned json/jsonb columns keep their str wire type by registering psycopg's TextLoader on the process-global adapters map per module, mirroring how the sqlite drivers register converters. Converters therefore behave identically on both postgres drivers. psycopg's typed API takes LiteralString query text, so the SQL constants and the QueryResults sql parameter are annotated as such for this driver. QueryResults carries the params dict through a named-parameters variant of the class header. Overlong dicts hoist into a local named sql_params, and that name joins conn/self/sql in the parameter dedup map. execresult returns the cursor, execrows its rowcount, which is -1 for statements like CREATE TABLE. The full fixture matrix mirrors driver_asyncpg across all four model types with classes and functions variants, checked by pyright strict, ruff, sqlc diff and a runtime pytest suite against PostgreSQL. The test connection runs autocommit to match asyncpg's per-statement semantics, and on Windows the conftest installs the selector event loop policy that psycopg's async support requires.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: ⛔ Files ignored due to path filters (4)
📒 Files selected for processing (24)
📝 WalkthroughWalkthroughAdds ChangesAsync Psycopg driver
Estimated code review effort: 5 (Critical) | ~120 minutes Possibly related PRs
Suggested labels: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 Checkov (3.3.8)sqlc.yamlTraceback (most recent call last): test/driver_aiosqlite/sqlc.yamlTraceback (most recent call last): test/driver_asyncpg/sqlc.yamlTraceback (most recent call last):
Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
|
The SQL rewriter now follows PostgreSQL's lexer rules for identifiers containing dollar signs (col$2 is a column name, not a parameter, and a$x$ no longer opens a dollar quote), recognizes multi-byte dollar-quote tags and identifiers, and ends line comments at a bare carriage return. The hoisted sql_params local is only annotated with QueryResultsArgsType in :many bodies, where the alias exists and dict invariance requires it; other commands bind through psycopg's Mapping parameter and stay unannotated, so a wide query in a module without :many no longer references an undefined name. Plain sequence parameters copy through list() before binding, since psycopg dumps tuples as composite records rather than arrays while the Sequence annotation invites them. The :execrows docstring now documents -1 for statements without a row count, matching cur.rowcount. The cur and row body locals are reserved in the parameter dedup map like sql_params, and every generated statement wraps through WriteWrappedCall, including an overlong COPY statement, which pre-explodes in the exact layout ruff format produces. Shared cleanup: the identical asyncpg/psycopg __anext__ emission moved into writeAsyncNextMethod, the dead async flag on psycopgBase and the unused docstring wrapper pair are gone, scanStringLiteral delegates quote-doubling to scanQuoted, and both postgres conftest teardowns share one cleanup constant. The omit_typechecking_block coverage promised by the psycopg sqlc.yaml comment now exists: two omit_tc codegen blocks, committed fixtures, and import plus runtime tests. Docs that still described three drivers or called :copyfrom asyncpg-only are updated.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 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 @.github/workflows/ci.yml:
- Line 314: Update the needs dependency list in the workflow to remove spaces
immediately inside the square brackets, matching the repository’s YAML
flow-sequence style while preserving the existing dependency entries and order.
- Around line 178-196: Add job-level permissions to the psycopg-async job
granting only contents: read, and configure its actions/checkout step with
persist-credentials: false. Update only the psycopg-async job and its checkout
configuration.
In `@test/driver_psycopg_async/__init__.py`:
- Line 20: Correct the package docstrings in
test/driver_psycopg_async/__init__.py:20-20,
test/driver_psycopg_async/attrs/__init__.py:20-20, and
test/driver_psycopg_async/msgspec/__init__.py:20-20 by changing the driver name
from asyncpg to psycopg; no other changes are needed.
In `@test/driver_psycopg_async/dataclass/__init__.py`:
- Line 20: Update the package docstring in
test/driver_psycopg_async/dataclass/__init__.py at line 20 to reference psycopg
dataclass tests instead of asyncpg tests, and make the same wording correction
in test/driver_psycopg_async/pydantic/__init__.py at line 20 for psycopg
pydantic tests.
🪄 Autofix (Beta)
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
Run ID: b5aa9079-2e9a-4091-8771-a2dfb426e021
⛔ Files ignored due to path filters (234)
test/driver_aiosqlite/attrs/classes/__init__.pyis excluded by!test/driver_*/*/classes/**test/driver_aiosqlite/attrs/classes/models.pyis excluded by!test/driver_*/*/classes/**test/driver_aiosqlite/attrs/classes/queries.pyis excluded by!test/driver_*/*/classes/**test/driver_aiosqlite/attrs/functions/__init__.pyis excluded by!test/driver_*/*/functions/**test/driver_aiosqlite/attrs/functions/models.pyis excluded by!test/driver_*/*/functions/**test/driver_aiosqlite/attrs/functions/queries.pyis excluded by!test/driver_*/*/functions/**test/driver_aiosqlite/dataclass/classes/__init__.pyis excluded by!test/driver_*/*/classes/**test/driver_aiosqlite/dataclass/classes/models.pyis excluded by!test/driver_*/*/classes/**test/driver_aiosqlite/dataclass/classes/queries.pyis excluded by!test/driver_*/*/classes/**test/driver_aiosqlite/dataclass/functions/__init__.pyis excluded by!test/driver_*/*/functions/**test/driver_aiosqlite/dataclass/functions/models.pyis excluded by!test/driver_*/*/functions/**test/driver_aiosqlite/dataclass/functions/queries.pyis excluded by!test/driver_*/*/functions/**test/driver_aiosqlite/dataclass/functions/queries_slice.pyis excluded by!test/driver_*/*/functions/**test/driver_aiosqlite/msgspec/classes/__init__.pyis excluded by!test/driver_*/*/classes/**test/driver_aiosqlite/msgspec/classes/models.pyis excluded by!test/driver_*/*/classes/**test/driver_aiosqlite/msgspec/classes/queries.pyis excluded by!test/driver_*/*/classes/**test/driver_aiosqlite/msgspec/functions/__init__.pyis excluded by!test/driver_*/*/functions/**test/driver_aiosqlite/msgspec/functions/models.pyis excluded by!test/driver_*/*/functions/**test/driver_aiosqlite/msgspec/functions/queries.pyis excluded by!test/driver_*/*/functions/**test/driver_aiosqlite/pydantic/classes/__init__.pyis excluded by!test/driver_*/*/classes/**test/driver_aiosqlite/pydantic/classes/models.pyis excluded by!test/driver_*/*/classes/**test/driver_aiosqlite/pydantic/classes/queries.pyis excluded by!test/driver_*/*/classes/**test/driver_aiosqlite/pydantic/functions/__init__.pyis excluded by!test/driver_*/*/functions/**test/driver_aiosqlite/pydantic/functions/models.pyis excluded by!test/driver_*/*/functions/**test/driver_aiosqlite/pydantic/functions/queries.pyis excluded by!test/driver_*/*/functions/**test/driver_aiosqlite/sqlc-gen-better-python.wasmis excluded by!**/*.wasm,!**/*.wasmtest/driver_asyncpg/attrs/classes/__init__.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/attrs/classes/enums.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/attrs/classes/models.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/attrs/classes/queries.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/attrs/classes/queries_copy_override.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/attrs/classes/queries_enum_override.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/attrs/classes/queries_field_namings.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/attrs/classes/queries_invalid_identifiers.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/attrs/functions/__init__.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/attrs/functions/enums.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/attrs/functions/models.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/attrs/functions/queries.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/attrs/functions/queries_copy_override.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/attrs/functions/queries_enum_override.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/attrs/functions/queries_field_namings.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/attrs/functions/queries_invalid_identifiers.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/dataclass/classes/__init__.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/dataclass/classes/enums.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/dataclass/classes/models.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/dataclass/classes/queries.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/dataclass/classes/queries_copy_override.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/dataclass/classes/queries_enum_override.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/dataclass/classes/queries_field_namings.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/dataclass/classes/queries_invalid_identifiers.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/dataclass/functions/__init__.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/dataclass/functions/enums.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/dataclass/functions/models.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/dataclass/functions/queries.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/dataclass/functions/queries_converters.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/dataclass/functions/queries_copy_override.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/dataclass/functions/queries_enum_override.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/dataclass/functions/queries_field_namings.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/dataclass/functions/queries_invalid_identifiers.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/msgspec/classes/__init__.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/msgspec/classes/enums.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/msgspec/classes/models.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/msgspec/classes/queries.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/msgspec/classes/queries_copy_override.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/msgspec/classes/queries_enum_override.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/msgspec/classes/queries_field_namings.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/msgspec/classes/queries_invalid_identifiers.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/msgspec/functions/__init__.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/msgspec/functions/enums.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/msgspec/functions/models.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/msgspec/functions/queries.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/msgspec/functions/queries_copy_override.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/msgspec/functions/queries_enum_override.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/msgspec/functions/queries_field_namings.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/msgspec/functions/queries_invalid_identifiers.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/omit_tc/classes/__init__.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/omit_tc/classes/enums.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/omit_tc/classes/models.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/omit_tc/classes/queries_enum_override.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/omit_tc/functions/__init__.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/omit_tc/functions/enums.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/omit_tc/functions/models.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/omit_tc/functions/queries_enum_override.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/pydantic/classes/__init__.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/pydantic/classes/enums.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/pydantic/classes/models.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/pydantic/classes/queries.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/pydantic/classes/queries_copy_override.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/pydantic/classes/queries_enum_override.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/pydantic/classes/queries_field_namings.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/pydantic/classes/queries_invalid_identifiers.pyis excluded by!test/driver_*/*/classes/**test/driver_asyncpg/pydantic/functions/__init__.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/pydantic/functions/enums.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/pydantic/functions/models.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/pydantic/functions/queries.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/pydantic/functions/queries_copy_override.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/pydantic/functions/queries_enum_override.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/pydantic/functions/queries_field_namings.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/pydantic/functions/queries_invalid_identifiers.pyis excluded by!test/driver_*/*/functions/**test/driver_asyncpg/sqlc-gen-better-python.wasmis excluded by!**/*.wasm,!**/*.wasmtest/driver_psycopg_async/attrs/classes/__init__.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/attrs/classes/enums.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/attrs/classes/models.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/attrs/classes/queries.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/attrs/classes/queries_copy_override.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/attrs/classes/queries_enum_override.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/attrs/classes/queries_field_namings.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/attrs/classes/queries_invalid_identifiers.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/attrs/functions/__init__.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/attrs/functions/enums.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/attrs/functions/models.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/attrs/functions/queries.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/attrs/functions/queries_copy_override.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/attrs/functions/queries_enum_override.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/attrs/functions/queries_field_namings.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/attrs/functions/queries_invalid_identifiers.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/dataclass/classes/__init__.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/dataclass/classes/enums.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/dataclass/classes/models.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/dataclass/classes/queries.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/dataclass/classes/queries_copy_override.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/dataclass/classes/queries_enum_override.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/dataclass/classes/queries_field_namings.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/dataclass/classes/queries_invalid_identifiers.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/dataclass/functions/__init__.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/dataclass/functions/enums.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/dataclass/functions/models.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/dataclass/functions/queries.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/dataclass/functions/queries_converters.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/dataclass/functions/queries_copy_override.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/dataclass/functions/queries_enum_override.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/dataclass/functions/queries_field_namings.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/dataclass/functions/queries_invalid_identifiers.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/msgspec/classes/__init__.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/msgspec/classes/enums.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/msgspec/classes/models.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/msgspec/classes/queries.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/msgspec/classes/queries_copy_override.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/msgspec/classes/queries_enum_override.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/msgspec/classes/queries_field_namings.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/msgspec/classes/queries_invalid_identifiers.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/msgspec/functions/__init__.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/msgspec/functions/enums.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/msgspec/functions/models.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/msgspec/functions/queries.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/msgspec/functions/queries_copy_override.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/msgspec/functions/queries_enum_override.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/msgspec/functions/queries_field_namings.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/msgspec/functions/queries_invalid_identifiers.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/omit_tc/classes/__init__.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/omit_tc/classes/enums.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/omit_tc/classes/models.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/omit_tc/classes/queries_enum_override.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/omit_tc/functions/__init__.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/omit_tc/functions/enums.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/omit_tc/functions/models.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/omit_tc/functions/queries_enum_override.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/pydantic/classes/__init__.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/pydantic/classes/enums.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/pydantic/classes/models.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/pydantic/classes/queries.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/pydantic/classes/queries_copy_override.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/pydantic/classes/queries_enum_override.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/pydantic/classes/queries_field_namings.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/pydantic/classes/queries_invalid_identifiers.pyis excluded by!test/driver_*/*/classes/**test/driver_psycopg_async/pydantic/functions/__init__.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/pydantic/functions/enums.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/pydantic/functions/models.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/pydantic/functions/queries.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/pydantic/functions/queries_copy_override.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/pydantic/functions/queries_enum_override.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/pydantic/functions/queries_field_namings.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/pydantic/functions/queries_invalid_identifiers.pyis excluded by!test/driver_*/*/functions/**test/driver_psycopg_async/sqlc-gen-better-python.wasmis excluded by!**/*.wasm,!**/*.wasmtest/driver_sqlite3/attrs/classes/__init__.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/attrs/classes/models.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/attrs/classes/queries.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/attrs/classes/queries_case.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/attrs/classes/queries_override_adapter.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/attrs/classes/queries_override_converter.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/attrs/classes/queries_unknown_override.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/attrs/functions/__init__.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/attrs/functions/models.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/attrs/functions/queries.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/attrs/functions/queries_case.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/attrs/functions/queries_override_adapter.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/attrs/functions/queries_override_converter.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/attrs/functions/queries_unknown_override.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/dataclass/classes/__init__.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/dataclass/classes/models.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/dataclass/classes/queries.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/dataclass/classes/queries_case.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/dataclass/classes/queries_override_adapter.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/dataclass/classes/queries_override_converter.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/dataclass/classes/queries_unknown_override.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/dataclass/functions/__init__.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/dataclass/functions/models.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/dataclass/functions/queries.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/dataclass/functions/queries_any_param.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/dataclass/functions/queries_case.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/dataclass/functions/queries_override_adapter.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/dataclass/functions/queries_override_converter.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/dataclass/functions/queries_slice.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/dataclass/functions/queries_unknown_override.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/msgspec/classes/__init__.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/msgspec/classes/models.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/msgspec/classes/queries.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/msgspec/classes/queries_case.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/msgspec/classes/queries_override_adapter.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/msgspec/classes/queries_override_converter.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/msgspec/classes/queries_unknown_override.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/msgspec/functions/__init__.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/msgspec/functions/models.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/msgspec/functions/queries.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/msgspec/functions/queries_case.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/msgspec/functions/queries_override_adapter.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/msgspec/functions/queries_override_converter.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/msgspec/functions/queries_unknown_override.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/pydantic/classes/__init__.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/pydantic/classes/models.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/pydantic/classes/queries.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/pydantic/classes/queries_case.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/pydantic/classes/queries_override_adapter.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/pydantic/classes/queries_override_converter.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/pydantic/classes/queries_unknown_override.pyis excluded by!test/driver_*/*/classes/**test/driver_sqlite3/pydantic/functions/__init__.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/pydantic/functions/models.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/pydantic/functions/queries.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/pydantic/functions/queries_case.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/pydantic/functions/queries_override_adapter.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/pydantic/functions/queries_override_converter.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/pydantic/functions/queries_unknown_override.pyis excluded by!test/driver_*/*/functions/**test/driver_sqlite3/sqlc-gen-better-python.wasmis excluded by!**/*.wasm,!**/*.wasmuv.lockis excluded by!**/*.lock
📒 Files selected for processing (70)
.changes/unreleased/Added-20260722-120000.yaml.github/workflows/ci.ymlREADME.mddocs/content/_index.mddocs/content/docs/_index.mddocs/content/docs/guide/_index.mddocs/content/docs/guide/configuration.mddocs/content/docs/guide/drivers.mddocs/content/docs/guide/writing-queries.mddocs/content/docs/reference/configuration-options.mddocs/content/docs/reference/feature-support.mdinternal/config/constants.gointernal/driver/asyncpg.gointernal/driver/common.gointernal/driver/common_test.gointernal/driver/driver.gointernal/driver/psycopg.gointernal/driver/psycopg_test.gointernal/driver/sqlite_base.gointernal/model/types.gointernal/render/imports.gointernal/render/imports_test.gointernal/render/queries.gointernal/render/render_queries_test.gointernal/transform/psycopg_sql.gointernal/transform/psycopg_sql_test.gointernal/transform/queries.gointernal/transform/queries_test.gointernal/writer/docstrings.gointernal/writer/docstrings_test.gointernal/writer/queryresults.gointernal/writer/queryresults_test.gonoxfile.pypyproject.tomlscripts/build/build.batscripts/build/build.shsqlc.yamltest/conftest.pytest/driver_aiosqlite/sqlc.yamltest/driver_asyncpg/sqlc.yamltest/driver_psycopg_async/__init__.pytest/driver_psycopg_async/attrs/__init__.pytest/driver_psycopg_async/attrs/ruff.tomltest/driver_psycopg_async/attrs/test_psycopg_attrs_classes.pytest/driver_psycopg_async/attrs/test_psycopg_attrs_functions.pytest/driver_psycopg_async/dataclass/__init__.pytest/driver_psycopg_async/dataclass/ruff.tomltest/driver_psycopg_async/dataclass/test_psycopg_dataclass_classes.pytest/driver_psycopg_async/dataclass/test_psycopg_dataclass_functions.pytest/driver_psycopg_async/msgspec/__init__.pytest/driver_psycopg_async/msgspec/ruff.tomltest/driver_psycopg_async/msgspec/test_psycopg_msgspec_classes.pytest/driver_psycopg_async/msgspec/test_psycopg_msgspec_functions.pytest/driver_psycopg_async/omit_tc/__init__.pytest/driver_psycopg_async/omit_tc/ruff.tomltest/driver_psycopg_async/omit_tc/test_omit_typechecking_import.pytest/driver_psycopg_async/omit_tc/test_omit_typechecking_runtime.pytest/driver_psycopg_async/pydantic/__init__.pytest/driver_psycopg_async/pydantic/ruff.tomltest/driver_psycopg_async/pydantic/test_psycopg_pydantic_classes.pytest/driver_psycopg_async/pydantic/test_psycopg_pydantic_functions.pytest/driver_psycopg_async/queries.sqltest/driver_psycopg_async/queries_converters.sqltest/driver_psycopg_async/queries_copy_override.sqltest/driver_psycopg_async/queries_enum_override.sqltest/driver_psycopg_async/queries_field_namings.sqltest/driver_psycopg_async/queries_invalid_identifiers.sqltest/driver_psycopg_async/schema.sqltest/driver_psycopg_async/sqlc.yamltest/driver_sqlite3/sqlc.yaml
Harden the psycopg-async CI job with read-only permissions and a credential-free checkout like the go jobs, and correct the copied psycopg test package docstrings that still said asyncpg.
Add the psycopg_async tab to all six synced driver tab groups in the quickstart, note that the $N placeholders are rewritten to psycopg's format at generation time, and give the drivers guide a sentence on choosing between the two PostgreSQL drivers.
Readers coming from sqlc's Go workflow look for emit_prepared_queries; a new section under Query commands explains that every supported driver already prepares statements automatically and shows the per-driver knobs, including the PgBouncer caveat.
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/content/docs/guide/drivers.md (1)
44-77: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winRemove the stale asyncpg-only
:copyfromclaim.This new section documents
psycopg_asyncsupport for:copyfrom, but the command-support text at Lines 121-122 still says:copyfromis asyncpg-only. Update that sentence to say that PostgreSQL drivers support:copyfrom; otherwise the page gives contradictory guidance.Proposed fix
- for example `:copyfrom` is asyncpg-only and `:execlastid` is SQLite-only. + for example `:copyfrom` is supported by PostgreSQL drivers and `:execlastid` is SQLite-only.🤖 Prompt for 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. In `@docs/content/docs/guide/drivers.md` around lines 44 - 77, Update the command-support statement in the drivers documentation to say that PostgreSQL drivers support :copyfrom, removing the asyncpg-only claim. Keep the existing explanation of bulk insertion behavior intact and ensure it aligns with the psycopg_async section.
🤖 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 `@docs/content/docs/getting-started.md`:
- Around line 470-471: Update the main example around AsyncConnection.connect to
manage the connection lifecycle with an async context manager or try/finally,
ensuring conn is closed on both normal and exceptional exits while preserving
the existing connection usage.
In `@docs/content/docs/guide/writing-queries.md`:
- Around line 162-164: Update the prepare_threshold explanation in the psycopg
documentation to state that server-side preparation occurs only after more than
the configured threshold executions, making the default 5 mean the sixth
execution. Preserve the documented special cases: 0 prepares on the first
execution and None disables preparation.
---
Outside diff comments:
In `@docs/content/docs/guide/drivers.md`:
- Around line 44-77: Update the command-support statement in the drivers
documentation to say that PostgreSQL drivers support :copyfrom, removing the
asyncpg-only claim. Keep the existing explanation of bulk insertion behavior
intact and ensure it aligns with the psycopg_async section.
🪄 Autofix (Beta)
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
Run ID: 555c3db7-8c05-4389-bafb-24910e6fa33f
📒 Files selected for processing (9)
.github/workflows/ci.ymldocs/content/docs/getting-started.mddocs/content/docs/guide/drivers.mddocs/content/docs/guide/writing-queries.mdtest/driver_psycopg_async/__init__.pytest/driver_psycopg_async/attrs/__init__.pytest/driver_psycopg_async/dataclass/__init__.pytest/driver_psycopg_async/msgspec/__init__.pytest/driver_psycopg_async/pydantic/__init__.py
The section now lives under Query commands in the feature support reference, replacing the stale not-planned bullet; the writing queries guide keeps a short note linking to it.
Manage the quickstart psycopg connection with a context manager, state precisely that prepare_threshold prepares after more than N executions (the sixth with the default of 5), and correct the copyfrom claim in the drivers guide to PostgreSQL-only.
Two psycopg emission shapes were not ruff format fixed points: an exploded :copyfrom row tuple now uses ruff's nested layout (one-line one-element tuples while they fit, exploded past that), and :one gets a dedicated emitter whose overlong tier is the nested-await layout, since its double-parenthesis tail is the one shape WriteWrappedCall cannot explode stably. With :one split out, writePsycopgCall's tail parameter became constant and is gone. Both layouts are verified against ruff format, and no committed fixture changes. The parameter dedup map additionally reserves _decode_hook for psycopg :many bodies, and the unsupported-command error names the sql_driver config value instead of driver.Name(), which differ for psycopg. Docs: the feature-support copyfrom callout no longer explains the command through asyncpg's API alone, the enums guide credits both PostgreSQL drivers, the drivers guide states the psycopg 3.2 floor, and the psycopg test suites drop a comment claiming cursor iteration requires a transaction - that constraint is asyncpg's.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds Psycopg 3 support:
sql_driver: "psycopg_async"generates asyncio code for psycopg with full asyncpg command parity -:one,:many,:exec,:execresult,:execrows, and:copyfrom(streamed throughcursor.copy(), with the cursor's rowcount as the return).:execlastidstays unsupported, as on asyncpg.Design
Placeholder rewrite. psycopg rejects PostgreSQL-native
$Nand scans the whole query text for pyformat placeholders (verified empirically). Parameterized queries are rewritten once at generation time by a scanner aware of string literals (including''doubling andE'...'escapes), quoted identifiers, dollar quoting, and nested block comments:$Nbecomes%(pN)sand every literal%doubles - psycopg requires that even inside SQL string literals. Parameters bind as a dict keyed by sqlc's parameter number, which makes$1reuse and ordering non-issues. Parameterless SQL is untouched, since psycopg leaves it unscanned.Type contract parity with asyncpg. The shared
postgresql.gomapping is reused, so models are identical across both postgres drivers.bytea/inet/cidrconvert inline exactly like asyncpg. Returnedjson/jsonbcolumns keep theirstrwire type by registering psycopg'sTextLoaderon the process-global adapters map per module (the sqliteregister_converterprecedent) - psycopg would otherwise parse them into dicts that cannot be passed back as parameters. Converters therefore behave identically on both postgres drivers.pyright strict. psycopg's typed API takes
LiteralStringquery text, so SQL constants emit astyping.Final[typing.LiteralString]for this driver andQueryResultsannotates itssqlparameter and attribute to match. The connection annotation ispsycopg.AsyncConnection[psycopg.rows.TupleRow], so a connection configured with a non-tuple row factory is rejected statically.Named-params QueryResults. A new class-header variant carries a params dict instead of
*args. Overlong dicts hoist into a localsql_params, and that name joinsconn/self/sqlin the parameter dedup map so a column of the same name cannot be clobbered.Semantics worth knowing
:execrowsreturns the cursor'srowcount, which is-1for statements likeCREATE TABLE(asyncpg's status parse yields0).:execresultreturns theAsyncCursor; the status tag iscursor.statusmessage.QueryResultsiteration decodes row by row but does not stream from the server (asyncpg remains the streaming option).SelectorEventLoop; the conftest installs the policy for local test runs, and the drivers docs note it.Test coverage
test/driver_psycopg_async/mirroringdriver_asyncpg: all four model types x classes/functions, byte-checked bysqlc diff(psycopg_async_check), pyright strict, ruff, andruff formatstability.autocommit=Trueto match asyncpg's per-statement semantics; fixed-ID constants are offset so the suites can share the database.psycopg-asyncCI job wired intoci-done.Docs
Drivers guide section, feature-support matrix column, configuration reference, README, and landing pages updated. Getting-started's synced driver tabs include psycopg_async, and the feature support reference documents per-driver prepared-statement behavior.
Summary by CodeRabbit
psycopg_asyncas an additional PostgreSQL driver (4 total), generating asyncio-based Python for Psycopg 3.manyiteration,COPY/:copyfromstreaming, and:execlastidsupport.json/jsonbreturn handling and improved generated query typing compatibility.psycopg_async.psycopg_async.psycopg-asyncverification checks and Nox sessions.