summaryrefslogtreecommitdiffstats
path: root/cyborg_enhancement/mitaka_version/cyborg/cyborg/accelerator/drivers/base.py
blob: 2706022618f5cadf0dadc01756d03f609244f35e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# Copyright 2017 Lenovo, Inc.
#
# 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.
"""
Abstract base classes for drivers.
"""

import abc
import six


@six.add_metaclass(abc.ABCMeta)
class BaseDriver(object):
    """Base class for all drivers.

    Defines the abstract base class for generic and vendor drivers.
    """

    standard_interfaces = ('discover', 'list', 'update', 'attach', 'detach')

    discover = None
    """`Standard` attribute for discovering drivers.

    A reference to an instance of :class:DiscoverInterface.
    """

    list = None
    """`Core` attribute for listing drivers.

    A reference to an instance of :class:ListInterface.
    """

    update = None
    """`Standard` attribute to update drivers.

    A reference to an instance of :class:UpdateInterface.
    """

    attach = None
    """`Standard` attribute to attach accelerator to an instance.

    A reference to an instance of :class:AttachInterface.
    """

    detach = None
    """`Standard` attribute to detach accelerator to an instance.

    A reference to an instance of :class:AttachInterface.
    """

    def __init__(self):
        pass

    @property
    def all_interfaces(self):
        return (list(self.standard_interfaces))

    def get_properties(self):
        """Gets the properties of the driver.

        :returns: dictionary of <property name>:<property description> entries.
        """

        properties = {}
        for iface_name in self.all_interfaces:
            iface = getattr(self, iface_name, None)
            if iface:
                properties.update(iface.get_properties())
        return properties