Skip to content

[PyMySQL] Correct cursor fetch result containers #16773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
iamabhisheknag wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[PyMySQL] Correct cursor fetch result containers #16773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions stubs/PyMySQL/@tests/test_cases/check_cursors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
from typing import Any
from typing_extensions import assert_type

from pymysql.cursors import Cursor, DictCursor, SSCursor, SSDictCursor


def check_fetch_results(cursor: Cursor, dictionary: DictCursor, streaming: SSCursor, stream_dictionary: SSDictCursor) -> None:
# Mixin and streaming overrides must preserve both the row type and container.
assert_type(cursor.fetchall(), tuple[tuple[Any, ...], ...] | list[tuple[Any, ...]])
assert_type(dictionary.fetchall(), list[dict[str, Any]] | tuple[()])
assert_type(dictionary.fetchmany(), list[dict[str, Any]] | tuple[()])
assert_type(streaming.fetchmany(), list[tuple[Any, ...]] | tuple[()])
assert_type(stream_dictionary.fetchmany(), list[dict[str, Any]] | tuple[()])
assert_type(stream_dictionary.fetchall(), list[dict[str, Any]])
10 changes: 6 additions & 4 deletions stubs/PyMySQL/pymysql/cursors.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,26 +45,28 @@ class Cursor:
# Methods returning result tuples are below.
def fetchone(self) -> tuple[Any, ...] | None: ...
def fetchmany(self, size: int | None = None) -> tuple[tuple[Any, ...], ...]: ...
def fetchall(self) -> tuple[tuple[Any, ...], ...]: ...
def fetchall(self) -> tuple[tuple[Any, ...], ...] | list[tuple[Any, ...]]: ...
def __iter__(self) -> Iterator[tuple[Any, ...]]: ...
def __next__(self): ...

class DictCursorMixin:
dict_type: Any # TODO: add support if someone needs this
def fetchone(self) -> dict[str, Any] | None: ...
def fetchmany(self, size: int | None = ...) -> tuple[dict[str, Any], ...]: ...
def fetchall(self) -> tuple[dict[str, Any], ...]: ...
def fetchmany(self, size: int | None = ...) -> list[dict[str, Any]] | tuple[()]: ...
def fetchall(self) -> list[dict[str, Any]] | tuple[()]: ...
def __iter__(self) -> Iterator[dict[str, Any]]: ...

class SSCursor(Cursor):
def __del__(self) -> None: ...
def read_next(self) -> tuple[Any, ...] | None: ...
def fetchall(self) -> list[tuple[Any, ...]]: ... # type: ignore[override]
def fetchmany(self, size: int | None = None) -> list[tuple[Any, ...]] | tuple[()]: ... # type: ignore[override]
def fetchall(self) -> list[tuple[Any, ...]]: ...
def fetchall_unbuffered(self) -> Iterator[tuple[Any, ...]]: ...
def scroll(self, value: int, mode: str = "relative") -> None: ...

class DictCursor(DictCursorMixin, Cursor): ... # type: ignore[misc] # pyrefly: ignore [inconsistent-inheritance]

class SSDictCursor(DictCursorMixin, SSCursor): # type: ignore[misc] # pyrefly: ignore [inconsistent-inheritance]
def fetchall(self) -> list[dict[str, Any]]: ... # type: ignore[override]
def fetchall_unbuffered(self) -> Iterator[dict[str, Any]]: ... # type: ignore[override]
def read_next(self) -> dict[str, Any] | None: ... # type: ignore[override]
Loading