JSON schema arrays with uniqueItems=True creates a model using Python sets which are not serializable by default
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 42/100
Línea de trabajo
Comienza con el modelo AccessControl generado y sigue cómo se devuelve un modelo en un ProgressEvent mediante la serialización JSON de Python. Reproduce el fallo con el esquema uniqueItems mostrado y, a continuación, verifica que devolver un modelo que contiene valores AbstractSet se serializa correctamente sin conversiones manuales de set a list.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
When an definition in the JSON schema is an array with uniqueItems set to True, CFN generates a model with that attribute typed as an AbstractSet (or Python set in real terms) to guarantee that the items are unique. However the JSON module by default does not serialize sets and when the model is returned from the handler it raises an exception when trying to do so.
In order for the model to be returned I need to convert every set to a list in the model so it can be serialized back into JSON.
For example JSON Schema with the following definition:
"AccessControl": {
"type": "object",
"properties": {
"Producers": {
"type": "array",
"uniqueItems": true,
"insertionOrder": false,
"items": { "type": "string" }
},
"Consumers": {
"type": "array",
"uniqueItems": true,
"insertionOrder": false,
"items": { "type": "string" }
}
},
"required": [ "Producers", "Consumers" ],
"additionalProperties": false
}
Generates a model with the following class
@dataclass
class AccessControl(BaseModel):
Producers: Optional[AbstractSet[str]]
Consumers: Optional[AbstractSet[str]]
@classmethod
def _deserialize(
cls: Type["_AccessControl"],
json_data: Optional[Mapping[str, Any]],
) -> Optional["_AccessControl"]:
if not json_data:
return None
return cls(
Producers=set_or_none(json_data.get("Producers")),
Consumers=set_or_none(json_data.get("Consumers")),
)
If the incoming model to the handler is populated and returned in a ProgressEvent the handler fails with an exception trying to serialize a set which it cant do by default. In order to return the model I have to convert every set to a list ie model.AccessControl.Producers = list(model.AccessControl.Producers). This can be tedious if there are multiple exit points in the handler and so should be handled by the model or by adding a set serializer to JSON.
- Lenguaje dominante
- Python
- Estrellas
- 107
- Forks
- 46
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de aws-cloudformation/cloudformation-cli-python-plugin
-
Support UVAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
Repo alive?Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
aws-cloudformation/cloudformation-cli-python-plugin#270 · 1 comentario · 1 reacción ·
-
Improve docstrings for HooksAbierto
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
aws-cloudformation/cloudformation-cli-python-plugin#268 · 1 comentario · 2 reacciones ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
aws-cloudformation/cloudformation-cli-python-plugin#264 · 1 comentario ·
Todos los issues de aws-cloudformation/cloudformation-cli-python-plugin
Issues similares
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 77/100
canonical/paas-charm#407 · 1 comentario ·
Los mantenedores suelen responder en 5 días
-
bug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
FAIRmat-NFDI/pynxtools-spm#136 ·
Los mantenedores suelen responder en 1 día
-
enhancement tooling
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
Los mantenedores suelen responder en 1 día
-
`read_nexus` entry point points to a function that no longer existsPosiblemente ocupada @RubelMozumder la tomó hoy. Abiertoannotator bug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
FAIRmat-NFDI/pynxtools#876 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
[Bug]: HTTP 499 (Client Closed Request) is classified as a non-retryable format_error, so a mid-flight abort fails the turn over instead of retryingPosiblemente ocupada @yipinghuang1991 la tomó hoy. Abiertocomp/agent P2 type/bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
NousResearch/hermes-agent#156837 ·
Los mantenedores suelen responder en 1 día