use email_validator library for Email validator instead of regex #429

alanhamlett · 2018-07-05T00:16:36Z

Implements outcome of conversation in #427 using email_validator to validate email address.

davidism · 2018-07-05T14:32:52Z

src/wtforms/validators.py


-    def __init__(self, message=None):
+    def __init__(self, message=None, **options):


options needs a mention in the docstring.

davidism · 2018-07-05T14:32:52Z

src/wtforms/validators.py

@@ -2,6 +2,7 @@

 import re
 import uuid
+from email_validator import validate_email, EmailNotValidError


Should this be optional like ipaddress?

I prefer just adding a hard dependency since email validation is very common, but maybe I don't know the history of why ipaddress is optional. What are the benefits of making it optional? Consistency with ipaddress?

If you don't use email validation (I don't for many projects), you now have an extra dependency that you don't use. I'd prefer an optional dependency since email validation isn't required to making WTForms work.

I don't recall exactly why, but I think using CC0 for a license is potentially problematic, so forcing users to install email_validator could cause licensing issues as well.

Made optional with a2a7afe. Also, added extras for both email_validator and ipaddress dependencies so they can be installed at the same time as wtforms. Removed locale extra since Babel is already a required dependency, so there's no reason for having it in extras.

davidism · 2018-07-07T21:26:29Z

setup.py

