Source code for hal.files.parsers

# -*- coding: utf-8 -*-


"""Parsers for raw databases """

import csv


class Parser:
    """Mother of all data-files parsers"""

    def __init__(self, file_path):
        """
        :param file_path: path to file
        """
        self.path = file_path
        self.lines = None  # list of lines in database

    def get_lines(self):
        """Gets lines in file

        :return: Lines in file
        """
        with open(self.path, "r") as data:
            self.lines = data.readlines()  # store data in arrays

        return self.lines


class CSVParser(Parser):
    """Parses CSV data files"""

    def __init__(self, file_path, encoding="utf-8"):
        """
        :param file_path: path to file
        :param encoding: Encoding to open file with
        """
        super().__init__(file_path)
        self.encoding = str(encoding).strip()

    def get_matrix(self):
        """Stores values in array, store lines in array

        :return: 2D matrix
        """
        data = []
        with open(self.path, encoding=self.encoding) as csv_file:
            csv_reader = csv.reader(csv_file, delimiter=",", quotechar="\"")
            for row in csv_reader:
                data.append(row)

        return data

    def get_headers_data(self):
        """Gets headers and data

        :return: headers of file
        """
        data = self.get_matrix()
        return data[0], data[1:]  # headers, data

    def get_dicts(self):
        """Gets dicts in file

        :return: (generator of) of dicts with data from .csv file
        """
        reader = csv.DictReader(open(self.path, "r", encoding=self.encoding))
        for row in reader:
            if row:
                yield row