It would be nice if there was a way to filter out any fields where the return value is None. For some responses, if a value is not present then it is better to not return the field all together rather than return a JSON null. Flask-RESTX provides this functionality in their marshal_with decorator, which allows a skip_none parameter to be passed in (docs). The proposed solution for this would be to allow the responds decorator to similarly take a skip_none bool parameter (defaulting to False), which would filter out any None value fields produced in the serialized object.
In this PR
Adds a skip_none boolean parameter to the responds decorator
If skip_none is set as True, then removes any fields that have a None value from the serialized object
None removal logic implemented recursively to handle for nested schemas
apryor6
commented
3 years ago
Resolves issue https://github.com/apryor6/flask_accepts/issues/99.
Why
It would be nice if there was a way to filter out any fields where the return value is
None. For some responses, if a value is not present then it is better to not return the field all together rather than return a JSONnull. Flask-RESTX provides this functionality in theirmarshal_withdecorator, which allows askip_noneparameter to be passed in (docs). The proposed solution for this would be to allow therespondsdecorator to similarly take askip_nonebool parameter (defaulting toFalse), which would filter out anyNonevalue fields produced in the serialized object.In this PR
skip_noneboolean parameter to therespondsdecoratorskip_noneis set asTrue, then removes any fields that have aNonevalue from the serialized objectNoneremoval logic implemented recursively to handle for nested schemas