Add type stubs for email module and backend components

Author: al-chris

emails/__init__.pyi

@@ -0,0 +1,10 @@
+from typing import Any, Optional, Union, Tuple, List, Dict, Callable
+from .message import Message as Message, html as html
+from .utils import MessageID as MessageID
+
+__title__: str
+__version__: str
+__author__: str
+__license__: str
+__copyright__: str
+USER_AGENT: str

emails/backend/__init__.pyi

@@ -0,0 +1,2 @@
+from .factory import ObjectFactory as ObjectFactory
+from .smtp import SMTPBackend as SMTPBackend

emails/backend/factory.pyi

@@ -0,0 +1,12 @@
+from typing import Any, Dict, Type, TypeVar
+
+T = TypeVar('T')
+
+def simple_dict2str(d: Dict[str, Any]) -> str: ...
+
+class ObjectFactory:
+    cls: Type[Any]
+    pool: Dict[str, Any]
+    def __init__(self, cls: Type[Any]) -> None: ...
+    def __getitem__(self, k: Dict[str, Any]) -> Any: ...
+    def invalidate(self, k: Dict[str, Any]) -> Any: ...

emails/backend/response.pyi

@@ -0,0 +1,27 @@
+from typing import Any, Optional, List, Dict, Tuple
+
+class Response:
+    backend: Any
+    _exc: Optional[Exception]
+    from_addr: Optional[str]
+    to_addrs: Optional[List[str]]
+    _finished: bool
+    def __init__(self, exception: Optional[Exception] = ..., backend: Any = ...) -> None: ...
+    def set_exception(self, exc: Exception) -> None: ...
+    def raise_if_needed(self) -> None: ...
+    @property
+    def error(self) -> Optional[Exception]: ...
+    @property
+    def success(self) -> bool: ...
+
+class SMTPResponse(Response):
+    responses: List[Any]
+    esmtp_opts: Optional[List[str]]
+    rcpt_options: Optional[List[str]]
+    status_code: Optional[int]
+    status_text: Optional[str]
+    last_command: Optional[str]
+    refused_recipient: Dict[str, Any]
+    refused_recipients: Dict[str, Any]
+    def __init__(self, exception: Optional[Exception] = ..., backend: Any = ...) -> None: ...
+    def set_status(self, command: str, code: int, text: str, **kwargs: Any) -> None: ...

emails/backend/smtp/__init__.pyi

@@ -0,0 +1 @@
+from .backend import SMTPBackend as SMTPBackend

emails/backend/smtp/backend.pyi

@@ -0,0 +1,25 @@
+from typing import Any, Optional, Dict, List, Type, Callable
+from ..response import SMTPResponse
+from .client import SMTPClientWithResponse, SMTPClientWithResponse_SSL
+
+class SMTPBackend:
+    DEFAULT_SOCKET_TIMEOUT: int
+    connection_cls: Type[SMTPClientWithResponse]
+    connection_ssl_cls: Type[SMTPClientWithResponse_SSL]
+    response_cls: Type[SMTPResponse]
+    smtp_cls: Type[Any]
+    ssl: bool
+    tls: Optional[bool]
+    smtp_cls_kwargs: Dict[str, Any]
+    host: Optional[str]
+    port: Optional[int]
+    fail_silently: bool
+    mail_options: List[str]
+    _client: Optional[Any]
+
+    def __init__(self, ssl: bool = ..., fail_silently: bool = ..., mail_options: Optional[List[str]] = ..., **kwargs: Any) -> None: ...
+    def get_client(self) -> Any: ...
+    def close(self) -> None: ...
+    def make_response(self, exception: Optional[Exception] = ...) -> SMTPResponse: ...
+    def retry_on_disconnect(self, func: Callable[..., Any]) -> Callable[..., Any]: ...
+    def _send(self, **kwargs: Any) -> Any: ...

emails/backend/smtp/client.pyi

@@ -0,0 +1,34 @@
+from typing import Any, Union, Sequence
+from smtplib import SMTP, SMTP_SSL
+
+class SMTPClientWithResponse(SMTP):
+    parent: Any
+    make_response: Any
+    tls: bool
+    ssl: bool
+    debug: int
+    # user: str
+    # password: str
+    _initialized: bool
+    initialized: bool
+    def __init__(self, parent: Any, **kwargs: Any) -> None: ...
+    def initialize(self) -> None: ...
+    def quit(self) -> Any: ...
+    def _rset(self) -> None: ...
+    def sendmail(self, from_addr: str, to_addrs: Union[str, Sequence[str]], msg: Any, mail_options: Sequence[str] = ..., rcpt_options: Sequence[str] = ...) -> Any: ...
+
+class SMTPClientWithResponse_SSL(SMTP_SSL):
+    parent: Any
+    make_response: Any
+    tls: bool
+    ssl: bool
+    debug: int
+    # user: str
+    # password: str
+    _initialized: bool
+    initialized: bool
+    def __init__(self, parent: Any, **kwargs: Any) -> None: ...
+    def initialize(self) -> None: ...
+    def quit(self) -> Any: ...
+    def _rset(self) -> None: ...
+    def sendmail(self, from_addr: str, to_addrs: Union[str, Sequence[str]], msg: Any, mail_options: Sequence[str] = ..., rcpt_options: Sequence[str] = ...) -> Any: ...

emails/django/__init__.pyi

@@ -0,0 +1,17 @@
+from typing import Any, Optional, List, Union, Dict
+from ..message import MessageTransformerMixin, MessageSignMixin, MessageBuildMixin, BaseMessage
+
+class DjangoMessageMixin:
+    _recipients: Optional[List[str]]
+    _from_email: Optional[str]
+    @property
+    def encoding(self) -> str: ...
+    def recipients(self) -> List[str]: ...
+    @property
+    def from_email(self) -> str: ...
+    def _set_emails(self, mail_to: Optional[Union[str, List[str]]] = ..., set_mail_to: bool = ..., mail_from: Optional[str] = ..., set_mail_from: bool = ..., to: Optional[Union[str, List[str]]] = ...) -> None: ...
+    def send(self, mail_to: Optional[Union[str, List[str]]] = ..., set_mail_to: bool = ..., mail_from: Optional[str] = ..., set_mail_from: bool = ..., context: Optional[Dict[str, Any]] = ..., connection: Optional[Any] = ..., to: Optional[Union[str, List[str]]] = ...) -> Any: ...
+
+class DjangoMessage(DjangoMessageMixin, MessageTransformerMixin, MessageSignMixin, MessageBuildMixin, BaseMessage): ...
+
+Message = DjangoMessage

emails/django_.pyi

@@ -0,0 +1 @@
+from .django import *

emails/exc.pyi

@@ -0,0 +1,5 @@
+from .packages.dkim import DKIMException as DKIMException
+
+class HTTPLoaderError(Exception): ...
+class BadHeaderError(ValueError): ...
+class IncompleteMessage(ValueError): ...