String enum values containing ³ character do not get properly sanitized
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Facilidade para iniciantes
- 48/100
Direção de pesquisa
Comece pela especificação de repro.yaml e execute o comando documentado python3 -m openapi_python_client generate usando o caminho de saída indicado. Inspecione o volume_unit.py gerado e a saída relacionada do ruff; está concluído quando os nomes dos enums derivados de Nm³, m³ e ft³ forem identificadores Python válidos e a geração não produzir mais esses erros.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
Describe the bug
The ³ character in string enum values does not get sanitized out before creating enum names, resulting in invalid generated code.
OpenAPI Spec File
openapi: 3.0.0
info:
title: Test API for Nm³ Enum Issue
version: 1.0.0
description: Minimal API to reproduce enum generation issue with Unicode characters
servers:
- url: https://api.example.com
paths:
/volume:
get:
summary: Get volume measurements
responses:
'200':
description: Volume measurement response
content:
application/json:
schema:
type: object
properties:
unit:
$ref: '#/components/schemas/VolumeUnit'
value:
type: number
components:
schemas:
VolumeUnit:
type: string
enum:
- "Nm³"
- "m³"
- "ft³"
- "normal_value"
description: Volume unit with problematic Unicode superscript characters
On WSL, I checked out the latest version of the generator and ran
pip3 install -e .
python3 -m openapi_python_client generate --path repro.yaml --output-path test_output
Which resulted in the following ./test_output/test_api_for_nm_³_enum_issue_client/models/volume_unit.py (along with a pile of ruff errors)
from enum import Enum
class VolumeUnit(str, Enum):
FT³ = "ft³"
M³ = "m³"
NM³ = "Nm³"
NORMAL_VALUE = "normal_value"
def __str__(self) -> str:
return str(self.value)
Which is not legal python.
Desktop (please complete the following information):
- OS: Microsoft Windows Server 2022, WSL 2.1.5.0, Ubuntu 22.04.5
- Python Version: Python 3.10.12
- openapi-python-client version 0.26.1
Additional context
Add any other context about the problem here.
- Linguagem predominante
- Python
- Estrelas
- 2k
- Forks
- 296
- Merge médio
- 34min
- PRs com merge (30d)
- 1
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Sem modelo de pull request
- Ler o 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 · 3 comentários ·
-
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
-
#bug
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 92/100
apache/superset#44923 · 1 comentário ·
Mantenedores costumam responder em até 2 dias
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
lawndoc/stack-back#123 ·
-
Add: EntuneAberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
AbdelStark/awesome-typesafe-jev#187 ·
Mantenedores costumam responder em até 1 dia
-
bug good first issue
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
repowise-dev/repowise#2966 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
Mantenedores costumam responder em até 2 dias