Incorrect handling of Union types
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 48/100
Direzione di ricerca
Inizia dagli entry point APISpec e MarshmallowPlugin nella riproduzione, concentrandoti su come MainSchema.Schema() viene convertito per il campo items tipizzato come Union. Esegui l’esempio Python fornito e aggiungi la copertura sia per list[Food | Drink] sia per Food | Drink; il lavoro è completato quando lo schema OpenAPI generato rappresenta le alternative invece di lasciare items vuoto.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
It seems that the API spec is not properly generated when using Union typehints.
The below snippet is on python 3.10 and 3.11
from typing import Literal
from apispec import APISpec
from apispec.ext.marshmallow import MarshmallowPlugin
from marshmallow_dataclass import dataclass
class BaseItemMixin:
name: str
@dataclass
class BaseItem(BaseItemMixin):
pass
@dataclass
class Food(BaseItem):
label: str
name: Literal["food"] = "food"
@dataclass
class Drink(BaseItem):
size: int
name: Literal["drink"] = "drink"
@dataclass
class MainSchema:
id: int
name: str
items: list[Food | Drink]
spec = APISpec(
title="API",
version="1.0.0",
openapi_version="3.0.2",
plugins=[(MarshmallowPlugin())],
)
spec.path(
"/endpoint",
operations={
"post": {
"parameters": [
{
"name": "Args",
"schema": MainSchema.Schema(),
"in": "body",
}
],
"responses": {
"200": {
"content": {"application/json": {}},
"description": "OK",
},
},
}
},
)
if __name__ == "__main__":
print(spec.to_yaml())
The outputted yaml contains the schema for Main as:
components:
schemas:
Main:
type: object
properties:
name:
type: string
id:
type: integer
items:
type: array
items: {}
required:
- id
- items
- name
Items is correctly marked as an array, but the items is not correct. I'd expect oneOf being used here (although i'm not 100%).
The same happens using item: Food | Drink.
I believe the issue is within this library, and not marshmallow_dataclass, as i'm able to deserialise serialise with the schemas without issue
data = MainSchema(
id=1,
name="test",
items=[
Food(name="food", label="test"),
Drink(name="drink", size=1),
],
)
data_as_dict = MainSchema.Schema().dumps(data)
loaded_data = MainSchema.Schema().loads(data_as_dict)
print("original", data)
print("deserialised", loaded_data)
print("serialised", data_as_dict)
# original MainSchema(id=1, name='test', items=[Food(label='test', name='food'), Drink(size=1, name='drink')])
# deserialised MainSchema(id=1, name='test', items=[Food(label='test', name='food'), Drink(size=1, name='drink')])
# serialised {"id": 1, "items": [{"label": "test", "name": "food"}, {"size": 1, "name": "drink"}], "name": "test"}
Note: I've also tried without the inheritance involved, and the result is the same.
- Lingua principale
- Python
- Stelle
- 1.2k
- Fork
- 211
- Merge medio
- 2g 1h
- PR unite (30g)
- 4
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di marshmallow-code/apispec
-
DateTime(format="timestamp") generates invalid OpenAPI schema using min instead of minimumForse già presa @Sanjays2402 l’ha presa 107 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
marshmallow-code/apispec#1064 ·
I maintainer di solito rispondono entro 1 giorno
-
documentation
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
marshmallow-code/apispec#750 · 1 commento · 5 reazioni ·
I maintainer di solito rispondono entro 1 giorno
-
Dependency DashboardAperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 30/100
marshmallow-code/apispec#1033 ·
I maintainer di solito rispondono entro 1 giorno
-
`apispec` ignores `oneOf` from `marshmallow-oneofschema`Forse di nuovo libera Una pull request per questa issue è stata chiusa senza essere unita. Aperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 38/100
marshmallow-code/apispec#1012 · 6 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
Support Overlays standardApertaenhancement
Difficoltà 5/5 Più di una settimana Idoneità per principianti 30/100
marshmallow-code/apispec#981 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di marshmallow-code/apispec
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 73/100
Netcracker/qubership-ai-packages#266 ·
I maintainer di solito rispondono entro 1 giorno
-
PROCESSED_DATA_FOLDER: strip whitespace and treat empty as unsetForse già presa @TorecLuik l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
NL-BioImaging/BIOMERO.importer#63 ·
I maintainer di solito rispondono entro 1 giorno
-
MLX training-complete chat/merge suggestions omit --backend mlxForse già presa @vaputa l’ha presa oggi. Apertaneeds-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
MakazhanAlpamys/Soup#2913 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
area:security effort:S priority:P3 status:needs-triage type:chore
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
randomparity/kdive#3657 ·
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
aws/mcp-proxy-for-aws#476 ·
I maintainer di solito rispondono entro 1 giorno