swagger-api/swagger-codegen

[Python] Align with PEP8, PEP257

Open

#5995 aperta il 6 lug 2017

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)HTML (5474 fork)batch import
Client: PythonEnhancement: Code formathelp wanted

Metriche repository

Star
 (12.701 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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)

Guida contributor

Direzione di ricerca
Rivedere i modelli Python nel repository (probabilmente in modules/swagger codegen/src/main/resources/python) per violazioni di PEP8/PEP257. Concentrarsi su incongruenze nella denominazione delle classi (ad es. RESTClientObject vs ApiClient), docstring di una riga che occupano tre righe e docstring dei setter delle proprietà. Assicurarsi l'allineamento con PEP8 e PEP257. Fare riferimento al lavoro precedente nell'issue #3041 per il contesto.
Tech stack
python
Dominio
api
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70