-
-
Notifications
You must be signed in to change notification settings - Fork 2k
Expand file tree
/
Copy pathheaderregistry.pyi
More file actions
193 lines (172 loc) · 6.51 KB
/
Copy pathheaderregistry.pyi
File metadata and controls
193 lines (172 loc) · 6.51 KB
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
import sys
import types
from collections.abc import Iterable, Mapping
from datetime import datetime as _datetime
from email._header_value_parser import (
AddressList,
ContentDisposition,
ContentTransferEncoding,
ContentType,
MessageID,
MIMEVersion,
TokenList,
UnstructuredTokenList,
)
from email.errors import MessageDefect
from email.policy import Policy
from typing import Any, ClassVar, Literal, Protocol, type_check_only
from typing_extensions import Self
class BaseHeader(str):
# max_count is actually more of an abstract ClassVar (not defined on the base class, but expected to be defined in subclasses)
max_count: ClassVar[Literal[1] | None]
@property
def name(self) -> str: ...
@property
def defects(self) -> tuple[MessageDefect, ...]: ...
def __new__(cls, name: str, value: Any) -> Self: ...
def init(self, name: str, *, parse_tree: TokenList, defects: Iterable[MessageDefect]) -> None: ...
def fold(self, *, policy: Policy) -> str: ...
class UnstructuredHeader:
max_count: ClassVar[Literal[1] | None]
@staticmethod
def value_parser(value: str) -> UnstructuredTokenList: ...
@classmethod
def parse(cls, value: str, kwds: dict[str, Any]) -> None: ...
class UniqueUnstructuredHeader(UnstructuredHeader):
max_count: ClassVar[Literal[1]]
class DateHeader:
max_count: ClassVar[Literal[1] | None]
def init(self, name: str, *, parse_tree: TokenList, defects: Iterable[MessageDefect], datetime: _datetime) -> None: ...
@property
def datetime(self) -> _datetime | None: ...
@staticmethod
def value_parser(value: str) -> UnstructuredTokenList: ...
@classmethod
def parse(cls, value: str | _datetime, kwds: dict[str, Any]) -> None: ...
class UniqueDateHeader(DateHeader):
max_count: ClassVar[Literal[1]]
class AddressHeader:
max_count: ClassVar[Literal[1] | None]
def init(self, name: str, *, parse_tree: TokenList, defects: Iterable[MessageDefect], groups: Iterable[Group]) -> None: ...
@property
def groups(self) -> tuple[Group, ...]: ...
@property
def addresses(self) -> tuple[Address, ...]: ...
@staticmethod
def value_parser(value: str) -> AddressList: ...
@classmethod
def parse(cls, value: str, kwds: dict[str, Any]) -> None: ...
class UniqueAddressHeader(AddressHeader):
max_count: ClassVar[Literal[1]]
class SingleAddressHeader(AddressHeader):
@property
def address(self) -> Address: ...
class UniqueSingleAddressHeader(SingleAddressHeader):
max_count: ClassVar[Literal[1]]
class MIMEVersionHeader:
max_count: ClassVar[Literal[1]]
def init(
self,
name: str,
*,
parse_tree: TokenList,
defects: Iterable[MessageDefect],
version: str | None,
major: int | None,
minor: int | None,
) -> None: ...
@property
def version(self) -> str | None: ...
@property
def major(self) -> int | None: ...
@property
def minor(self) -> int | None: ...
@staticmethod
def value_parser(value: str) -> MIMEVersion: ...
@classmethod
def parse(cls, value: str, kwds: dict[str, Any]) -> None: ...
class ParameterizedMIMEHeader:
max_count: ClassVar[Literal[1]]
def init(self, name: str, *, parse_tree: TokenList, defects: Iterable[MessageDefect], params: Mapping[str, Any]) -> None: ...
@property
def params(self) -> types.MappingProxyType[str, Any]: ...
@classmethod
def parse(cls, value: str, kwds: dict[str, Any]) -> None: ...
class ContentTypeHeader(ParameterizedMIMEHeader):
@property
def content_type(self) -> str: ...
@property
def maintype(self) -> str: ...
@property
def subtype(self) -> str: ...
@staticmethod
def value_parser(value: str) -> ContentType: ...
class ContentDispositionHeader(ParameterizedMIMEHeader):
# init is redefined but has the same signature as parent class, so is omitted from the stub
@property
def content_disposition(self) -> str | None: ...
@staticmethod
def value_parser(value: str) -> ContentDisposition: ...
class ContentTransferEncodingHeader:
max_count: ClassVar[Literal[1]]
def init(self, name: str, *, parse_tree: TokenList, defects: Iterable[MessageDefect]) -> None: ...
@property
def cte(self) -> str: ...
@classmethod
def parse(cls, value: str, kwds: dict[str, Any]) -> None: ...
@staticmethod
def value_parser(value: str) -> ContentTransferEncoding: ...
class MessageIDHeader:
max_count: ClassVar[Literal[1]]
@classmethod
def parse(cls, value: str, kwds: dict[str, Any]) -> None: ...
@staticmethod
def value_parser(value: str) -> MessageID: ...
if sys.version_info >= (3, 13):
from email._header_value_parser import MessageIDList
# Added in Python 3.13.12, 3.14.3
class ReferencesHeader:
max_count: ClassVar[Literal[1]]
@classmethod
def parse(cls, value: str, kwds: dict[str, Any]) -> None: ...
@staticmethod
def value_parser(value: str) -> MessageIDList: ...
@type_check_only
class _HeaderParser(Protocol):
max_count: ClassVar[Literal[1] | None]
@staticmethod
def value_parser(value: str, /) -> TokenList: ...
@classmethod
def parse(cls, value: str, kwds: dict[str, Any], /) -> None: ...
class HeaderRegistry:
registry: dict[str, type[_HeaderParser]]
base_class: type[BaseHeader]
default_class: type[_HeaderParser]
def __init__(
self, base_class: type[BaseHeader] = ..., default_class: type[_HeaderParser] = ..., use_default_map: bool = True
) -> None: ...
def map_to_type(self, name: str, cls: type[BaseHeader]) -> None: ...
def __getitem__(self, name: str) -> type[BaseHeader]: ...
def __call__(self, name: str, value: Any) -> BaseHeader: ...
class Address:
@property
def display_name(self) -> str: ...
@property
def username(self) -> str: ...
@property
def domain(self) -> str: ...
@property
def addr_spec(self) -> str: ...
def __init__(
self, display_name: str = "", username: str | None = "", domain: str | None = "", addr_spec: str | None = None
) -> None: ...
__hash__: ClassVar[None] # type: ignore[assignment]
def __eq__(self, other: object) -> bool: ...
class Group:
@property
def display_name(self) -> str | None: ...
@property
def addresses(self) -> tuple[Address, ...]: ...
def __init__(self, display_name: str | None = None, addresses: Iterable[Address] | None = None) -> None: ...
__hash__: ClassVar[None] # type: ignore[assignment]
def __eq__(self, other: object) -> bool: ...