swagger-api/swagger-codegen

[Python] Align with PEP8, PEP257

Open

#5 995 ouverte le 6 juil. 2017

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)HTML (5 474 forks)batch import
Client: PythonEnhancement: Code formathelp wanted

Métriques du dépôt

Stars
 (12 701 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Description

Since #3041 it seems the templates have drifted a bit from PEP8 guidelines. A couple examples that jumped at me:

  • Some inconsistencies with acronym capitalization (ex: RESTClientObject and ApiClient) ref
  • Lots of one-line docstrings taking up 3 lines ref
  • Docstrings on property setters that are ignored by help() and tools like Sphinx: example from Python docs

Not in PEP8, but there are a few instances where default values are set in __init__() using property setters before the underlying attribute is declared, which will throw an AttributeError if that initial assignment isn't made.

These are pretty low-key, but it'll help keep the linters quiet

Swagger-codegen version

2.2.0 and 2.3.0

Related issues

#3041

Suggest a Fix

I can clean up the templates a bit and create a PR (I did quite a bit of it already)

Guide contributeur

Direction de recherche
Examiner les modèles Python dans le dépôt (probablement sous modules/swagger codegen/src/main/resources/python) pour les violations de PEP8/PEP257. Se concentrer sur les incohérences de nommage des classes (par exemple RESTClientObject vs ApiClient), les docstrings d'une ligne occupant trois lignes et les docstrings des setters de propriétés. S'assurer de l'alignement avec PEP8 et PEP257. Se référer aux travaux antérieurs dans l'issue #3041 pour le contexte.
Stack technique
python
Domaine
api
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70