os-vif/os_vif/objects/base.py
Rodolfo Alonso Hernandez 76ad6b2f49 Add VersionedObjectPrintable mixin
Added VersionedObjectPrintable mixin for versioned objects. If an
OVO inherits from this class, the output string will contain all
data stored in the object, along with the version, name, namespace
and fields changed.

Change-Id: Ice9418fc28ded9aff902a9e65008d68cb64093f5
2017-10-04 15:13:54 +01:00

32 lines
1.1 KiB
Python

# 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 oslo_versionedobjects import base as ovo_base
class VersionedObject(ovo_base.VersionedObject):
OBJ_PROJECT_NAMESPACE = 'os_vif'
class VersionedObjectPrintableMixin(object):
"""Mix-in to implement __str__ method for a versioned object
If a versioned object needs to be printable in a easy-reading format,
inherit from this class.
"""
def __str__(self):
if callable(getattr(self, 'obj_to_primitive', None)):
return str(self.obj_to_primitive())
return super(VersionedObjectPrintableMixin, self).__str__()