Async validators + Recaptcha #14

omarryhan · 2018-12-24T03:08:02Z

#13

New features:

Support for async and sync validators
testing py37

The code I added isn't of best quality, especially the tests. This is only meant to be a prototype.

I think in order to merge this feature, we'd have to go 1 of the following paths:

Break backward compatibility and make validate_on_submit a coroutine.
Keep both validate_on_submit and validate_on_submit_async (maybe name it differently). However, if we do this, then the user shouldn't call validate_on_submit_async followed by validate_on_submit, because validate_on_submit_async will do lots of monkey patching (We can have some sort of flag though that explicitly enables this functionality).
Make a new SanicForm class. Maybe call it SanicForm_ or sth
Do nothing 😄

now testing py37

Added tests coverage

Added pytest-asyncio in the list of dev dependencies Added tests for wtforms patching

… the synchronous validate on submit method

omarryhan · 2018-12-24T20:16:45Z

So, I did some cleanup. I think the only thing missing is patching FieldList. If left as is, then it will only be called synchronously by any given form. However, it will fail if any of it's methods are coroutines as they will not be awaited. Basically, as long as you don't use custom FieldList with coroutines in it, you're fine.

As for the tests coverage, I think I covered the main use cases. There might be some untested edge cases though, so if someone can help me spot some, it would be great.

Minor fixes

Updated readme Bumped version to 0.7 100% backward compatible changes More tests. Coverage at 86% Docs still do not reflect the changes in the repo

pyx · 2019-01-02T01:44:52Z

Thanks for the feature, I was very busy lately, I did not have time to go through the code right now, do you mind give me sometime. Thanks again.

omarryhan · 2019-01-02T02:06:55Z

Sure, np! :)

Docstring fix

Better typing in Recaptcha field More efficient recaptcha validator Using isawaitable instead of iscoroutinefunction

pyx · 2019-06-07T20:32:25Z

Hi Omar, sorry that I was super busy lately, it seems you put a lot of effort into this, I will go through this in a few days.

Thank you so much.

…tes in wtforms

pyx · 2020-12-14T23:28:10Z

Hi Omar Ryhan
I am sorry I failed in manage time to update the project, are you still interested in using this? If you are interested, I will put you into collaborators list.

pyx · 2020-12-16T00:44:50Z

@mikekeda How about this one, @omarryhan invested a lot of time into this, what's your thought?

pyx · 2020-12-16T01:07:05Z

@mikekeda I at OP accidentally in last post.

omarryhan · 2020-12-18T22:29:32Z

Hey @pyx. No worries.

I only passively maintain the Sanic projects I was working on. The Sanic team recently introduced some breaking changes to the request context API and I'm not really sure whether my PR might break things or not. My Sanic projects are still running on their latest LTS version which differs from their latest version. I'm pip installing from my own sanic-wtf repo, and things are working fine.

I suggest we leave this PR open until someone shows some interest and maybe tests things out on the latest Sanic version, then maybe we can merge it?

omarryhan · 2020-12-18T22:39:22Z

I must also add that I monkey patched some of wtform's private methods to make this lib support async validations. The downside of this that wtforms cannot guarantee us that they won't break their private APIs. So I hard-coded the wtforms version to avoid things breaking. One downside of that is that we'll not be getting the latest security patches from wtforms should there be any.

pyx · 2020-12-19T01:35:06Z

@omarryhan you are right, relying on private API is fragile to say the least and we should try to avoid. We will wait and see.

Please remember to add your name in AUTHOR with next commit, not necessarily this one but can be something like a separate one updating python versions tested upon, you have the commit rights.
Thank you.

mikekeda · 2020-12-26T13:11:06Z

.travis.yml

+install:
+  pip install tox-travis
+script: 
+  tox


add a new line to the end

mikekeda · 2020-12-26T13:15:50Z

sanic_wtf/__init__.py


-__version__ = '0.6.0.dev0'
+from ._patch import patch
+from .recaptcha import RecaptchaField


it's better to use absolute imports

mikekeda · 2020-12-26T13:17:43Z

