swagger-api/swagger-codegen

[Python] Align with PEP8, PEP257

Open

#5.995 geöffnet am 6. Juli 2017

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)HTML (5.474 Forks)batch import
Client: PythonEnhancement: Code formathelp wanted

Repository-Metriken

Stars
 (12.701 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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)

Contributor Guide

Research-Richtung
Überprüfen Sie die Python Vorlagen im Repository (wahrscheinlich unter modules/swagger codegen/src/main/resources/python) auf PEP8/PEP257 Verstöße. Konzentrieren Sie sich auf Inkonsistenzen bei Klassennamen (z. B. RESTClientObject vs. ApiClient), einzeilige Docstrings, die drei Zeilen einnehmen, und Docstrings von Property Settern. Stellen Sie die Einhaltung von PEP8 und PEP257 sicher. Beziehen Sie sich für den Kontext auf frühere Arbeiten in Issue #3041.
Tech Stack
python
Domain
api
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70