Replace supplementary record/manager classes with mixins

Records in Odoo can have some additional fields that are shared across many different record models using model inheritance.

To support adding these kinds of shared fields (and related methods) to record/manager classes in the OpenStack Odoo Client library in a more modular way,  add support for the use of **mixins** to take advantage of Python's multiple inheritance to add such fields and methods to custom record/manager classes.

To make type-hinted record manager mixins possible, a **protocol** class called `RecordManagerProtocol` had to be created documenting the attributes and methods on the `RecordManagerBase` class intended for use by implementing classes. This protocol is used to set the type of the `self` parameter on mixin methods. `RecordManagerBase` now subclasses this protocol.

The `NamedRecordManagerBase` base class has been reimplemented using mixins to not only utilise this paradigm inside the library itself, but also demonstrate its usage in a simple and practical way for anyone looking to write their own mixins.

The `get_by_unique_field` method provided by `RecordManagerWithUniqueFieldBase` has been moved into `RecordManagerBase` to make it available for use in any custom manager class. `CodedRecordManagerBase` has been removed and its implemented moved directly into `ReferralCodeManager`, as it is not used by anything else.

Author: Callum Dickinson

openstack_odooclient/__init__.py

@@ -18,11 +18,6 @@
 from .base.client import ClientBase
 from .base.record import FieldAlias, ModelRef, RecordBase
 from .base.record_manager import RecordManagerBase
-from .base.record_manager_coded import CodedRecordManagerBase
-from .base.record_manager_named import NamedRecordManagerBase
-from .base.record_manager_with_unique_field import (
-    RecordManagerWithUniqueFieldBase,
-)
 from .client import Client
 from .exceptions import (
     ClientError,
@@ -77,6 +72,7 @@
     VolumeDiscountRangeManager,
 )
 from .managers.voucher_code import VoucherCode, VoucherCodeManager
+from .mixins.named_record import NamedRecordManagerMixin, NamedRecordMixin
 
 __all__ = [
     "AccountMove",
@@ -86,7 +82,6 @@
     "Client",
     "ClientBase",
     "ClientError",
-    "CodedRecordManagerBase",
     "Company",
     "CompanyManager",
     "Credit",
@@ -106,7 +101,8 @@
     "GrantTypeManager",
     "ModelRef",
     "MultipleRecordsFoundError",
-    "NamedRecordManagerBase",
+    "NamedRecordManagerMixin",
+    "NamedRecordMixin",
     "Partner",
     "PartnerCategory",
     "PartnerCategoryManager",
@@ -123,7 +119,6 @@
     "ProjectManager",
     "RecordBase",
     "RecordManagerBase",
-    "RecordManagerWithUniqueFieldBase",
     "RecordNotFoundError",
     "ReferralCode",
     "ReferralCodeManager",

openstack_odooclient/base/record.py

@@ -465,7 +465,7 @@ def _decode_value(cls, type_hint: Any, value: Any) -> Any:
         # Not suitable for handling complicated union structures.
         # TODO(callumdickinson): Find a way to handle complicated
         # union structures more smartly.
-        if value_type is Union:
+        if value_type is Union or value_type is UnionType:
             attr_union_types = get_type_args(type_hint)
             if len(attr_union_types) == 2:  # noqa: PLR2004
                 # T | None

openstack_odooclient/base/record_manager/__init__.py

@@ -0,0 +1,27 @@
+# Copyright (C) 2025 Catalyst Cloud Limited
+#
+# Licensed 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 __future__ import annotations
+
+from .base import RecordManagerBase
+from .protocol import RecordManagerProtocol
+from .types import FilterCriterion, Record
+
+__all__ = [
+    "FilterCriterion",
+    "Record",
+    "RecordManagerBase",
+    "RecordManagerProtocol",
+]