-    extras_require={"locale": ["Babel"]},
+    install_requires=["MarkupSafe"],
+    extras_require={
+        "ipaddress": ["ipaddress"],


Not sure what the syntax is, but this should only apply to Python 2.

Extras are just ways to define optional dependencies, so it's up to the user to install wtforms with various extras or not depending on what they need and their environment. Not sure if we can specify extras only available for Python 2.

I'll see if this works:

https://setuptools.readthedocs.io/en/latest/setuptools.html#declaring-platform-specific-dependencies

I think this would work:

'ipaddress:python_version < "3"': ["ipaddress"],

It works! Tested 50a0c3c on Python 2.7 and Python 3.6 both with pip install -e .[ipaddress] and ipaddress was only installed on Python 2.7.

Oh, didn't see your last comment. I'll update to < 3.

davidism · 2018-07-07T21:42:55Z

setup.py

@@ -100,7 +100,7 @@ class BDistWheel(CompileCatalogMixin, BaseBDistWheel):
    setup_requires=["Babel>=2.6.0"],
    install_requires=["MarkupSafe"],
    extras_require={
-        "ipaddress": ['ipaddress;python_version<="2.7"'],
+        "ipaddress": ['ipaddress;python_version<"3"'],


Uhh, not to drag this out too long, but technically this should be "<3.3". 😓 Then again, we don't support <3.4, so... 🤷‍♂️

Updated with 325367f. 👍

Not sure if you've seen the latest push, and don't want to merge without full review.

alanhamlett · 2018-07-17T11:30:16Z

Should be ready to merge now.

One thing to consider is improving install docs to mention extras, but that could be another PR.

WTForms requires this dependency now. This was changed back in June 2018 (wtforms/wtforms#429) but has only just been released now.

This involves three changes which broke our code. To validate email addresses, the optional dependency `email-validator` must be installed1. But since we don’t use WTForms’ email validation, we shouldn’t need to do this. Instead this commit makes our own `EmailField`, which just handles rendering the field as an email field, not validating that (because we add the validation elsewhere). When rendering textareas, and extra `\r\n` is inserted at the beginning 2. Browsers will strip this when displaying the textbox and submitting the form, but some of our tests need updating to account for this. The error message for when you don’t choose an option from some radio buttons has now changed. Rather than just accepting WTForms’ new message, this commit makes the error messages like the examples from the Design System3. By default it will say ‘Select an option’, but by passing in an extra parameter (`thing`) it can be customised to be more specific, for example ‘Select a type of organisation’. *** 1. wtforms/wtforms#429 2. wtforms/wtforms#238 3. https://design-system.service.gov.uk/components/radios/#error-messages

This involves three changes which broke our code. To validate email addresses, the optional dependency `email-validator` must be installed1. But since we don’t use WTForms’ email validation, we shouldn’t need to subclass it – it can just be its own self contained thing. Then we don’t need to add the extra dependency. When rendering textareas, and extra `\r\n` is inserted at the beginning 2. Browsers will strip this when displaying the textbox and submitting the form, but some of our tests need updating to account for this. The error message for when you don’t choose an option from some radio buttons has now changed. Rather than just accepting WTForms’ new message, this commit makes the error messages like the examples from the Design System3. By default it will say ‘Select an option’, but by passing in an extra parameter (`thing`) it can be customised to be more specific, for example ‘Select a type of organisation’. *** 1. wtforms/wtforms#429 2. wtforms/wtforms#238 3. https://design-system.service.gov.uk/components/radios/#error-messages

alanhamlett mentioned this pull request Jul 5, 2018

Fix a bug in email validation #427

Closed

alanhamlett force-pushed the ahamlett-email_validation_using_library branch from 4d9e165 to ff2a179 Compare Jul 5, 2018

davidism reviewed Jul 5, 2018

View changes

alanhamlett force-pushed the ahamlett-email_validation_using_library branch from ff2a179 to c5ab624 Compare Jul 5, 2018

alanhamlett added 4 commits Jul 5, 2018

use email_validator library for Email validator instead of regex

c5ab624

explicitly define options

e272b7a

make email_validator libarary optional

a2a7afe

blackify setup.py

bc60c71

davidism reviewed Jul 7, 2018

View changes

alanhamlett added 2 commits Jul 7, 2018

only install ipaddress for Python less than or equal 2.7

50a0c3c

compare python version less than 3

46f57f5

davidism reviewed Jul 7, 2018

View changes

ipaddress needed for Python less than 3.3

325367f

alanhamlett merged commit 283b280 into wtforms:master Jul 22, 2018
1 check passed

alanhamlett deleted the ahamlett-email_validation_using_library branch Jul 22, 2018

azmeuk mentioned this pull request Apr 18, 2020

Backported fixes from branch master to branch 2.2-maintenance #565

Merged

azmeuk added a commit to azmeuk/wtforms that referenced this issue Apr 20, 2020

Backported wtforms#429

3044f4f

quis added a commit to alphagov/notifications-admin that referenced this issue Apr 22, 2020

Install email_validator dependency

5ce2906

WTForms requires this dependency now. This was changed back in June 2018 (wtforms/wtforms#429) but has only just been released now.

quis mentioned this pull request Apr 23, 2020

Bump WTForms to 2.3.1 alphagov/notifications-admin#3424

Merged

fenekku mentioned this pull request Apr 23, 2020

dependencies: cap wtforms until fixed upstream inveniosoftware/cookiecutter-invenio-rdm#66

Merged

greyli mentioned this pull request Sep 18, 2020

Add email-validator into install requires wtforms/flask-wtf#421

Closed

use email_validator library for Email validator instead of regex #429

use email_validator library for Email validator instead of regex #429

alanhamlett commented Jul 5, 2018

davidism Jul 5, 2018

davidism Jul 5, 2018

alanhamlett Jul 5, 2018 •

edited

davidism Jul 7, 2018

alanhamlett Jul 7, 2018

davidism Jul 7, 2018

alanhamlett Jul 7, 2018

alanhamlett Jul 7, 2018

davidism Jul 7, 2018

alanhamlett Jul 7, 2018

alanhamlett Jul 7, 2018

davidism Jul 7, 2018

alanhamlett Jul 7, 2018

alanhamlett Jul 10, 2018

alanhamlett commented Jul 17, 2018


		def __init__(self, message=None):
		def __init__(self, message=None, **options):

use email_validator library for Email validator instead of regex #429

use email_validator library for Email validator instead of regex #429

Conversation

alanhamlett commented Jul 5, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alanhamlett Jul 5, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alanhamlett commented Jul 17, 2018

alanhamlett Jul 5, 2018 •

edited