Ratchet up mypy settings

Author: tamird

email_validator/__main__.py

@@ -17,6 +17,7 @@
 import json
 import os
 import sys
+from typing import Any, Dict
 
 from .validate_email import validate_email
 from .deliverability import caching_resolver
@@ -27,7 +28,7 @@ def main(dns_resolver=None):
     # The dns_resolver argument is for tests.
 
     # Set options from environment variables.
-    options = {}
+    options: Dict[str, Any] = {}
     for varname in ('ALLOW_SMTPUTF8', 'ALLOW_QUOTED_LOCAL', 'ALLOW_DOMAIN_LITERAL',
                     'GLOBALLY_DELIVERABLE', 'CHECK_DELIVERABILITY', 'TEST_ENVIRONMENT'):
         if varname in os.environ:

email_validator/deliverability.py

@@ -1,4 +1,4 @@
-from typing import Optional, Any, Dict
+from typing import Any, Dict, Optional
 
 import ipaddress
 
@@ -8,17 +8,17 @@
 import dns.exception
 
 
-def caching_resolver(*, timeout: Optional[int] = None, cache=None, dns_resolver=None):
+def caching_resolver(*, timeout: Optional[int] = None, cache: Any = None, dns_resolver: Optional[dns.resolver.Resolver] = None) -> dns.resolver.Resolver:
     if timeout is None:
         from . import DEFAULT_TIMEOUT
         timeout = DEFAULT_TIMEOUT
     resolver = dns_resolver or dns.resolver.Resolver()
-    resolver.cache = cache or dns.resolver.LRUCache()  # type: ignore
-    resolver.lifetime = timeout  # type: ignore # timeout, in seconds
+    resolver.cache = cache or dns.resolver.LRUCache()
+    resolver.lifetime = timeout  # timeout, in seconds
     return resolver
 
 
-def validate_email_deliverability(domain: str, domain_i18n: str, timeout: Optional[int] = None, dns_resolver=None):
+def validate_email_deliverability(domain: str, domain_i18n: str, timeout: Optional[int] = None, dns_resolver: Optional[dns.resolver.Resolver] = None) -> Dict[str, str]:
     # Check that the domain resolves to an MX record. If there is no MX record,
     # try an A or AAAA record which is a deprecated fallback for deliverability.
     # Raises an EmailUndeliverableError on failure. On success, returns a dict

email_validator/exceptions_types.py

@@ -1,5 +1,5 @@
 import warnings
-from typing import Optional
+from typing import List, Optional, Tuple
 
 
 class EmailNotValidError(ValueError):
@@ -56,7 +56,7 @@ class ValidatedEmail:
 
     """If a deliverability check is performed and if it succeeds, a list of (priority, domain)
     tuples of MX records specified in the DNS for the domain."""
-    mx: list
+    mx: List[Tuple[int, str]]
 
     """If no MX records are actually specified in DNS and instead are inferred, through an obsolete
     mechanism, from A or AAAA records, the value is the type of DNS record used instead (`A` or `AAAA`)."""

email_validator/syntax.py

@@ -7,7 +7,7 @@
 import unicodedata
 import idna  # implements IDNA 2008; Python's codec is only IDNA 2003
 import ipaddress
-from typing import Optional
+from typing import Optional, TypedDict, Union
 
 
 def split_email(email):
@@ -180,8 +180,14 @@ def safe_character_display(c):
     return unicodedata.name(c, h)
 
 
+class LocalPartValidationResult(TypedDict):
+    local_part: str
+    ascii_local_part: Optional[str]
+    smtputf8: bool
+
+
 def validate_email_local_part(local: str, allow_smtputf8: bool = True, allow_empty_local: bool = False,
-                              quoted_local_part: bool = False):
+                              quoted_local_part: bool = False) -> LocalPartValidationResult:
     """Validates the syntax of the local part of an email address."""
 
     if len(local) == 0:
@@ -626,6 +632,8 @@ def validate_email_domain_literal(domain_literal):
     # a compressed/normalized address.
     # RFC 5321 4.1.3 and RFC 5322 3.4.1.
 
+    addr: Union[ipaddress.IPv4Address, ipaddress.IPv6Address]
+
     # Try to parse the domain literal as an IPv4 address.
     # There is no tag for IPv4 addresses, so we can never
     # be sure if the user intends an IPv4 address.

email_validator/validate_email.py

@@ -1,9 +1,15 @@
-from typing import Optional, Union
+from typing import Optional, Union, TYPE_CHECKING
 
 from .exceptions_types import EmailSyntaxError, ValidatedEmail
 from .syntax import split_email, validate_email_local_part, validate_email_domain_name, validate_email_domain_literal, validate_email_length
 from .rfc_constants import CASE_INSENSITIVE_MAILBOX_NAMES
 
+if TYPE_CHECKING:
+    import dns.resolver
+    _Resolver = dns.resolver.Resolver
+else:
+    _Resolver = object
+
 
 def validate_email(
     email: Union[str, bytes],
@@ -18,7 +24,7 @@ def validate_email(
     test_environment: Optional[bool] = None,
     globally_deliverable: Optional[bool] = None,
     timeout: Optional[int] = None,
-    dns_resolver: Optional[object] = None
+    dns_resolver: Optional[_Resolver] = None
 ) -> ValidatedEmail:
     """
     Given an email address, and some options, returns a ValidatedEmail instance

pyproject.toml

@@ -1,3 +1,16 @@
+[tool.mypy]
+disallow_any_generics = true
+disallow_subclassing_any = true
+
+check_untyped_defs = true
+disallow_incomplete_defs = true
+# disallow_untyped_calls = true
+disallow_untyped_decorators = true
+# disallow_untyped_defs = true
+
+warn_redundant_casts = true
+warn_unused_ignores = true
+
 [tool.pytest.ini_options]
 markers = [
     "network: marks tests as requiring Internet access",

tests/mocked_dns_response.py

@@ -20,9 +20,11 @@
 class MockedDnsResponseData:
     DATA_PATH = os.path.dirname(__file__) + "/mocked-dns-answers.json"
 
+    INSTANCE = None
+
     @staticmethod
     def create_resolver():
-        if not hasattr(MockedDnsResponseData, 'INSTANCE'):
+        if MockedDnsResponseData.INSTANCE is None:
             # Create a singleton instance of this class and load the saved DNS responses.
             # Except when BUILD_MOCKED_DNS_RESPONSE_DATA is true, don't load the data.
             singleton = MockedDnsResponseData()
@@ -116,6 +118,6 @@ def put(self, key, value):
 @pytest.fixture(scope="session", autouse=True)
 def MockedDnsResponseDataCleanup(request):
     def cleanup_func():
-        if BUILD_MOCKED_DNS_RESPONSE_DATA:
+        if BUILD_MOCKED_DNS_RESPONSE_DATA and MockedDnsResponseData.INSTANCE is not None:
             MockedDnsResponseData.INSTANCE.save()
     request.addfinalizer(cleanup_func)