feat: Add a enum_value_prefix similar to field_prefix and/or allow enum values that start with a bad chart to still be VALUE_$X

Offen

#1,043 erstellt am 14.5.2024 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 5/5
Geschätzter Aufwand: Über eine Woche
Anfängerfreundlichkeit: 35/100

Issue-Typ: Feature
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: openapi, python
Bereich: backend-api-design

Rechercherichtung

Beginne damit, das angeforderte Verhalten mit den gemischten Enum-Werten im Issue zu reproduzieren, und prüfe, wie der Generator derzeit ungültige Enum-Mitglieder benennt. Als abgeschlossen gilt die Unterstützung von enum_value_prefix oder einer gleichwertigen Benennung unter Beibehaltung der ursprünglichen Werte, mit Abdeckung für numerische und mit Unterstrich beginnende Zeichenfolgen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Describe the bug
INT enums
enum: [1,10,20]
map to VALUE_1, VALUE_10, VALUE_20 ....
but you can't have mixed str&int enums.

I have some enums in an openapi file that take both numbers and strings. ex: 1,20,noop
So the numbers need to be strings as well.

But since they start with an invalid char ([0-9]) they're renamed VALUE_1, VALUE_2, etc regardless of the int/string value

I think a similar thing happens to strings that start as _.

It's worse then passing in a string(especially since you can't pass in the string/value instead).
Its better to keep the string value after the prefix.

basically I'd like to be able to have

enum: ["200", "10", "_11", "_ABC", "noop"]

map to

class MyEnum(str, Enum):
    VALUE_200 = "200"
    VALUE_10 = "10"
    VALUE_11 = "11"
    VALUE_ABC= "ABC"
    noop = "noop"

    def __str__(self) -> str:
        return str(self.value)

with
enum_value_prefix: V

class MyEnum(str, Enum):
    V_200 = "200"
    V_10 = "10"
    V_11 = "11"
    V_ABC= "ABC"
    noop = "noop"

    def __str__(self) -> str:
        return str(self.value)

OpenAPI Spec File
Openapi doesn't have great support for custom enum naming.
I think this would work better in many cases anyway
https://stackoverflow.com/questions/66465888/how-to-define-enum-mapping-in-openapi

Vorherrschende Sprache: Python
Sterne: 2k
Forks: 293
Ø Merge: 34 Min.
Gemergte PRs (30 T.): 1

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus openapi-generators/openapi-python-client

typing_extensions should be declared as dependency Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100

openapi-generators/openapi-python-client#1481 · Erstellt am 20.8.2026
Skip setting 'Content-Type' on file upload, when multiple bodies are supported Offen

Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100

openapi-generators/openapi-python-client#947 · Erstellt am 23.1.2024
Multi-body endpoints with required requestBody emit `| Unset` without importing `Unset` Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 72/100

openapi-generators/openapi-python-client#1451 · 1 Kommentar · Erstellt am 18.6.2026
_build_response crashes with ValueError on non-IANA HTTP status codes (520, 561, etc.) Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 52/100

openapi-generators/openapi-python-client#1442 · Erstellt am 29.5.2026
Generator fails on type: array without items even though it's valid in JSON Schema 2020-12 / OpenAPI 3.1 Offen

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 64/100

openapi-generators/openapi-python-client#1435 · 1 Kommentar · Erstellt am 15.5.2026

Alle Issues in openapi-generators/openapi-python-client