sanic_wtf/__init__.py

@@ -110,7 +114,6 @@ def getlist(self, name, default=None):
        """
        return super().get(name, default)

-


according to pep8 here should be 2 blank lines, no need to remove 1 blank line
https://www.python.org/dev/peps/pep-0008/#blank-lines

mikekeda · 2020-12-26T13:22:26Z

sanic_wtf/__init__.py

    def validate_on_submit(self):
+        ''' For async validators: use self.validate_on_submit_async.
+            This method is only still here for backward compatibility
+        '''


use double quotes for all docstring
https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring

mikekeda · 2020-12-26T13:26:21Z

sanic_wtf/_patch.py

+    self._errors = None
+    success = True
+    for name, field in self._fields.items():
+        if extra_validators is not None and name in extra_validators:


it's more pythonic to use if extra_validators instead of extra_validators is not None
but be aware that for example if 0 returns False and if 0 is not None returns True

mikekeda · 2020-12-26T13:56:26Z

tests/test_recaptcha.py

+    _base_config = {'WTF_CSRF_ENABLED': False}
+    test_app = App({**_base_config, **config})
+    return Request(test_app)
+


add 1 blank line before each top level function
(here should be 2 blank lines in total - https://www.python.org/dev/peps/pep-0008/#blank-lines)

mikekeda · 2020-12-26T13:56:44Z

tests/test_recaptcha.py

+        def __init__(self, config):
+            self.config = config
+
+


remove 1 blank line

mikekeda · 2020-12-26T13:59:24Z

sanic_wtf/recaptcha.py

+    widget = recaptcha_widget
+
+    def __init__(self, label='Recaptcha', extra_validators: Union[list, tuple, set]=None, **kwargs):
+        validators = set([recaptcha_validator])


validators = {recaptcha_validator}
will be more pythonic

mikekeda · 2020-12-26T14:01:57Z

sanic_wtf/recaptcha.py

+
+    widget = recaptcha_widget
+
+    def __init__(self, label='Recaptcha', extra_validators: Union[list, tuple, set]=None, **kwargs):


add spaces before and after = if you use typing
should be extra_validators: Union[list, tuple, set] = None instead of extra_validators: Union[list, tuple, set]=None

mikekeda · 2020-12-26T14:03:43Z

tox.ini

 deps = -rrequirements-dev.txt
-commands = py.test
+commands = 
+    ./clear_pycache.sh 


why do we nee to clear pycache?

mikekeda · 2020-12-26T14:08:49Z

@mikekeda How about this one, @omarryhan invested a lot of time into this, what's your thought?

I think it's better to split this into 2 RPs Async validators and Recaptcha
monkey patching doesn't look good to me, can we create a separate class for this?
What performance improvement we will get with Async validators?
I don't think it's a good idea to make RECAPTCHA required, it's better to make it optional (in RECAPTCHA_PUBLIC_KEY and RECAPTCHA_PRIVATE_KEY are marked as required)
Why clear and clear_pycache.sh are committed?

omarryhan · 2020-12-26T23:20:14Z

Thanks for taking the time to review @mikekeda

I added async not for the performance gain but to be able to call async code for validations, like querying a database to check if an email exists.

I'll address these issues once people show enough interest in the PR. Right now, it seems like I'm the only one using it.

omarryhan added 9 commits December 24, 2018 04:53

async validate_on_submit prototype

831039e

now testing py37

Improved tests structure

6428966

Added tests coverage

More async validators tests

cf202cf

Added support for async field.post and pre validators

fb9c9b5

Added pytest-asyncio in the list of dev dependencies Added tests for wtforms patching

Added Travis CI

47cce97

Fix travis 3.7

7438ce5

Fix travis 3.7

98f3ed2

Sanic-wtf will now fail if a user patches wtforms and continues using…

fead664

… the synchronous validate on submit method

Sanic-wtf will now fail if a user patches wtforms and continues using…

0b8e672

… the synchronous validate on submit method

omarryhan changed the title ~~Don't merge me~~ Async validators Dec 24, 2018

omarryhan added 3 commits December 25, 2018 00:23

Pytest now warns if any

f615ce3

Minor fixes

added doctstings

32b0504

Added support for Recaptcha

cf5e7e6

Updated readme Bumped version to 0.7 100% backward compatible changes More tests. Coverage at 86% Docs still do not reflect the changes in the repo

omarryhan changed the title ~~Async validators~~ Async validators + Recaptcha Dec 26, 2018

omarryhan added 12 commits December 27, 2018 00:24

Documented Recaptcha integration

ebed361

100% recaptcha test cov

81f066e

Recaptcha docstrings

5d60b72

Minor docstring fix

cd44950

Fixed typo

1ca89dc

Fixed typo

6f2d1c4

Moved config_prefix into kwargs

d8d41ee

added test for config prefix

5030040

Fixed more typos

3689f31

Removed unused patching code

796b53e

Added option for JS only

3579e29

Validators now validate in order. Cov @94%

1797632

Replaced recaptcha's validators param with extra_validaors

bdcc7b0

omarryhan added 8 commits February 28, 2019 06:02

recaptcha field passing list instead of set to super()

a92cf50

Better recaptcha json/form error handling

51b0782

Recaptcha only using aiorecaptcha's error msg not the full error object

cbc1e24

Fixed test

7078a2d

More efficient recaptcha validator

238f1ad

Minor optimization tweak

41cda4f

Docstring fix

Updated README

804d94b

Better typing in Recaptcha field More efficient recaptcha validator Using isawaitable instead of iscoroutinefunction

Removed commented code

76d143f

omarryhan added 5 commits June 27, 2019 17:09

Drop Python3.5 dependancy

53d3e28

Hardcoded wtforms version to avoid breakage of patching logic on upda…

e62ff7c

…tes in wtforms

Bumped version

c4df028

Remove python 3.5 testing from .travis yaml

714e7f6

More descriptive code comments

41c24f0

pyx added the enhancement label Dec 19, 2020

mikekeda requested changes Dec 26, 2020

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Async validators + Recaptcha #14

Async validators + Recaptcha #14

omarryhan commented Dec 24, 2018

omarryhan commented Dec 24, 2018

pyx commented Jan 2, 2019

omarryhan commented Jan 2, 2019

pyx commented Jun 7, 2019

pyx commented Dec 14, 2020

pyx commented Dec 16, 2020 •

edited

Loading

pyx commented Dec 16, 2020

omarryhan commented Dec 18, 2020

omarryhan commented Dec 18, 2020

pyx commented Dec 19, 2020

mikekeda Dec 26, 2020

mikekeda Dec 26, 2020

mikekeda Dec 26, 2020

mikekeda Dec 26, 2020

mikekeda Dec 26, 2020

mikekeda Dec 26, 2020

mikekeda Dec 26, 2020

mikekeda Dec 26, 2020

mikekeda Dec 26, 2020

mikekeda Dec 26, 2020

mikekeda commented Dec 26, 2020

omarryhan commented Dec 26, 2020

		@@ -110,7 +114,6 @@ def getlist(self, name, default=None):
		"""
		return super().get(name, default)


		widget = recaptcha_widget

		def __init__(self, label='Recaptcha', extra_validators: Union[list, tuple, set]=None, **kwargs):

Async validators + Recaptcha #14

Are you sure you want to change the base?

Async validators + Recaptcha #14

Conversation

omarryhan commented Dec 24, 2018

omarryhan commented Dec 24, 2018

pyx commented Jan 2, 2019

omarryhan commented Jan 2, 2019

pyx commented Jun 7, 2019

pyx commented Dec 14, 2020

pyx commented Dec 16, 2020 • edited Loading

pyx commented Dec 16, 2020

omarryhan commented Dec 18, 2020

omarryhan commented Dec 18, 2020

pyx commented Dec 19, 2020

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

mikekeda commented Dec 26, 2020

omarryhan commented Dec 26, 2020

pyx commented Dec 16, 2020 •

edited

Loading