Skip to content

Fix RequestsCookieJar iterator type #15890

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
popsiclelmlm wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −0
Open

Fix RequestsCookieJar iterator type #15890

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
11 changes: 11 additions & 0 deletions stubs/requests/@tests/test_cases/check_cookies.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
from collections.abc import Iterator
from http.cookiejar import Cookie
from typing_extensions import assert_type

from requests.cookies import RequestsCookieJar

jar = RequestsCookieJar()
jar["a"] = "b"

assert_type(iter(jar), Iterator[Cookie])
assert_type(next(iter(jar)), Cookie)
Comment on lines +1 to +11

@srittau srittau Jun 11, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While it makes sense to me to have a test in this case, because of the complicated inheritance situation, since typeshed tests are never run and only ever type checked, these tests can be slightly simplified:

Suggested change
from collections.abc import Iterator
from http.cookiejar import Cookie
from typing_extensions import assert_type
from requests.cookies import RequestsCookieJar
jar = RequestsCookieJar()
jar["a"] = "b"
assert_type(iter(jar), Iterator[Cookie])
assert_type(next(iter(jar)), Cookie)
from collections.abc import Iterator
from http.cookiejar import Cookie
from typing_extensions import assert_type
from requests.cookies import RequestsCookieJar
jar = RequestsCookieJar()
assert_type(iter(jar), Iterator[Cookie])

1 change: 1 addition & 0 deletions stubs/requests/requests/cookies.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ def remove_cookie_by_name(cookiejar, name, domain=None, path=None): ...
class CookieConflictError(RuntimeError): ...

class RequestsCookieJar(CookieJar, MutableMapping[str, str]): # type: ignore[misc] # conflicting __iter__ in the base classes
def __iter__(self) -> Iterator[Cookie]: ... # type: ignore[override]
def get(self, name: str, default: str | None = None, domain: str | None = None, path: str | None = None) -> str | None: ... # type: ignore[override]
def set(self, name: str, value: str | Morsel[dict[str, str]], **kwargs) -> Cookie | None: ...
def iterkeys(self) -> Iterator[str]: ...
Expand Down
Loading