mirror of
https://github.com/davidhalter/django-stubs.git
synced 2026-01-30 14:45:24 +08:00
* Make module declaration precise. * Make settings match real file. * Replace `include` with import. * Make types more specific. * Replace `WSGIRequest` with `HttpRequest` where possible. * Replace all `OrderedDict` occurrences with plain `Dict` (it is not used in Django 3.2 and later) * Add fake datastructures for convenience: _PropertyDescriptor and _ListOrTuple now can live here. Added _IndexableCollection (often useful as alias for 'sequence or queryset') * Actualize other datastructures. * Rework MultiValueDict to reflect the fact that some methods can return empty list instead of value. * Deprecate SafeText in favor of SafeString. * Minor improvements to utils * Disallow using str in TimeFormat and DateFormat, drop removed fmt `B` * Do not let classproperty expect classmethod, make return value covariant. * Sync with real file. * Improve types for timezone. * Sync deprecated, new and removed features in translation utils. * Drop removed files, sync huge deprecations. * Fix incompatible decorators (properties, contextmanagers) * Rework pagination. * Sync validators with real code. Add _ValidatorCallable for any external use (field validation etc.) * Add shared type definitions (for fields of both forms and models). Actualize model fields. Mark keyword-only args explicitly in stubs (where code uses **kwargs). Disallow bytes for verbose_name. * Make all checks return Sequence[CheckMessage] or subclass to be covariant. * Add bidirectional references between backend.base and other files. Replace some Any's with specific types. * Actualize db.migrations: remove removed methods, replace "None" annotations in wrong places, improve some wrong annotations. * Actualize db.utils to match real file. * Replace FileResponse and TemplateResponse with HttpResponse(Base) where needed: at least HttpResponseNotModified/HttpResponseRedirect can be returned instead of it, so annotation was wrong. * Replace Any in forms where possible. Actualize class bases and method arguments. * Improve typing of serializers. * Actualize views, rename variable bound to Model to _M for consistency. * Make types of file-related code consistent. Disallow using bytes as path, because many methods expect str-only paths. Make File inherit from IO[AnyStr] instead of IO[Any]: it makes impossible to instantiate file of union type, but allows precise types for some methods. * Minor improvements: stop using None as annotation in wrong places, replace obvious Any's with precise types, actualize methods (missing/renamed/signature changed). * Allow less specific containers, replace Any's with specific types. * Improve types for requests and responses. * Use AbstractBaseUser instead of User in auth. * Use broader type for permission_required * Use wider container types. Add 'type: ignore' to avoid issues with mypy.stubtest. * Disallow using backend class as argument (it is passed to import_string). * Add required methods to PasseordValidator. * Allow using Path instance as argument. * Actualize methods. * Add 'type: ignore' to avoid issues with mypy.stubtest. * Replace Any's with specific types and BaseForm with ModelForm. * Actualize contrib.postgres * Remove render_to_response, add 'get_absolute_url' to corresponding protocol. * Actualize signers. * Use precise types for handlers. Disallow str as stream type for LimitedStream. * Exact types for ValidationError * Replace wrong used Union with Sequence. * Actualize static handlers. * More specific types for admin. Fixes #874. * Improve types and replace 'Tags' with str (it isn't Enum, so annotation was wrong). * Replace Any with specific types, actualize signatures. * Add async variants of handlers and clients. Use fake class to distinguish between request types in RequestFactory and AsyncRequestFactory. * Fix signature, minor improvements. * Actualize signatures and class names, replace Any with more specific types. * Fix signature. * Add some missing methods to Collector * Combinable rarely returns Self type: almost always it's CombinedExpression. * No Random in source anymore. * Drop removed SimpleCol. * Replace _OutputField with Field: nothing in docs about strings. * Introduce reusable types, add missing methods. Remove strange types (probably created by stubgen). Remove RawQuery from Compiler: it obviously doesn't work with RawQuery. * Use literal constants. * Actualize base classes. * Callable is not accepted by get_field. * Add precise types. * Use property and broader containers where possible. Add missing methods. * Actualize indexes. * More specific types for signals. * Fix signatures, drop missing methods. * Actualize window functions to match source. * Actualize text functions, add missing methods, use type aliases for consistency. * Add missing property decorators, methods and attributes. Use type aliases. Remove absent YearComparisonLookup and any SafeText references (they aren't related to lookups at all). * Use bound TypeVar, mark all BuiltinLookup descendants as generic explicitly. Remove strange Union from Lookup.__init__ * Apply type alias, fix base class and argument name. * Actualize BaseExpression methods. * Fix imports. * Add missing class and fix incompatible bases. * Use same types in __init__ and attribute. * OrderBy accepts F or Expression. * Non-expressions are converted to Values. * Add missing attributes. * Add missing methods, fix 'None' argument type. * Define properties where possible, remove 'None' argument annotations, remove inadequate type in make_immutable_fields_list. * Remove absent QueryWrapper. Replace some Any with precise types. * Fix wrong types and actualize signatures. Deny ManagerDescriptor.__get__ on model instances. * Use more specific types. * Arity can be None in subclasses. * Reformat with black * Make DeletionMixin generic. * Fix wrong type variable in _RequestFactory. * Fix variable name in signature. * Disallow returning None from Form.clean() * Allow again returning None from Form.clean * Drop some unused imports. * Add tests for MultiValueDict. * Add tests for utils.timezone. * Fix #834. * Add more files to import_all test * Allow None for `context_object_name` * Fix CI * Fix test to work on python 3.8
124 lines
4.6 KiB
Python
124 lines
4.6 KiB
Python
from email import charset as Charset
|
|
from email._policybase import Policy
|
|
from email.message import Message
|
|
from email.mime.base import MIMEBase
|
|
from email.mime.message import MIMEMessage
|
|
from email.mime.multipart import MIMEMultipart
|
|
from email.mime.text import MIMEText
|
|
from typing import Any, Dict, List, Optional, Sequence, Set, Tuple, Union, overload
|
|
|
|
utf8_charset: Any
|
|
utf8_charset_qp: Any
|
|
DEFAULT_ATTACHMENT_MIME_TYPE: str
|
|
RFC5322_EMAIL_LINE_LENGTH_LIMIT: int
|
|
|
|
class BadHeaderError(ValueError): ...
|
|
|
|
ADDRESS_HEADERS: Set[str]
|
|
|
|
def forbid_multi_line_headers(name: str, val: str, encoding: str) -> Tuple[str, str]: ...
|
|
def sanitize_address(addr: Union[Tuple[str, str], str], encoding: str) -> str: ...
|
|
|
|
class MIMEMixin:
|
|
def as_string(self, unixfrom: bool = ..., linesep: str = "\n") -> str: ...
|
|
def as_bytes(self, unixfrom: bool = ..., linesep: str = "\n") -> bytes: ...
|
|
|
|
class SafeMIMEMessage(MIMEMixin, MIMEMessage): # type: ignore
|
|
defects: List[Any]
|
|
epilogue: Any
|
|
policy: Policy
|
|
preamble: Any
|
|
def __setitem__(self, name: str, val: str) -> None: ...
|
|
|
|
class SafeMIMEText(MIMEMixin, MIMEText): # type: ignore
|
|
defects: List[Any]
|
|
epilogue: None
|
|
policy: Policy
|
|
preamble: None
|
|
encoding: str = ...
|
|
def __init__(self, _text: str, _subtype: str = ..., _charset: str = ...) -> None: ...
|
|
def __setitem__(self, name: str, val: str) -> None: ...
|
|
def set_payload(
|
|
self, payload: Union[List[Message], str, bytes], charset: Union[str, Charset.Charset, None] = ...
|
|
) -> None: ...
|
|
|
|
class SafeMIMEMultipart(MIMEMixin, MIMEMultipart): # type: ignore
|
|
defects: List[Any]
|
|
epilogue: None
|
|
policy: Policy
|
|
preamble: None
|
|
encoding: str = ...
|
|
def __init__(
|
|
self,
|
|
_subtype: str = ...,
|
|
boundary: Optional[Any] = ...,
|
|
_subparts: Optional[Any] = ...,
|
|
encoding: str = ...,
|
|
**_params: Any
|
|
) -> None: ...
|
|
def __setitem__(self, name: str, val: str) -> None: ...
|
|
|
|
_AttachmentContent = Union[bytes, EmailMessage, Message, SafeMIMEText, str]
|
|
_AttachmentTuple = Union[
|
|
Tuple[str, _AttachmentContent], Tuple[Optional[str], _AttachmentContent, str], Tuple[str, _AttachmentContent, None]
|
|
]
|
|
|
|
class EmailMessage:
|
|
content_subtype: str = ...
|
|
mixed_subtype: str = ...
|
|
encoding: Any = ...
|
|
to: List[str] = ...
|
|
cc: List[Any] = ...
|
|
bcc: List[Any] = ...
|
|
reply_to: List[Any] = ...
|
|
from_email: str = ...
|
|
subject: str = ...
|
|
body: str = ...
|
|
attachments: List[Any] = ...
|
|
extra_headers: Dict[Any, Any] = ...
|
|
connection: Any = ...
|
|
def __init__(
|
|
self,
|
|
subject: str = ...,
|
|
body: Optional[str] = ...,
|
|
from_email: Optional[str] = ...,
|
|
to: Optional[Sequence[str]] = ...,
|
|
bcc: Optional[Sequence[str]] = ...,
|
|
connection: Optional[Any] = ...,
|
|
attachments: Optional[Sequence[Union[MIMEBase, _AttachmentTuple]]] = ...,
|
|
headers: Optional[Dict[str, str]] = ...,
|
|
cc: Optional[Sequence[str]] = ...,
|
|
reply_to: Optional[Sequence[str]] = ...,
|
|
) -> None: ...
|
|
def get_connection(self, fail_silently: bool = ...) -> Any: ...
|
|
# TODO: when typeshed gets more types for email.Message, move it to MIMEMessage, now it has too many false-positives
|
|
def message(self) -> Any: ...
|
|
def recipients(self) -> List[str]: ...
|
|
def send(self, fail_silently: bool = ...) -> int: ...
|
|
@overload
|
|
def attach(self, filename: MIMEBase = ..., content: None = ..., mimetype: None = ...) -> None: ...
|
|
@overload
|
|
def attach(self, filename: None = ..., content: _AttachmentContent = ..., mimetype: str = ...) -> None: ...
|
|
@overload
|
|
def attach(self, filename: str = ..., content: _AttachmentContent = ..., mimetype: Optional[str] = ...) -> None: ...
|
|
def attach_file(self, path: str, mimetype: Optional[str] = ...) -> None: ...
|
|
|
|
class EmailMultiAlternatives(EmailMessage):
|
|
alternative_subtype: str = ...
|
|
alternatives: List[Tuple[_AttachmentContent, str]] = ...
|
|
def __init__(
|
|
self,
|
|
subject: str = ...,
|
|
body: str = ...,
|
|
from_email: Optional[str] = ...,
|
|
to: Optional[Sequence[str]] = ...,
|
|
bcc: Optional[Sequence[str]] = ...,
|
|
connection: Optional[Any] = ...,
|
|
attachments: Optional[Sequence[Union[MIMEBase, _AttachmentTuple]]] = ...,
|
|
headers: Optional[Dict[str, str]] = ...,
|
|
alternatives: Optional[List[Tuple[_AttachmentContent, str]]] = ...,
|
|
cc: Optional[Sequence[str]] = ...,
|
|
reply_to: Optional[Sequence[str]] = ...,
|
|
) -> None: ...
|
|
def attach_alternative(self, content: _AttachmentContent, mimetype: str) -> None: ...
|