swagger-api/swagger-codegen

[Python] Align with PEP8, PEP257

Open

#5,995 创建于 2017年7月6日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)HTML (12,701 star) (5,474 fork)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
议题类型
refactor
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
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.