Aller au contenu

File

File

Python
File(name)

Abstraction simple d'un fichier tabulaire (CSV/XLSX).

Cette classe offre des méthodes pour charger un fichier CSV ou Excel dans un pandas.DataFrame, extraire des messages depuis une feuille dédiée et récupérer des méta-informations de base.

Initialise l'objet fichier.

Parameters:

Name Type Description Default
name str

Chemin/nom du fichier.

 required
Source code in cmpparis/file.py
Python
15
16
17
18
19
20
21
def __init__(self, name):
    """Initialise l'objet fichier.

    Args:
        name (str): Chemin/nom du fichier.
    """
    self.name = name

Functions

get_extension

Python
get_extension()

Renvoie l'extension du fichier.

Returns:

Name Type Description
str

Extension du fichier (ex: csv, xlsx).
Source code in cmpparis/file.py
Python
31
32
33
34
35
36
37
def get_extension(self):
    """Renvoie l'extension du fichier.

    Returns:
        str: Extension du fichier (ex: ``csv``, ``xlsx``).
    """
    return self.name.split(".")[-1]

get_name

Python
get_name()

Renvoie le nom/chemin du fichier.

Returns:

Name Type Description
str

Nom du fichier.
Source code in cmpparis/file.py
Python
39
40
41
42
43
44
45
def get_name(self):
    """Renvoie le nom/chemin du fichier.

    Returns:
        str: Nom du fichier.
    """
    return self.name

csv_to_dataframe

Python
csv_to_dataframe()

Charge un fichier CSV dans un pandas.DataFrame.

Returns:

Type Description

pandas.DataFrame: Données lues.

Raises:

Type Description
Exception

Si le fichier est introuvable ou en cas d'erreur de lecture.
Source code in cmpparis/file.py
Python
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def csv_to_dataframe(self):
    """Charge un fichier CSV dans un ``pandas.DataFrame``.

    Returns:
        pandas.DataFrame: Données lues.

    Raises:
        Exception: Si le fichier est introuvable ou en cas d'erreur de lecture.
    """
    try:
        #read the file and convert it to a DataFrame
        with open(self.name, 'r', errors="ignore") as csv_file:
            csv_reader = pd.read_csv(filepath_or_buffer=csv_file, delimiter=';', dtype=object)

        return csv_reader
    except FileNotFoundError as e:
        raise Exception(f"The CSV file was not found : {e}")
    except Exception as e:
        raise Exception(f"Error while reading the CSV file : {e}")

excel_to_dataframe

Python
excel_to_dataframe(sheet_name=None)

Charge un fichier Excel dans un pandas.DataFrame.

Parameters:

Name Type Description Default
sheet_name str | None

Nom de la feuille à lire. Si None, la première feuille sera lue.

 None

Returns:

Type Description

pandas.DataFrame: Données lues.

Raises:

Type Description
Exception

Si le fichier est introuvable ou en cas d'erreur de lecture.
Source code in cmpparis/file.py
Python
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
def excel_to_dataframe(self, sheet_name=None):
    """Charge un fichier Excel dans un ``pandas.DataFrame``.

    Args:
        sheet_name (str | None): Nom de la feuille à lire. Si ``None``, la première feuille sera lue.

    Returns:
        pandas.DataFrame: Données lues.

    Raises:
        Exception: Si le fichier est introuvable ou en cas d'erreur de lecture.
    """
    try:
        if (sheet_name != None):
            excel_reader = pd.read_excel(io=self.name, sheet_name=sheet_name)
        else:
            excel_reader = pd.read_excel(io=self.name)

        return excel_reader
    except FileNotFoundError as e:
        raise Exception(f"The Excel file was not found : {e}")
    except Exception as e:
        raise Exception(f"Error while reading the Excel file : {e}")

extract_message_from_code

Python
extract_message_from_code(code)

Extrait un message depuis l'onglet MESSAGES d'un fichier Excel.

Parameters:

Name Type Description Default
code str | int

Code du message à rechercher.

 required

Returns:

Name Type Description
Any

Valeur du message correspondant au code.
Source code in cmpparis/file.py
Python
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def extract_message_from_code(self, code):
    """Extrait un message depuis l'onglet ``MESSAGES`` d'un fichier Excel.

    Args:
        code (str | int): Code du message à rechercher.

    Returns:
        Any: Valeur du message correspondant au code.
    """
    msg_list = self.excel_to_dataframe('MESSAGES')

    message = msg_list.loc[msg_list['code'] == code]

    return message['message'].values[0]

read_file_to_dataframe

Python
read_file_to_dataframe(sheet=None)

Lit le fichier et renvoie un pandas.DataFrame selon l'extension.

Extensions supportées: csv, xlsx.

Parameters:

Name Type Description Default
sheet str | None

Nom de la feuille Excel à lire, si applicable.

 None

Returns:

Type Description

pandas.DataFrame: Données lues.

Raises:

Type Description
Exception

Si l'extension n'est pas supportée ou si le DataFrame est vide.
Source code in cmpparis/file.py
Python
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
def read_file_to_dataframe(self, sheet=None):
    """Lit le fichier et renvoie un ``pandas.DataFrame`` selon l'extension.

    Extensions supportées: ``csv``, ``xlsx``.

    Args:
        sheet (str | None): Nom de la feuille Excel à lire, si applicable.

    Returns:
        pandas.DataFrame: Données lues.

    Raises:
        Exception: Si l'extension n'est pas supportée ou si le DataFrame est vide.
    """
    if (self.get_extension() not in supported_extensions):
        raise Exception("Unsupported file extension")

    file_extension = self.get_extension()

    match file_extension:
        case "csv":
            df = self.csv_to_dataframe()

            if (df.size == 0):
                raise Exception("The dataframe is empty")

            return df
        case _:
            df = self.excel_to_dataframe(sheet)

            if (df.size == 0):
                raise Exception("The dataframe is empty")

            return df