Exposing a version str & deprecating the email attribute (#110)

* expose version as __version__

* assist ValidatedEmail.email deprecation

Author: commonism

email_validator/__init__.py

@@ -4,12 +4,12 @@
 from .exceptions_types import ValidatedEmail, EmailNotValidError, \
                               EmailSyntaxError, EmailUndeliverableError
 from .validate_email import validate_email
-
+from .version import __version__
 
 __all__ = ["validate_email",
            "ValidatedEmail", "EmailNotValidError",
            "EmailSyntaxError", "EmailUndeliverableError",
-           "caching_resolver"]
+           "caching_resolver", "__version__"]
 
 
 def caching_resolver(*args, **kwargs):

email_validator/exceptions_types.py

@@ -78,6 +78,13 @@ def __getattr__(self, key):
             return self.normalized
         raise AttributeError()
 
+    @property
+    def email(self):
+        import warnings
+        warnings.warn("ValidatedEmail.email is deprecated and will be removed, use ValidatedEmail.normalized instead", DeprecationWarning)
+        return self.normalized
+
+
     """For backwards compatibility, some fields are also exposed through a dict-like interface. Note
     that some of the names changed when they became attributes."""
     def __getitem__(self, key):

email_validator/version.py

@@ -0,0 +1 @@
+__version__ = "2.0.0.post2"

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = email_validator
-version = 2.0.0.post2
+version = attr: email_validator.version.__version__
 description = A robust email address syntax and deliverability validation library.
 long_description = file: README.md
 long_description_content_type = text/markdown

tests/test_main.py

@@ -58,3 +58,10 @@ def test_bytes_input():
     input_email = "testaddr中example.tld".encode("utf32")
     with pytest.raises(EmailSyntaxError):
         validate_email(input_email, check_deliverability=False)
+
+
+def test_deprecation():
+    input_email = b"[email protected]"
+    valid_email = validate_email(input_email, check_deliverability=False)
+    with pytest.raises(DeprecationWarning):
+        assert valid_email.email is not None