graphql-python / graphql-python/graphene
Allow setting a default JSON Encoder and JSON Decoder
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 818
- PR merge metrics
- No merged PRs in 30d
Description
**Is your feature request related to a problem? Please describe.**
I'm using graphene_django, which auto-converts model fields to `JSONString`, which doesn't allow customizing the JSONEncoder class. I'm doing this for some semi-hacky code where I just want to store a big blob-o-stuff, using a custom encoder to convert enums and datetimes.
PS - I'm happy to implement this! Just looking for feedback on what are reasonable modifications to API for this (if any) or if I should give up on this thread :)
**Describe the solution you'd like**
Allow me to specify a custom JSON encoder via some setting or a global.
**Describe alternatives you've considered**
1. In my ideal world, I'd be able to pass custom encoders to specific JSON fields. (realistically, you can always merge all the JSONEncoders, so being able to specify just one is fine).
2. `serialize()` no longer a static method (seems like overkill for small change)
3. Make graphene-django create custom JSONString fields based upon jsonencoder / decoder (possible, slightly more goofy perhaps)
**Additional context**
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the JSONString field and its serialize() method, then compare the requested global, setting-based, and per-field encoder options with the existing graphene-django behavior. Done means a documented API allows a custom JSON encoder and decoder, with coverage for the intended configuration.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100