utils/python/coverage/file_summary.py

#
# Copyright (C) 2016 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 FileSummary(object):
    """Summarizes structure and coverage information from GCC output.

    Represents the data in .gcno and .gcda files.

    Attributes:
    functions: Dictionary of FunctionSummary objects for each function described
        in a GCNO file (key: integer ident, value: FunctionSummary object)
    """

    def __init__(self):
        """Inits the object with an empty list in its functions attribute.
        """
        self.functions = {}

    def __str__(self):
        """Serializes the summary as a string.

        Returns:
            String representation of the functions, blocks, arcs, and lines.
        """
        output = 'Coverage Summary:\r\n'
        for ident in self.functions:
            output += str(self.functions[ident])
        return output