summaryrefslogtreecommitdiff
path: root/harnesses/host_controller/tfc/api_message.py
blob: d1b618e16344ab5bf137bd1e9dadd677cd05fcc7 (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
#
# Copyright (C) 2017 The Android Open Source Project
#
# 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.
#


class ApiMessage(object):
    """The class for the messages defined by TFC API."""

    def __init__(self, all_keys, **kwargs):
        """Initializes the attributes.

        Args:
            all_keys: A collection of attribute names.
            **kwargs: The names and values of the attributes. The names must be
                      in all_keys.

        Raises:
            KeyError if any key in kwargs is not in all_keys.
        """
        for key, value in kwargs.iteritems():
            if key not in all_keys:
                raise KeyError(key)
            setattr(self, key, value)

    def ToJson(self, keys):
        """Creates a JSON object containing the specified keys.

        Args:
            keys: The attributes to be included in the object.

        Returns:
            A JSON object.
        """
        return dict((x, getattr(self, x)) for x in keys if hasattr(self, x))