etlt.reader.UniversalCsvReaderFormatHelper

Complexity

Total Complexity

2

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	UniversalCsvReaderFormatHelper.pass2()	0	15	1
A	UniversalCsvReaderFormatHelper.pass1()	0	17	1

from typing import Dict


class UniversalCsvReaderFormatHelper:
    """
    A helper class for UniversalCsvReader for setting and correcting the formatting parameters for reading CSV files.
    """

    # ------------------------------------------------------------------------------------------------------------------
    def pass1(self, filename: str, formatting_parameters: Dict[str, str]) -> Dict[str, str]:
        """
        Returns the formatting parameters for reading the next current CSV file.

        This method is called by UniversalCsvReader before opening the CSV file and before auto-detecting parameters.

        Override this method in your own child class according to your needs.

        :param str filename: The next current file name.
        :param dict[str,str] formatting_parameters: The default formatting parameters. Keys are:
                                                     - encoding: Use auto for auto-detecting.
                                                     - delimiter: Use auto for auto-detecting.
                                                     - line_terminator: Use auto for auto-detecting.
                                                     - escape_char
                                                     - quote_char
        """
        return formatting_parameters

    # ------------------------------------------------------------------------------------------------------------------
    def pass2(self, filename: str, formatting_parameters1: Dict[str, str], formatting_parameters2: Dict[str, str]) -> \
            Dict[str, str]:
        """
        Returns the formatting parameters for reading the next current CSV file.

        This method is called by UniversalCsvReader after auto-detecting parameters.

        Override this method in your own child class according to your needs.

        :param str filename: The next current file name.
        :param dict[str,str] formatting_parameters1: The formatting parameters as returned by pass1.
        :param dict[str,str] formatting_parameters2: The formatting parameters as returned by pass1 but parameters set
                                                     to auto are replaced with the automatically detected values.
        """
        return formatting_parameters2

# ----------------------------------------------------------------------------------------------------------------------