Files
distcloud/distributedcloud/dcorch/objects/base.py
Hugo Brito 70fd84b263 Apply black formatter to dcorch
This commit applies the Black format to the `dcorch`
files to ensure that it adheres to the Black code style guidelines.

Test Plan:
PASS: Success in stx-distcloud-tox-black

Story: 2011149
Task: 50445

Change-Id: I0f6298293e6a86237723b53164abe892fb54dab0
Signed-off-by: Hugo Brito <hugo.brito@windriver.com>
2024-06-28 13:46:02 +00:00

74 lines
2.4 KiB
Python

# Copyright (c) 2015 Ericsson AB.
# Copyright (c) 2017, 2019, 2021, 2024 Wind River Systems, Inc.
# All Rights Reserved.
#
# 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.
#
"""Orchestrator common internal object model"""
from oslo_utils import versionutils
from oslo_versionedobjects import base
from dcorch import objects
VersionedObjectDictCompat = base.VersionedObjectDictCompat
class OrchestratorObject(base.VersionedObject):
"""Base class for dcorch objects.
This is the base class for all objects that can be remoted or instantiated
via RPC. Simply defining a sub-class of this class would make it remotely
instantiatable. Objects should implement the "get" class method and the
"save" object method.
"""
OBJ_PROJECT_NAMESPACE = "dcorch"
VERSION = "1.0"
@staticmethod
def _from_db_object(context, obj, db_obj):
if db_obj is None:
return None
for field in obj.fields:
if field == "metadata":
obj["metadata"] = db_obj["meta_data"]
else:
obj[field] = db_obj[field]
obj._context = context
obj.obj_reset_changes()
return obj
class OrchestratorObjectRegistry(base.VersionedObjectRegistry):
def registration_hook(self, cls, index):
"""Callback for object registration.
When an object is registered, this function will be called for
maintaining dcorch.objects.$OBJECT as the highest-versioned
implementation of a given object.
"""
version = versionutils.convert_version_to_tuple(cls.VERSION)
if not hasattr(objects, cls.obj_name()):
setattr(objects, cls.obj_name(), cls)
else:
curr_version = versionutils.convert_version_to_tuple(
getattr(objects, cls.obj_name()).VERSION
)
if version >= curr_version:
setattr(objects, cls.obj_name(), cls)