Skip to content

Commit af9b46a

Browse files
gruebelAkuli
andauthored
add missing type hints in http.cookiejar (#5797)
Co-authored-by: Akuli <[email protected]>
1 parent 0baeef0 commit af9b46a

File tree

1 file changed

+29
-7
lines changed

1 file changed

+29
-7
lines changed

stdlib/http/cookiejar.pyi

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
import sys
22
from _typeshed import StrPath
33
from http.client import HTTPResponse
4-
from typing import Dict, Iterable, Iterator, Optional, Sequence, Tuple, TypeVar, Union, overload
4+
from typing import ClassVar, Dict, Iterable, Iterator, Optional, Pattern, Sequence, Tuple, TypeVar, Union, overload
55
from urllib.request import Request
66

77
_T = TypeVar("_T")
88

99
class LoadError(OSError): ...
1010

1111
class CookieJar(Iterable[Cookie]):
12+
non_word_re: ClassVar[Pattern[str]] = ... # undocumented
13+
quote_re: ClassVar[Pattern[str]] = ... # undocumented
14+
strict_domain_re: ClassVar[Pattern[str]] = ... # undocumented
15+
domain_re: ClassVar[Pattern[str]] = ... # undocumented
16+
dots_re: ClassVar[Pattern[str]] = ... # undocumented
17+
magic_re: ClassVar[Pattern[str]] = ... # undocumented
1218
def __init__(self, policy: Optional[CookiePolicy] = ...) -> None: ...
1319
def add_cookie_header(self, request: Request) -> None: ...
1420
def extract_cookies(self, response: HTTPResponse, request: Request) -> None: ...
@@ -18,8 +24,11 @@ class CookieJar(Iterable[Cookie]):
1824
def set_cookie_if_ok(self, cookie: Cookie, request: Request) -> None: ...
1925
def clear(self, domain: Optional[str] = ..., path: Optional[str] = ..., name: Optional[str] = ...) -> None: ...
2026
def clear_session_cookies(self) -> None: ...
27+
def clear_expired_cookies(self) -> None: ... # undocumented
2128
def __iter__(self) -> Iterator[Cookie]: ...
2229
def __len__(self) -> int: ...
30+
def __repr__(self) -> str: ...
31+
def __str__(self) -> str: ...
2332

2433
class FileCookieJar(CookieJar):
2534
filename: str
@@ -36,7 +45,8 @@ class FileCookieJar(CookieJar):
3645
def load(self, filename: Optional[str] = ..., ignore_discard: bool = ..., ignore_expires: bool = ...) -> None: ...
3746
def revert(self, filename: Optional[str] = ..., ignore_discard: bool = ..., ignore_expires: bool = ...) -> None: ...
3847

39-
class MozillaCookieJar(FileCookieJar): ...
48+
class MozillaCookieJar(FileCookieJar):
49+
header: ClassVar[str] = ... # undocumented
4050

4151
class LWPCookieJar(FileCookieJar):
4252
def as_lwp_str(self, ignore_discard: bool = ..., ignore_expires: bool = ...) -> str: ... # undocumented
@@ -58,11 +68,11 @@ class DefaultCookiePolicy(CookiePolicy):
5868
strict_ns_domain: int
5969
strict_ns_set_initial_dollar: bool
6070
strict_ns_set_path: bool
61-
DomainStrictNoDots: int
62-
DomainStrictNonDomain: int
63-
DomainRFC2965Match: int
64-
DomainLiberal: int
65-
DomainStrict: int
71+
DomainStrictNoDots: ClassVar[int]
72+
DomainStrictNonDomain: ClassVar[int]
73+
DomainRFC2965Match: ClassVar[int]
74+
DomainLiberal: ClassVar[int]
75+
DomainStrict: ClassVar[int]
6676
if sys.version_info >= (3, 8):
6777
def __init__(
6878
self,
@@ -102,6 +112,18 @@ class DefaultCookiePolicy(CookiePolicy):
102112
def allowed_domains(self) -> Optional[Tuple[str, ...]]: ...
103113
def set_allowed_domains(self, allowed_domains: Optional[Sequence[str]]) -> None: ...
104114
def is_not_allowed(self, domain: str) -> bool: ...
115+
def set_ok_version(self, cookie: Cookie, request: Request) -> bool: ... # undocumented
116+
def set_ok_verifiability(self, cookie: Cookie, request: Request) -> bool: ... # undocumented
117+
def set_ok_name(self, cookie: Cookie, request: Request) -> bool: ... # undocumented
118+
def set_ok_path(self, cookie: Cookie, request: Request) -> bool: ... # undocumented
119+
def set_ok_domain(self, cookie: Cookie, request: Request) -> bool: ... # undocumented
120+
def set_ok_port(self, cookie: Cookie, request: Request) -> bool: ... # undocumented
121+
def return_ok_version(self, cookie: Cookie, request: Request) -> bool: ... # undocumented
122+
def return_ok_verifiability(self, cookie: Cookie, request: Request) -> bool: ... # undocumented
123+
def return_ok_secure(self, cookie: Cookie, request: Request) -> bool: ... # undocumented
124+
def return_ok_expires(self, cookie: Cookie, request: Request) -> bool: ... # undocumented
125+
def return_ok_port(self, cookie: Cookie, request: Request) -> bool: ... # undocumented
126+
def return_ok_domain(self, cookie: Cookie, request: Request) -> bool: ... # undocumented
105127

106128
class Cookie:
107129
version: Optional[int]

0 commit comments

Comments
 (0)