swagger-api/swagger-codegen

[Python] Align with PEP8, PEP257

Open

#5.995 aberto em 6 de jul. de 2017

Ver no GitHub
 (3 comments) (0 reactions) (0 assignees)HTML (5.474 forks)batch import
Client: PythonEnhancement: Code formathelp wanted

Métricas do repositório

Stars
 (12.701 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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)

Guia do colaborador

Direção de pesquisa
Revisar os modelos Python no repositório (provavelmente em modules/swagger codegen/src/main/resources/python) para violações de PEP8/PEP257. Focar em inconsistências de nomenclatura de classes (ex.: RESTClientObject vs ApiClient), docstrings de uma linha ocupando três linhas e docstrings de setters de propriedades. Garantir conformidade com PEP8 e PEP257. Consultar o trabalho anterior na issue #3041 para contexto.
Pilha de tecnologia
python
Domain
api
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70