Make validate_params work with the function's parametters instead of a dict

[Seluj78]

Instead of having

@validate_params(
    {
        "name": str,
        "age": int,
        "is_student": bool,
        "courses": List[str],
        "grades": Dict[str, int],
    }
)
def example():

It would make more sense to have the decorator read the function arguments directly like so :

@validate_params
def example(name: str, age: int, is_student: bool, courses: List[str], grades: Dict[str, int]):

/!\ One attention point is to see how Flask interacts with the function and where it places it's variables when doing a function with some kind of slug (@app.route("/users/<user_id>"))

[Seluj78]

Credit for this idea goes to @JulienPalard

[JulienPalard]

I'd add: choose another name for this decorator. Both for backward compatibility and to try to stuff more meaning in it?

[Seluj78]

I'd add: choose another name for this decorator. Both for backward compatibility and to try to stuff more meaning in it?

@JulienPalard that's a good idea, do you have any recommendations ? :) I was thinking validate_arguments but I'm not sure

[Mews]

I think I might have an idea on how to accomplish this ngl.
Are there tests in place to test the decorator so I can make sure I dont break anything?

[Seluj78]

Yes there are ! See the tests folder, they run with pytest and tox

Check the readme (I think I detailed it here) or the contributing file and if it's not detailed let me know and I'll add it

[Mews]

Alright thanks 👍
I know how to run the tests haha I was just wondering if this particular feature was accounted for in them.
Btw, another question, since I'm not too familiar with flask.
Take, for example the example you provided:

@validate_params
def example(name: str, age: int, is_student: bool, courses: List[str], grades: Dict[str, int]):
    ...

Would the arguments name, age etc be used inside the function? Or would they be fetched from the json?
(Again, this is based only on the context I got from looking at the source code so I might be misinterpreting what it's doing)

[Mews]

Also I seem to be running into some issues using tox to run the tests, but I can run them fine with pytest.
Is it fine to run the tests with only pytest or should I look into fixing tox.

[Seluj78]

No worries if your tests work with pytest they should work with tox.

FYI tox is a utility that allows you to run commands with multiple environments, and in this case it allows me to run the tests (pytest) for python 3.8 up to 3.12 for many versions of flask !

[Seluj78]

As for your question about the function, it's a little more complicated than that.

Flask can also inject some variables in the function when using slugs (for example https://stackoverflow.com/a/40460690)

And then we want to validate the JSON (and maybe one day form data) params that would be inputted along the potentials slugs

(Sorry I'm on my phone I can't give you a better example right now)

[Seluj78]

@all-contributors please add @JulienPalard for ideas

[allcontributors]

@Seluj78

I've put up a pull request to add @JulienPalard! 🎉

[Seluj78]

@Mews let me know if you have more questions for this :)