File: cookiejar.pyi

package info (click to toggle)
mypy 0.470-complete-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 5,864 kB
  • ctags: 3,264
  • sloc: python: 21,838; makefile: 18
file content (112 lines) | stat: -rw-r--r-- 4,806 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# Stubs for http.cookiejar (Python 3.4)

from typing import Iterable, Iterator, Optional, Sequence, Tuple, TypeVar, Union, overload
from http.client import HTTPResponse
import sys
from urllib.request import Request

_T = TypeVar('_T')

if sys.version_info >= (3, 3):
    class LoadError(OSError): ...
else:
    class LoadError(IOError): ...


class CookieJar(Iterable['Cookie']):
    def __init__(self, policy: Optional['CookiePolicy'] = ...) -> None: ...
    def add_cookie_header(self, request: Request) -> None: ...
    def extract_cookies(self, response: HTTPResponse,
                        request: Request) -> None: ...
    def set_policy(self, policy: 'CookiePolicy') -> None: ...
    def make_cookies(self, response: HTTPResponse,
                     request: Request) -> Sequence['Cookie']: ...
    def set_cookie(self, cookie: 'Cookie') -> None: ...
    def set_cookie_if_ok(self, cookie: 'Cookie',
                         request: Request) -> None: ...
    def clear(self, domain: str = ..., path: str = ...,
              name: str = ...) -> None: ...
    def clear_session_cookies(self) -> None: ...
    def __iter__(self) -> Iterator['Cookie']: ...

class FileCookieJar(CookieJar):
    filename = ...  # type: str
    delayload = ...  # type: bool
    def __init__(self, filename: str = ..., delayload: bool = ...,
                 policy: Optional['CookiePolicy'] = ...) -> None: ...
    def save(self, filename: Optional[str] = ..., ignore_discard: bool = ...,
             ignore_expires: bool = ...) -> None: ...
    def load(self, filename: Optional[str] = ..., ignore_discard: bool = ...,
             ignore_expires: bool = ...) -> None: ...
    def revert(self, filename: Optional[str] = ..., ignore_discard: bool = ...,
               ignore_expires: bool = ...) -> None: ...

class MozillaCookieJar(FileCookieJar): ...
class LWPCookieJar(FileCookieJar): ...


class CookiePolicy:
    netscape = ...  # type: bool
    rfc2965 = ...  # type: bool
    hide_cookie2 = ...  # type: bool
    def set_ok(self, cookie: 'Cookie', request: Request) -> bool: ...
    def return_ok(self, cookie: 'Cookie', request: Request) -> bool: ...
    def domain_return_ok(self, domain: str, request: Request) -> bool: ...
    def path_return_ok(self, path: str, request: Request) -> bool: ...


class DefaultCookiePolicy(CookiePolicy):
    rfc2109_as_netscape = ...  # type: bool
    strict_domain = ...  # type: bool
    strict_rfc2965_unverifiable = ...  # type: bool
    strict_ns_unverifiable = ...  # type: bool
    strict_ns_domain = ...  # type: int
    strict_ns_set_initial_dollar = ...  # type: bool
    strict_ns_set_path = ...  # type: bool
    DomainStrictNoDots = ...  # type: int
    DomainStrictNonDomain = ...  # type: int
    DomainRFC2965Match = ...  # type: int
    DomainLiberal = ...  # type: int
    DomainStrict = ...  # type: int
    def __init__(self, blocked_domains: Optional[Sequence[str]] = ...,
                 allowed_domains: Optional[Sequence[str]] = ...,
                 netscape: bool = ...,
                 rfc2965: bool = ...,
                 rfc2109_as_netscape: Optional[bool] = ...,
                 hide_cookie2: bool = ..., strict_domain: bool = ...,
                 strict_rfc2965_unverifiable: bool =...,
                 strict_ns_unverifiable: bool = ...,
                 strict_ns_domain: int = ...,
                 strict_ns_set_initial_dollar: bool = ...,
                 strict_ns_set_path: bool = ...) -> None: ...
    def blocked_domains(self) -> Tuple[str, ...]: ...
    def set_blocked_domains(self, blocked_domains: Sequence[str]) -> None: ...
    def is_blocked(self, domain: str) -> bool: ...
    def allowed_domains(self) -> Optional[Tuple[str, ...]]: ...
    def set_allowed_domains(self, allowed_domains: Optional[Sequence[str]]) \
                            -> None: ...
    def is_not_allowed(self, domain: str) -> bool: ...


class Cookie:
    version = ...  # type: Optional[int]
    name = ...  # type: str
    value = ...  # type: Optional[str]
    port = ...  # type: Optional[str]
    path = ...  # type: str
    secure = ...  # type: bool
    expires = ...  # type: Optional[int]
    discard = ...  # type: bool
    comment = ...  # type: Optional[str]
    comment_url = ...  # type: Optional[str]
    rfc2109 = ...  # type: bool
    port_specified = ...  # type: bool
    domain_specified = ...  # type: bool
    domain_initial_dot = ...  # type: bool
    def has_nonstandard_attr(self, name: str) -> bool: ...
    @overload
    def get_nonstandard_attr(self, name: str) -> Optional[str]: ...
    @overload
    def get_nonstandard_attr(self, name: str, default: _T = ...) -> Union[str, _T]: ...
    def set_nonstandard_attr(self, name: str, value: str) -> None: ...
    def is_expired(self, now: int = ...) -> bool: ...