Fileproxy

Complexity

Total Complexity

5

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__init__()	0	9	2
A	__hash__()	0	5	1
A	__str__()	0	5	1
A	__iter__()	0	5	1

from coala_utils.decorators import generate_eq


@generate_eq("filename")
class Fileproxy:
    """
    The file proxy is a wrapper object to wrap every file. The file proxy is an
    object that contains properties about the file currently processed (such as
    the filename). It contains:
        * The filename, this is the starting point for every other attribute.
        * The content of the file as a string.
        * The content of the file, line-splitted.

    Note: Other properties can be included later as and when required.

    The equality of the object is checked just based on it's filename.
    """

    def __init__(self, filename):
        """
        Constructs a new fileproxy object.
        :param filename: The name of the file to load.
        """
        self.filename = filename
        with open(self.filename, "r", encoding="utf-8") as filehandle:
            self.content = filehandle.read()
        self.lines = tuple(self.content.splitlines(True))

    def __iter__(self):
        """
        :return: A list of lines of the file to iterate over.
        """
        return iter(self.lines)

    def __hash__(self):
        """
        :return: Only hashes the filename.
        """
        return hash(self.filename)  # pragma: no cover

    def __str__(self):
        """
        :return: A string of contents of the whole file.
        """
        return self.content