villebro commented on code in PR #35259: URL: https://github.com/apache/superset/pull/35259#discussion_r2505717455
########## superset-core/src/superset_core/dao/types.py: ########## @@ -0,0 +1,127 @@ +# 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. + +"""Protocol interfaces for Data Access Objects.""" + +from abc import ABC, abstractmethod +from typing import Any, Generic, Optional, TypeVar, Union + +from flask_appbuilder.models.filters import BaseFilter +from flask_sqlalchemy import BaseQuery + +from superset_core.models.base import CoreModel + +# Type variable bound to our CoreModel +T_Model = TypeVar("T_Model", bound=CoreModel) + + +class BaseDAO(Generic[T_Model], ABC): + """ + Interface for Data Access Objects. + + This interface defines the base that all DAOs should implement, + providing consistent CRUD operations across Superset and extensions. + + Extension developers should implement this protocol: + + ```python + from superset_core.dao import BaseDAO + from superset_core.models import CoreModel + + class MyDAO(BaseDAO[MyCustomModel]): + model_cls = MyCustomModel + + @classmethod + def find_by_id(cls, model_id: str | int) -> MyCustomModel | None: + # Implementation here + pass + ``` + """ + + # Class attributes that implementations should define + model_cls: Optional[type[T_Model]] + base_filter: Optional[BaseFilter] + id_column_name: str + uuid_column_name: str + + @abstractmethod + def find_by_id( + self, model_id: Union[str, int], skip_base_filter: bool = False + ) -> Optional[T_Model]: + """Find a model by ID.""" + ... + + @abstractmethod + def find_by_id_or_uuid( + self, + model_id_or_uuid: str, + skip_base_filter: bool = False, + ) -> Optional[T_Model]: + """Find a model by ID or UUID.""" + ... + + @abstractmethod + def find_by_ids( + self, + model_ids: Union[list[str], list[int]], Review Comment: I've also always been a fan of generic collection types when possible 👍 I agree we should also consider just dumping the old ids in favor of UUIDs now, as it's been a long time coming. Thoughts @michael-s-molina ? -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
