kubernetes-client/python

Explore the possibility of type hinting

Open

#225 opened on May 20, 2017

View on GitHub
 (30 comments) (39 reactions) (0 assignees)Python (6,225 stars) (3,323 forks)batch import
help wantedlifecycle/frozen

Description

Python 3 has a type hinting feature very useful for auto complete. This issue is for tracking efforts on researching its backward compatibility with python 2 (from __future__ import import annotations?) and if possible, change code generator to implement it. Best if we contribute it back to swagger-codegen.

Contributor guide

Tech stack
python
Domain
developer experiencetooling
Issue type
research
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.
clear
Prerequisites
Python programmingType hints in PythonPython 2 compatibilityCode generation techniques
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate the current code generation approach in the kubernetes client/python repository, particularly the templates used to generate Python client code. Evaluate the feasibility of adding type hints while maintaining Python 2 compatibility using `from future import annotations`. Review the swagger codegen project to understand if type hints can be contributed upstream. Discuss findings with maintainers (comments on issue #225).