Contribute Zulip's JsonableError framework to Django upstream · zulip/zulip#975

(3 comments) (0 reactions) (0 assignees)Python (19,672 stars) (7,339 forks)batch import

area: dependencieshelp wanted

Description

Zulip has this nice JsonableError framework (defined in zerver/lib/request.py plus zerver/middleware.py) that can turn an exception thrown inside Zulip into a nice user-facing error message for all of our JSON routes. I think this would be a great feature to contribute to Django upstream, since it would help a lot of other developers as well. I talked to a Django core team member at PyCon, and he thought it would be a great addition but probably deserves a thread on the django-devel mailing list to make sure we get the right interface merged into mainline.

(We'd want to generalize this a bit to support other ways to marshall the data, and maybe think a bit more about making internationalization really nice, but I think this would be a great small contribution.)

Contributor guide

Tech stack: pythondjango
Domain: backendapi
Issue type: feature
Difficulty: 3
Estimated time: 3-5 days
Activity status: stale
Clarity: mostly clear
Prerequisites: PythonDjango framework experienceUnderstanding of Zulip's error handling
Newbie friendliness: 40
Research direction: Read the existing JsonableError implementation in zerver/lib/request.py and zerver/middleware.py. Then study Django's exception handling and middleware patterns. Start a discussion on the django devel mailing list to gather feedback on the desired interface. Consider generalizing the framework to support multiple data formats and internationalization.