openapi-generators / openapi-generators/openapi-python-client

Odd behaviour of snake_case functions

Aberta
#614 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

🐞bug
Linguagem predominante
Python
Estrelas
2k
Forks
293
Merge médio
34min
PRs com merge (30d)
1

Descrição

Describe the bug
The names of apis are odd, having '_' in irregular and unpredictable places

To Reproduce
The following behavior can be observed using the snake_case function from utils:

utils.snake_case("get_v2_abc")
'get_v2_abc'
utils.snake_case("get_v2_abc_deFgHij")
'get_v_2_abc_de_fg_hij'

These would for example be created for paths: /v2/abc and /v2/abc/deFgHij

The results however inserts an additional underscore between v and 2, so v_2 instead of v2.

Expected behavior
results should be:
get_v2_abc_de_fg_hij

Desktop (please complete the following information):

  • OS: CentOS7
  • Python Version: 3.8
  • openapi-python-client version: github-master from today

Suggestion:
snake_case uses split_words function , which only splits on Aa, so a capital letter followed by a lowercase one, not on underscore. split_words should first split on underscore, then split on capital followed by lowercase. This would solve the issue of mixed snake and camelcase names.

Some additional odd outcomes:

>>> utils.snake_case("MODEL4dd")
'model4_dd'
>>> utils.snake_case("MODEl4dd")
'mod_el_4_dd'

These of course violate camelCase, but in my estimate should all be treated as one word, i.e. multiple consecutive capital letters are treated as a single block. So above model4dd would be the outcome in both cases.

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece localizando as implementações de utils.snake_case e split_words no gerador Python. Reproduza os exemplos da issue e, em seguida, verifique se as entradas mistas snake_case e camelCase produzem as palavras esperadas e se os casos MODEL4dd permanecem como uma única palavra; adicione ou execute os testes de utilitário relevantes, se houver.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
tooling
Tipo de issue
Bug
Dificuldade
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.