swagger-api/swagger-codegen

[Python] Align with PEP8, PEP257

Open

#5,995 opened on 2017年7月6日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Client: PythonEnhancement: Code formathelp wanted

説明

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)

コントリビューターガイド

技術スタック
python
領域
developer experiencedocumentation
Issue 種別
refactor
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
PythonPEP8 and PEP257 conventionsSwagger codegen template structure
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
65
調査方針
Review the Python templates in the repository (likely under modules/swagger codegen/src/main/resources/python) for PEP8/PEP257 violations. Focus on class naming inconsistencies (e.g., RESTClientObject vs ApiClient), one line docstrings taking up three lines, and property setter docstrings. Ensure alignment with PEP8 and PEP257. Refer to earlier work in issue #3041 for context.
[Python] Align with PEP8, PEP257 · swagger-api/swagger-codegen#5995 | Good First Issue