Skip to content

Commit 86c1f3e

Browse files
Docs: Ajout de la documentation des attributs des dataclasses
- Modification de la documentation des attributs des dataclasses pour qu'ils soient bien documentés - Exclusion des doublons de documentation de Sphinx pour les attributs de classe dans les .rst respectifs des dataclasses
1 parent cfc07d7 commit 86c1f3e

10 files changed

Lines changed: 13 additions & 9 deletions

app/donnees/client_informations.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ class ClientInformations:
1414
Cette classe regroupe les données extraites d'une entrée de log,
1515
qui concernent le client ayant effectué la requête au serveur Apache.
1616
17-
Args:
17+
Attributes:
1818
adresse_ip (str): L'adresse IP du client.
1919
identifiant_rfc (Optional[str]): L'identifiant RFC du client.
2020
Peut être None si non fournie.

app/donnees/reponse_informations.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ class ReponseInformations:
1515
qui concernent les informations techniques sur la réponse émise par
1616
le serveur Apache au client.
1717
18-
Args:
18+
Attributes:
1919
code_statut_http (int): Le code de statut HTTP.
2020
taille_octets (Optional[int]): La taille de la réponse en octets.
2121
Peut être None si non fournie.

app/donnees/requete_informations.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ class RequeteInformations:
1515
qui concernent les informations techniques sur la requête émise au
1616
serveur Apache.
1717
18-
Args:
18+
Attributes:
1919
horodatage (datetime): L'horodatage de la requête.
2020
methode_http (Optional[str]): La méthode HTTP utilisée.
2121
Peut être None si non fournie.

app/parse/entree_log_apache.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ class EntreeLogApache:
1313
"""
1414
Représente une entrée dans un fichier de log Apache.
1515
16-
Args:
17-
informations_client (ClientInformations): Les informations du client.
18-
informations_requete (RequeteInformations): Les informations de la requête.
19-
informations_reponse (ReponseInformations): Les informations de la réponse.
16+
Attributes:
17+
client (ClientInformations): Les informations du client.
18+
requete (RequeteInformations): Les informations de la requête.
19+
reponse (ReponseInformations): Les informations de la réponse.
2020
"""
2121
client: ClientInformations
2222
requete: RequeteInformations

app/parse/fichier_log_apache.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ class FichierLogApache:
1111
"""
1212
Représente un fichier de log Apache.
1313
14-
Args:
14+
Attributes:
1515
chemin (str): Le chemin du fichier.
1616
entrees (list): La liste des entrées du fichier.
1717
"""

docs/source/modules/donnees/client_informations.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ ClientInformations
55
:members:
66
:show-inheritance:
77
:undoc-members:
8+
:exclude-members: adresse_ip, identifiant_rfc, nom_utilisateur, agent_utilisateur

docs/source/modules/donnees/reponse_informations.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ ReponseInformations
55
:members:
66
:show-inheritance:
77
:undoc-members:
8+
:exclude-members: code_statut_http, taille_octets

docs/source/modules/donnees/requete_informations.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ RequeteInformations
55
:members:
66
:show-inheritance:
77
:undoc-members:
8-
:exclude-members: dataclass
8+
:exclude-members: horodatage, methode_http, url, protocole_http, ancienne_url

docs/source/modules/parse/entree_log_apache.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ EntreeLogApache
55
:members:
66
:show-inheritance:
77
:undoc-members:
8+
:exclude-members: client, requete, reponse

docs/source/modules/parse/fichier_log_apache.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ FichierLogApache
55
:members:
66
:show-inheritance:
77
:undoc-members:
8+
:exclude-members: chemin, entrees

0 commit comments

Comments
 (0)