Copilot commented on code in PR #8692: URL: https://github.com/apache/gravitino/pull/8692#discussion_r3123243425
########## clients/client-python/gravitino/api/stats/statistic.py: ########## @@ -0,0 +1,74 @@ +# 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 abc import ABC, abstractmethod +from typing import Any, Final + +from gravitino.api.auditable import Auditable +from gravitino.api.stats.statistic_value import StatisticValue + + +class Statistic(Auditable, ABC): + """Statistic interface represents a statistic that can be associated with a metadata object. + + It can be used to store various types of statistics, for example, table statistics, partition + statistics, fileset statistics, etc. + """ + + CUSTOM_PREFIX: Final[str] = "custom-" + """The prefix for custom statistics. Custom statistics are user-defined statistics.""" + + @abstractmethod + def name(self) -> str: + """Get the name of the statistic. + + Returns: + str: the name of the statistic + """ + + @abstractmethod + def value(self) -> StatisticValue[Any] | None: + """Get the value of the statistic. + + he value is optional. If the statistic is not set, the value will be empty. + + Returns: + StatisticValue: + An optional containing the value of the statistic if it is set, otherwise empty. Review Comment: The `value()` docstring appears inconsistent with the actual return type (`StatisticValue[Any] | None`) and has a typo (“he value…”). The docs should describe returning `None` when unset (or change the return type to an `Optional`-style wrapper if that’s the intended API). ```suggestion The value is optional. If the statistic is not set, this method returns `None`. Returns: StatisticValue[Any] | None: The value of the statistic if it is set, otherwise `None`. ``` ########## clients/client-python/gravitino/exceptions/base.py: ########## @@ -205,6 +205,14 @@ class ForbiddenException(GravitinoRuntimeException): """An exception thrown when a user is forbidden to perform an action.""" +class IllegalStatisticNameException(IllegalArgumentException): + """An exception thrown when statistic has an illegal name""" Review Comment: Docstring is missing an article and trailing period; current phrasing reads ungrammatically. Consider updating to something like “An exception thrown when a statistic has an illegal name.” to match surrounding exception docstrings. ```suggestion """An exception thrown when a statistic has an illegal name.""" ``` ########## clients/client-python/gravitino/api/stats/statistic.py: ########## @@ -0,0 +1,74 @@ +# 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 abc import ABC, abstractmethod +from typing import Any, Final + +from gravitino.api.auditable import Auditable +from gravitino.api.stats.statistic_value import StatisticValue + + +class Statistic(Auditable, ABC): + """Statistic interface represents a statistic that can be associated with a metadata object. + + It can be used to store various types of statistics, for example, table statistics, partition + statistics, fileset statistics, etc. + """ + + CUSTOM_PREFIX: Final[str] = "custom-" + """The prefix for custom statistics. Custom statistics are user-defined statistics.""" + + @abstractmethod + def name(self) -> str: + """Get the name of the statistic. + + Returns: + str: the name of the statistic + """ + + @abstractmethod + def value(self) -> StatisticValue[Any] | None: + """Get the value of the statistic. + + he value is optional. If the statistic is not set, the value will be empty. + + Returns: + StatisticValue: + An optional containing the value of the statistic if it is set, otherwise empty. Review Comment: The `Returns:` section for `value()` still describes an “optional containing the value … otherwise empty”, but the type hint is `StatisticValue[Any] | None`. Please update the return docs to match the Python API (e.g., “returns the statistic value, or `None` if unset”). ```suggestion The value may be unset. Returns: StatisticValue[Any] | None: The statistic value, or `None` if it is unset. ``` ########## clients/client-python/gravitino/api/stats/statistic.py: ########## @@ -0,0 +1,74 @@ +# 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 abc import ABC, abstractmethod +from typing import Any, Final + +from gravitino.api.auditable import Auditable +from gravitino.api.stats.statistic_value import StatisticValue + + +class Statistic(Auditable, ABC): + """Statistic interface represents a statistic that can be associated with a metadata object. + + It can be used to store various types of statistics, for example, table statistics, partition + statistics, fileset statistics, etc. + """ + + CUSTOM_PREFIX: Final[str] = "custom-" + """The prefix for custom statistics. Custom statistics are user-defined statistics.""" + + @abstractmethod + def name(self) -> str: + """Get the name of the statistic. + + Returns: + str: the name of the statistic + """ + + @abstractmethod + def value(self) -> StatisticValue[Any] | None: + """Get the value of the statistic. + + he value is optional. If the statistic is not set, the value will be empty. + + Returns: + StatisticValue: + An optional containing the value of the statistic if it is set, otherwise empty. + """ + + @abstractmethod + def reserved(self) -> bool: + """The statistic is predefined by Gravitino if the value is true. + + The statistic is defined by users if the value is false. For example, the statistic + "row_count" is a reserved statistic. A custom statistic name must start with "custom." + prefix to avoid name conflict with reserved statistics. Because Gravitino may add more Review Comment: `CUSTOM_PREFIX` is defined as "custom-", but the `reserved()` docstring says custom statistic names must start with "custom.". This is misleading (and contradicts the constant/server-side validation). Please align the documentation with `CUSTOM_PREFIX` (or reference the constant directly). ```suggestion "row_count" is a reserved statistic. A custom statistic name must start with "custom-" prefix to avoid name conflict with reserved statistics, because Gravitino may add more ``` ########## clients/client-python/gravitino/api/stats/supports_statistics.py: ########## @@ -0,0 +1,74 @@ +# 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 abc import ABC, abstractmethod +from typing import Any + +from gravitino.api.stats.statistic import Statistic +from gravitino.api.stats.statistic_value import StatisticValue + + +class SupportsStatistics(ABC): + """SupportsStatistics provides methods to list and update statistics. + + A table, a partition or a fileset can implement this interface to manage its statistics. + """ + + @abstractmethod + def list_statistics(self) -> list[Statistic]: + """Lists all statistics. + + Returns: + A list of statistics + """ + + @abstractmethod + def update_statistics(self, statistics: dict[str, StatisticValue[Any]]) -> None: + """Updates statistics with the provided values. + + If the statistic exists, it will be updated with the new value. If the statistic does + not exist, it will be created. If the statistic is unmodifiable, it will throw an + `UnmodifiableStatisticException`. If the statistic name is illegal, it will throw an + `IllegalStatisticNameException`. + + Args: + statistics: a map of statistic names to their values + + Raises: + IllegalStatisticNameException: If the statistic name is illegal + UnmodifiableStatisticException: If the statistic is unmodifiable + """ + + @abstractmethod + def drop_statistics(self, statistics: list[str]) -> bool: Review Comment: New public API surface (`SupportsStatistics` / `Statistic` / `StatisticValue`) was added without corresponding Python unit tests. Please add tests under `clients/client-python/tests/unittests/api/stats/` (at least covering importability and key constants/typing/ABC behavior) to keep the client’s unit test suite in sync with new APIs. ########## clients/client-python/gravitino/exceptions/base.py: ########## @@ -205,6 +205,14 @@ class ForbiddenException(GravitinoRuntimeException): """An exception thrown when a user is forbidden to perform an action.""" +class IllegalStatisticNameException(IllegalArgumentException): + """An exception thrown when statistic has an illegal name""" + + +class UnmodifiableStatisticException(UnsupportedOperationException): + """An exception thrown when users modify an unmodifiable statistic""" Review Comment: Docstring is missing a trailing period and reads awkwardly (“when users modify…”). Consider rephrasing to “An exception thrown when attempting to modify an unmodifiable statistic.” to be consistent with other exception docstrings. ```suggestion """An exception thrown when attempting to modify an unmodifiable statistic.""" ``` -- 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]
