swagger-api/swagger-codegen

[Python] Better JSON Serialization and Marshaling

Open

#5,421 opened on Apr 19, 2017

View on GitHub
 (3 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: PythonEnhancement: Featurehelp wanted

Description

Description

Currently, the Python API client relies on our own deserialiser to convert JSON string back into Python objects with support of attribute mapping. For other generators (e.g. Java, C#), we're leveraging 3rd-party libraries/modules to handle serialization/deserialization between objects and JSON strings

We would like to evaluate different Python modules to perform similar tasks instead of maintaining our own serialization/deserialisation logic:

If anyone has comments/suggestions or want to contribute to this enhancement, please reply to let us know. Thank you.

Contributor guide

Tech stack
python
Domain
api
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
PythonJSON serialization concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Research available Python JSON serialization libraries such as Kim (https://github.com/mikeywaites/kim). Evaluate their features, performance, and ease of integration with the existing swagger codegen Python generator. Propose the best candidate with justification. Consider the current deserialization logic in the Python API client generation templates.