JSON schema arrays with uniqueItems=True creates a model using Python sets which are not serializable by default

生成された AccessControl モデルから始め、Python の JSON シリアライゼーションを通じてモデルが ProgressEvent 内で返される流れを追跡します。示されている uniqueItems スキーマで失敗を再現し、AbstractSet 値を含むモデルを返した場合に、手動で set-to-list 変換を行わなくても正常にシリアライズされることを確認します。

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.