Copilot commented on code in PR #12090: URL: https://github.com/apache/gravitino/pull/12090#discussion_r3613607572
########## clients/client-python/gravitino/dto/rel/view_dto.py: ########## @@ -0,0 +1,105 @@ +# 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 dataclasses import dataclass, field +from typing import Optional + +from dataclasses_json import DataClassJsonMixin, config + +from gravitino.api.rel.column import Column +from gravitino.api.rel.representation import Representation +from gravitino.api.rel.view import View +from gravitino.dto.audit_dto import AuditDTO +from gravitino.dto.rel.column_dto import ColumnDTO +from gravitino.dto.rel.json_serdes.representation_serdes import RepresentationSerdes +from gravitino.dto.rel.representation_dto import RepresentationDTO +from gravitino.dto.util.dto_converters import DTOConverters +from gravitino.utils.precondition import Precondition + + +@dataclass +class ViewDTO(View, DataClassJsonMixin): # pylint: disable=too-many-instance-attributes + """Represents a View DTO.""" + + _name: str = field(metadata=config(field_name="name")) + _columns: Optional[list[ColumnDTO]] = field( + default=None, metadata=config(field_name="columns") + ) + _representations: Optional[list[RepresentationDTO]] = field( + default=None, + metadata=config( + field_name="representations", + encoder=lambda items: [ + RepresentationSerdes.serialize(item) for item in items + ], + decoder=lambda values: [ + RepresentationSerdes.deserialize(value) for value in values + ], + ), + ) + _audit: Optional[AuditDTO] = field( + default=None, metadata=config(field_name="audit") + ) + _comment: Optional[str] = field(default=None, metadata=config(field_name="comment")) + _default_catalog: Optional[str] = field( + default=None, metadata=config(field_name="defaultCatalog") + ) + _default_schema: Optional[str] = field( + default=None, metadata=config(field_name="defaultSchema") + ) + _properties: Optional[dict[str, str]] = field( + default=None, metadata=config(field_name="properties") + ) + + def __post_init__(self): + if self._columns is None: + self._columns = [] + Precondition.check_string_not_empty(self._name, "name cannot be null or empty") + Precondition.check_argument(self._audit is not None, "audit cannot be null") + Precondition.check_argument( + self._representations is not None and len(self._representations) > 0, + "representations cannot be null or empty", + ) + for representation in self._representations: + Precondition.check_argument( + representation is not None, "representation must not be null" + ) + representation.validate() + + def name(self) -> str: + return self._name + + def comment(self) -> Optional[str]: + return self._comment + + def columns(self) -> list[Column]: + return self._columns Review Comment: The return annotation is `list[Column]`, but the stored field is `list[ColumnDTO]`. If `ColumnDTO` is not guaranteed to implement `Column`, this is a type contract violation; even if it does, it’s inconsistent with `representations()` which explicitly converts DTOs to API objects. Consider either (a) converting via `DTOConverters.from_dtos(self._columns)` (and adding the corresponding converter overload/implementation if needed) or (b) changing the annotation to `list[ColumnDTO]` if the intent is to expose DTOs. ########## clients/client-python/gravitino/dto/rel/view_dto.py: ########## @@ -0,0 +1,105 @@ +# 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 dataclasses import dataclass, field +from typing import Optional + +from dataclasses_json import DataClassJsonMixin, config + +from gravitino.api.rel.column import Column +from gravitino.api.rel.representation import Representation +from gravitino.api.rel.view import View +from gravitino.dto.audit_dto import AuditDTO +from gravitino.dto.rel.column_dto import ColumnDTO +from gravitino.dto.rel.json_serdes.representation_serdes import RepresentationSerdes +from gravitino.dto.rel.representation_dto import RepresentationDTO +from gravitino.dto.util.dto_converters import DTOConverters +from gravitino.utils.precondition import Precondition + + +@dataclass +class ViewDTO(View, DataClassJsonMixin): # pylint: disable=too-many-instance-attributes + """Represents a View DTO.""" + + _name: str = field(metadata=config(field_name="name")) + _columns: Optional[list[ColumnDTO]] = field( + default=None, metadata=config(field_name="columns") + ) + _representations: Optional[list[RepresentationDTO]] = field( + default=None, + metadata=config( + field_name="representations", + encoder=lambda items: [ + RepresentationSerdes.serialize(item) for item in items + ], + decoder=lambda values: [ + RepresentationSerdes.deserialize(value) for value in values + ], + ), + ) + _audit: Optional[AuditDTO] = field( + default=None, metadata=config(field_name="audit") + ) + _comment: Optional[str] = field(default=None, metadata=config(field_name="comment")) + _default_catalog: Optional[str] = field( + default=None, metadata=config(field_name="defaultCatalog") + ) + _default_schema: Optional[str] = field( + default=None, metadata=config(field_name="defaultSchema") + ) + _properties: Optional[dict[str, str]] = field( + default=None, metadata=config(field_name="properties") + ) + + def __post_init__(self): + if self._columns is None: + self._columns = [] + Precondition.check_string_not_empty(self._name, "name cannot be null or empty") + Precondition.check_argument(self._audit is not None, "audit cannot be null") + Precondition.check_argument( + self._representations is not None and len(self._representations) > 0, + "representations cannot be null or empty", + ) Review Comment: `properties()` normalizes `None` to `{}`, but `__post_init__` leaves `_properties` as `None`. This can cause `to_dict()`/`to_json()` to emit `\"properties\": null` instead of `{}`, which is a behavior mismatch and may break consumers expecting an object. Consider normalizing `_properties` to `{}` in `__post_init__` when it is `None` (similar to `_columns`). ########## clients/client-python/gravitino/dto/rel/json_serdes/representation_serdes.py: ########## @@ -0,0 +1,44 @@ +# 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 Optional + +from gravitino.api.rel.representation import Representation +from gravitino.dto.rel.representation_dto import RepresentationDTO +from gravitino.dto.rel.sql_representation_dto import SQLRepresentationDTO +from gravitino.exceptions.base import IllegalArgumentException + + +class RepresentationSerdes: + """Serdes for view representation DTOs.""" + + @staticmethod + def serialize(value: Optional[RepresentationDTO]) -> Optional[dict]: + """Encode a representation DTO to a dictionary.""" + if value is None: + return None + return value.to_dict() + + @staticmethod + def deserialize(value: Optional[dict]) -> Optional[RepresentationDTO]: + """Decode a representation DTO from a dictionary.""" + if value is None: + return None + if value.get("type") == Representation.TYPE_SQL: + return SQLRepresentationDTO.from_dict(value) + raise IllegalArgumentException( + f"Unsupported representation type: {value.get('type')}" + ) Review Comment: `deserialize` assumes `value` is a dict and will raise `AttributeError` if a non-dict slips in (e.g., malformed JSON where the item is a string/list). Since this is a public serdes boundary, it should fail with a controlled `IllegalArgumentException`. Consider adding an `isinstance(value, dict)` check and raising `IllegalArgumentException` with a clear message when the input is not a dict. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
