swagger-api/swagger-codegen

[Python] support type hints

Open

#5,429 opened on Apr 19, 2017

View on GitHub
 (19 comments) (34 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: PythonEnhancement: FeatureServer: Pythonhelp wanted

Description

Description

We want to support type hints, which was introduced for Python 3.5+. The feature will be added to Python API client as well as server (Flask).

Since this option is for 3.5+ only, we will need to use the option supportPython2 to selectively disable it if supportPython2 (default to false) is set to true

Python version: 3.5+

Ref: https://www.python.org/dev/peps/pep-0484/

Suggest a Fix

If anyone from the community has questions/suggestions or wants to work on it, please reply to let us know. Thank you.

Contributor guide

Tech stack
pythonflask
Domain
backendapi
Issue type
feature
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.
3-5 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
Python type hints (PEP 484)Familiarity with swagger codegen generatorsFlask basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate the swagger codegen Python generator templates (e.g., modules/swagger codegen/src/main/resources/python/). Understand the current template structure and how to conditionally output type annotations based on the `supportPython2` option. Review PEP 484 for type hint syntax. Examine related issues or PRs for prior attempts.