Skip to content

Commit bfb7f00

Browse files
Expand dqlitedbapi.aio README to enumerate full re-export surface
The "Differences from aiosqlite" section claimed dqlitedbapi.aio mirrors only "apilevel, paramstyle, connect, aconnect, AsyncConnection, AsyncCursor" — significantly under-specified versus the actual surface, which includes the full PEP 249 exception hierarchy, type constructors, type sentinels, and the stdlib-sqlite3-parity stubs. A reader checking porting parity from aiosqlite would think they needed to import exception classes from dqlitedbapi directly when they're already on dqlitedbapi.aio. Update the README to enumerate the full re-export surface. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 4685eda commit bfb7f00

1 file changed

Lines changed: 15 additions & 3 deletions

File tree

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,21 @@ Connection-level `commit()` / `rollback()` semantics:
104104
## Differences from `aiosqlite`
105105

106106
This driver is PEP 249-shaped (sync) and exposes an async surface
107-
under `dqlitedbapi.aio` that mirrors aiosqlite's module-level shape
108-
(`apilevel`, `paramstyle`, `connect`, `aconnect`, `AsyncConnection`,
109-
`AsyncCursor`). One notable deviation:
107+
under `dqlitedbapi.aio` that mirrors the sync `dqlitedbapi` surface
108+
plus async-specific `aconnect` / `AsyncConnection` / `AsyncCursor`.
109+
110+
The full PEP 249 module attributes (`apilevel`, `threadsafety`,
111+
`paramstyle`, `sqlite_version`, `sqlite_version_info`), exception
112+
hierarchy (`Warning`, `Error`, `InterfaceError`, `DatabaseError`,
113+
`DataError`, `OperationalError`, `IntegrityError`, `InternalError`,
114+
`ProgrammingError`, `NotSupportedError`), type constructors
115+
(`Date`, `Time`, `Timestamp`, `DateFromTicks`, `TimeFromTicks`,
116+
`TimestampFromTicks`, `Binary`), type sentinels (`STRING`, `BINARY`,
117+
`NUMBER`, `DATETIME`, `ROWID`), and stdlib-sqlite3-parity stubs
118+
(`register_adapter`, `register_converter`, `complete_statement`,
119+
`enable_callback_tracebacks`) are all re-exported under
120+
`dqlitedbapi.aio` so cross-driver code porting from aiosqlite
121+
imports them from one namespace. One notable deviation:
110122

111123
- **`AsyncConnection.__aexit__` does NOT close the connection.** It
112124
commits / rolls back per the body outcome and leaves the

0 commit comments

Comments
 (0)