wenjin272 commented on code in PR #6: URL: https://github.com/apache/flink-agents/pull/6#discussion_r2142089245
########## python/flink_agents/api/event.py: ########## @@ -0,0 +1,65 @@ +################################################################################ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +################################################################################# +import json +from abc import ABC +from typing import Any +from uuid import UUID, uuid4 + +from pydantic import BaseModel, Field, model_validator + + +class Event(BaseModel, ABC, extra="allow"): + """Base class for all event types in the system. Event allow extra properties, but + these properties are required isinstance of BaseModel, or json serializable. + + Attributes: + ---------- + id : UUID + Unique identifier for the event, automatically generated using uuid4. + """ + id: UUID = Field(default_factory=uuid4) + + @model_validator(mode='after') + def validate_extra(self) -> 'Event': + """Make sure all extra properties are serializable.""" + for value in self.__pydantic_extra__.values(): + if isinstance(value, BaseModel): Review Comment: 1. Try model_dump_json() to check if any object contains is serializable 2. Override __setattr__ method to check serializable when add field after construct. ########## python/flink_agents/api/tests/test_event.py: ########## @@ -0,0 +1,33 @@ +################################################################################ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +################################################################################# +from typing import Type + +import pytest + +from flink_agents.api.event import Event + + +def test_event_serializable() -> None: #noqa D103 Review Comment: Only for passing code style check that public method needs docs string. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@flink.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
