union types and nullables can create unnecessary class suffixes (and related problems)
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 45/100
Direção de pesquisa
Comece pelo comportamento de UnionProperty e gere clientes a partir dos arquivos de especificação OpenAPI 3.0 e 3.1 vinculados. Compare os nomes das classes geradas e os modelos duplicados com os exemplos descritos na issue. Considera-se concluído quando os schemas nullable e de união não recebem mais sufixos desnecessários nem criam classes adicionais idênticas.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
Describe the bug
In some valid specs, the use of anyOf, oneOf, nullable, and/or type as a list, can cause generated class names to have unnecessary suffixes (and, sometimes, for spurious extra copies of classes to appear). These problems seem to all ultimately come from the behavior of UnionProperty.
The problem cases are all included in the attached specs files. Looking at the code generated from these specs—
in both 3.0 & 3.1:
ExampleModel.nullableObjectWithOneOfcorrectly has the typeUnion[MyObject, None, Unset].ExampleModel.inlineNullableObjectgenerates a model class calledExampleModelInlineNullableObjectType0. It should be justExampleModelInlineNullableObject, since there are no other named types for this property.- Similarly, the
MyEnumschema, which is a nullable enum, generates the classMyEnumType1even though there is noType0. - The
MyEnumWithExplicitTypeschema is the same asMyEnumexcept it specifically indicatestype, and the result is a bit wilder: it generates enum classesMyEnumWithExplicitTypeType1,MyEnumWithExplicitType2Type1, andMyEnumWithExplicitType3Type1, all of which are exactly the same.
only applicable to 3.1:
ExampleModel.nullableObjectWithExplicitTypes, which is the same asnullable_object_with_one_ofexcept that it also (unnecessarily, but validly) specifiestype: ["object", "null"], also works correctly.ExampleModel.one_of_enums_with_explicit_types, which combines a string enum with an int enum and specifies `type: ["string", "integer"], has the problem where three classes are created for each enum.
OpenAPI Spec Files
3.0: https://gist.github.com/eli-bl/7bea406525fb3b1452a71781ada5c1c0
3.1: https://gist.github.com/eli-bl/c03c88eb69312053e0122d1d8a06c2a0
Desktop (please complete the following information):
- OS: macOS 14.5
- Python Version: 3.8.15
- openapi-python-client version 0.21.5
- Linguagem predominante
- Python
- Estrelas
- 2k
- Forks
- 293
- Merge médio
- 34min
- PRs com merge (30d)
- 1
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de openapi-generators/openapi-python-client
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 72/100
openapi-generators/openapi-python-client#1451 · 1 comentário ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 52/100
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 64/100
openapi-generators/openapi-python-client#1435 · 1 comentário ·
Todas as issues de openapi-generators/openapi-python-client
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
anthropics/skills#1811 · 1 comentário ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
speaches-ai/speaches#678 ·
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
datalayer/mcp-compose#42 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
conda-forge/spacy-feedstock#177 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
UKGovernmentBEIS/inspect_evals#2523 ·