Skip to content

Commit 7d8a2f9

Browse files
committed
feat(doc): finaliser la normalisation des docstrings EN sur le reste du projet
1 parent bb791d2 commit 7d8a2f9

27 files changed

Lines changed: 1016 additions & 1020 deletions

File tree

Core/ArkConfigManager.py

Lines changed: 65 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@
2424
2525
Le file de configuration utilise le format YAML et permet de personnaliser:
2626
- Les patterns de files à inclure/exclure de la compilation
27-
- Les gestionnaires d'environnement virtuel (Poetry, Pipenv, Conda, etc.)
28-
- Les options de dépendances
27+
- Les managementnaires d'environment virtual (Poetry, Pipenv, Conda, etc.)
28+
- Les options de dependencies
2929
30-
Note: La configuration des plugins BCASL est gérée exclusivement par bcasl.yml
30+
Note: La configuration des BCASL plugins est gérée exclusivement par bcasl.yml
3131
"""
3232

3333
import os
@@ -131,19 +131,19 @@
131131

132132
def _deep_merge_dict(base: dict, override: dict) -> dict:
133133
"""
134-
Recursively merge two dictionaries.
134+
Recursively merge two dictionaries.
135135
136-
Cette fonction permet de combiner une configuration de base avec des
137-
valeurs personnalisées. Les dictionnaires imbriqués sont fusionnés
138-
plutôt que remplacés, permettant une configuration modulaire.
136+
Cette fonction permet de combiner une configuration de base avec des
137+
valeurs personnalisées. Les dictionnaires imbriqués sont fusionnés
138+
plutôt que remplacés, permettant une configuration modulaire.
139139
140-
Args:
141-
base: Dictionnaire de configuration de base
142-
override: Dictionnaire contenant les valeurs à surcharger
140+
Args:
141+
base: Dictionnaire de configuration de base
142+
override: Dictionnaire contenant les valeurs à surloadr
143143
144-
Returns:
145-
Un nouveau dictionnaire avec les valeurs fusionnées
146-
"""
144+
Returns:
145+
Un nouveau dictionnaire avec les valeurs fusionnées
146+
"""
147147
result = base.copy()
148148
for key, value in override.items():
149149
if key in result and isinstance(result[key], dict) and isinstance(value, dict):
@@ -157,25 +157,25 @@ def _deep_merge_dict(base: dict, override: dict) -> dict:
157157

158158
def load_ark_config(workspace_dir: str) -> dict[str, Any]:
159159
"""
160-
Load ARK configuration from a YAML file.
160+
Load ARK configuration from a YAML file.
161161
162-
Cette fonction recherche un file de configuration dans le workspace
163-
selon un ordre de priorité prédéfini et fusionne la configuration
164-
utilisateur avec les valeurs par défaut.
162+
Cette fonction recherche un file de configuration dans le workspace
163+
selon un ordre de priorité prédéfini et fusionne la configuration
164+
utilisateur avec les valeurs par défaut.
165165
166-
Fichiers recherchés (ordre de priorité):
167-
1. ARK_Main_Config.yaml
168-
2. ARK_Main_Config.yml
169-
3. .ARK_Main_Config.yaml
170-
4. .ARK_Main_Config.yml
166+
Fichiers recherchés (ordre de priorité):
167+
1. ARK_Main_Config.yaml
168+
2. ARK_Main_Config.yml
169+
3. .ARK_Main_Config.yaml
170+
4. .ARK_Main_Config.yml
171171
172-
Args:
173-
workspace_dir: Path absolu vers le directory du workspace
172+
Args:
173+
workspace_dir: Path absolu vers le directory du workspace
174174
175-
Returns:
176-
Dictionnaire complet de configuration, incluant les valeurs par défaut
177-
et les personnalisations utilisateur
178-
"""
175+
Returns:
176+
Dictionnaire complet de configuration, incluant les valeurs par défaut
177+
et les personnalisations utilisateur
178+
"""
179179
import copy
180180

181181
# Commencer avec une copie complète de la configuration par défaut
@@ -283,11 +283,11 @@ def load_ark_config(workspace_dir: str) -> dict[str, Any]:
283283

284284
def get_dependency_options(config: dict[str, Any]) -> dict[str, Any]:
285285
"""
286-
Return dependency management options.
286+
Return dependency management options.
287287
288-
Returns:
289-
Dictionnaire des options de dépendances
290-
"""
288+
Returns:
289+
Dictionnaire des options de dependencies
290+
"""
291291
return config.get("dependencies", {})
292292

293293

@@ -313,11 +313,11 @@ def get_build_options(config: dict[str, Any]) -> dict[str, Any]:
313313

314314
def get_entrypoint(config: dict[str, Any]) -> Optional[str]:
315315
"""
316-
Return configured entry point.
316+
Return configured entry point.
317317
318-
Returns:
319-
Path relatif du point d'entrée ou None
320-
"""
318+
Returns:
319+
Path relatif du point d'entrée ou None
320+
"""
321321
build_opts = get_build_options(config)
322322
if not isinstance(build_opts, dict):
323323
return None
@@ -327,15 +327,15 @@ def get_entrypoint(config: dict[str, Any]) -> Optional[str]:
327327

328328
def save_ark_config(workspace_dir: str, config: dict[str, Any]) -> bool:
329329
"""
330-
Save ARK configuration to ARK_Main_Config.yml.
330+
Save ARK configuration to ARK_Main_Config.yml.
331331
332-
Args:
333-
workspace_dir: Path du workspace
334-
config: Configuration complète à enregistrer
332+
Args:
333+
workspace_dir: Path du workspace
334+
config: Configuration complète à enregistrer
335335
336-
Returns:
337-
True si succès, False sinon
338-
"""
336+
Returns:
337+
True si success, False sinon
338+
"""
339339
if not workspace_dir or not isinstance(config, dict):
340340
return False
341341
try:
@@ -356,15 +356,15 @@ def save_ark_config(workspace_dir: str, config: dict[str, Any]) -> bool:
356356

357357
def set_entrypoint(workspace_dir: str, entrypoint: Optional[str]) -> bool:
358358
"""
359-
Update entry point in ARK_Main_Config.yml.
359+
Update entry point in ARK_Main_Config.yml.
360360
361-
Args:
362-
workspace_dir: Path du workspace
363-
entrypoint: Path relatif du point d'entrée (ou None pour effacer)
361+
Args:
362+
workspace_dir: Path du workspace
363+
entrypoint: Path relatif du point d'entrée (ou None pour clearr)
364364
365-
Returns:
366-
True si succès, False sinon
367-
"""
365+
Returns:
366+
True si success, False sinon
367+
"""
368368
if not workspace_dir:
369369
return False
370370
cfg = load_ark_config(workspace_dir)
@@ -382,12 +382,12 @@ def set_entrypoint(workspace_dir: str, entrypoint: Optional[str]) -> bool:
382382

383383
def _normalize_exclusion_pattern(pattern: str) -> str:
384384
"""
385-
Normalize exclusion pattern for reliable cross-platform matching.
385+
Normalize exclusion pattern for reliable cross-platform matching.
386386
387-
- Convertit les séparateurs Windows en "/"
388-
- Retire le préfixe "./"
389-
- Si le pattern se termine par "/", on l'étend à "/**"
390-
"""
387+
- Convertit les séparateurs Windows en "/"
388+
- Retire le préfixe "./"
389+
- Si le pattern se termine par "/", on l'étend à "/**"
390+
"""
391391
p = str(pattern).strip()
392392
if not p:
393393
return ""
@@ -482,19 +482,19 @@ def should_exclude_file(
482482

483483
def create_default_ark_config(workspace_dir: str) -> bool:
484484
"""
485-
Create ARK_Main_Config.yml with default configuration.
485+
Create ARK_Main_Config.yml with default configuration.
486486
487-
Cette fonction génère un file de configuration complet avec
488-
toutes les options disponibles et leurs valeurs par défaut.
489-
Elle ne remplace pas un file existant.
487+
Cette fonction génère un file de configuration complet avec
488+
toutes les options disponibles et leurs valeurs par défaut.
489+
Elle ne remplace pas un file existant.
490490
491-
Args:
492-
workspace_dir: Path du directory du workspace
491+
Args:
492+
workspace_dir: Path du directory du workspace
493493
494-
Returns:
495-
True si le file a été créé avec succès, False s'il existe déjà
496-
ou si une erreur s'est produite
497-
"""
494+
Returns:
495+
True si le file a été créé avec success, False s'il existe déjà
496+
ou si une erreur s'est produite
497+
"""
498498
if not workspace_dir:
499499
return False
500500

Core/Auto_Command_Builder/auto_build.py

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
"""
44
Automatic detection of sensitive modules and hook/plugin application
5-
pour les moteurs, basée sur un mapping JSON piloté par les moteurs (ENGINES).
5+
pour les engines, basée sur un mapping JSON piloté par les engines (ENGINES).
66
77
Règles clés:
88
- La détection est automatique et non désactivable par l'utilisateur.
99
- Priorité à requirements.txt s'il existe dans le workspace, sinon scan des imports.
10-
- Les actions sont dérivées du JSON (clé = id du moteur).
10+
- Les actions sont dérivées du JSON (clé = id du engine).
1111
- Rapport optionnel pouvant être écrit dans le workspace.
1212
"""
1313

@@ -259,10 +259,10 @@ def _parse_requirements(requirements_path: str) -> set[str]:
259259

260260
def _scan_imports(py_files: list[str], workspace_dir: str) -> set[str]:
261261
"""Analyze .py files and return imported top-level module names.
262-
- Ignore venv/, __pycache__/ et folders cachés
263-
- Ignore files trop volumineux (>1.5 Mo) pour robustesse
264-
- Tolérant aux erreurs d'encodage/syntaxe
265-
"""
262+
- Ignore venv/, __pycache__/ et folders cachés
263+
- Ignore files trop volumineux (>1.5 Mo) pour robustesse
264+
- Tolérant aux erreurs d'encodage/syntaxe
265+
"""
266266
found: set[str] = set()
267267
# Exclure venv interne
268268
venv_dir = os.path.abspath(os.path.join(workspace_dir, "venv"))
@@ -580,14 +580,14 @@ def compute_for_all(
580580
self, engine_ids: Optional[list[str]] = None
581581
) -> dict[str, list[str]]:
582582
"""
583-
Compute auto arguments for all engines (plug-and-play).
584-
- engine_ids: liste optionnelle d'identifiants de moteurs à traiter. Si None,
585-
on détecte automatiquement:
586-
* moteurs enregistrés dans _ENGINE_BUILDERS
587-
* moteurs avec un mapping engine_plugins/<engine_id>/mapping.json
588-
* moteurs embarqués utils/engines/<engine_id>/mapping.json
589-
Return un dict: { engine_id: List[str] }.
590-
"""
583+
Compute auto arguments for all engines (plug-and-play).
584+
- engine_ids: liste optionnelle d'identifiants de engines à traiter. Si None,
585+
on detect automatiquement:
586+
* engines enregistrés dans _ENGINE_BUILDERS
587+
* engines avec un mapping engine_plugins/<engine_id>/mapping.json
588+
* engines embarqués utils/engines/<engine_id>/mapping.json
589+
Return un dict: { engine_id: List[str] }.
590+
"""
591591
# Construire la liste ordonnée des moteurs à traiter
592592
ordered: list[str] = []
593593
if engine_ids:

Core/Compiler/compiler.py

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -442,20 +442,20 @@ def compile(
442442
workspace_dir: Optional[str] = None,
443443
) -> bool:
444444
"""
445-
Start a compilation.
446-
447-
Args:
448-
program: Executable path
449-
args: Argument list
450-
env: Environment variables (optional)
451-
working_dir: Working directory (optional)
452-
engine_id: Identifiant du moteur (optionnel)
453-
file_path: Path du file à compiler (optionnel)
454-
workspace_dir: Path du workspace (optionnel)
455-
456-
Returns:
457-
True si la compilation a démarré, False sinon
458-
"""
445+
Start a compilation.
446+
447+
Args:
448+
program: Executable path
449+
args: Argument list
450+
env: Environment variables (optional)
451+
working_dir: Working directory (optional)
452+
engine_id: Identifiant du engine (optionnel)
453+
file_path: Path du file à compiler (optionnel)
454+
workspace_dir: Path du workspace (optionnel)
455+
456+
Returns:
457+
True si la compilation a démarré, False sinon
458+
"""
459459
if self.is_running:
460460
self.log_message.emit("warning", "Compilation already in progress")
461461
return False
@@ -498,11 +498,11 @@ def compile(
498498

499499
def cancel(self) -> bool:
500500
"""
501-
Cancel current compilation.
501+
Cancel current compilation.
502502
503-
Returns:
504-
True si l'annulation a été demandée, False sinon
505-
"""
503+
Returns:
504+
True si l'annulation a été demandée, False sinon
505+
"""
506506
if not self.is_running:
507507
return False
508508

@@ -555,15 +555,15 @@ def _on_finished(self, return_code: int) -> None:
555555

556556
def get_command_line(self, program: str, args: List[str]) -> str:
557557
"""
558-
Return the formatted command line.
558+
Return the formatted command line.
559559
560-
Args:
561-
program: Programme à exécuter
562-
args: Arguments
560+
Args:
561+
program: Programme à executer
562+
args: Arguments
563563
564-
Returns:
565-
Ligne de commande formatée
566-
"""
564+
Returns:
565+
Ligne de commande formatée
566+
"""
567567
cmd = [program] + args
568568
return " ".join(cmd)
569569

@@ -575,17 +575,17 @@ def dry_run(
575575
working_dir: Optional[str] = None,
576576
) -> str:
577577
"""
578-
Simulate compilation and return the command.
578+
Simulate compilation and return the command.
579579
580-
Args:
581-
program: Programme à exécuter
582-
args: Arguments
583-
env: Environment variables (optional)
584-
working_dir: Working directory (optional)
580+
Args:
581+
program: Programme à executer
582+
args: Arguments
583+
env: Environment variables (optional)
584+
working_dir: Working directory (optional)
585585
586-
Returns:
587-
Commande formatée
588-
"""
586+
Returns:
587+
Commande formatée
588+
"""
589589
cmd = self.get_command_line(program, args)
590590
result = f"[DRY RUN] Command: {cmd}\n"
591591
result += f"Working directory: {working_dir or 'current'}\n"

0 commit comments

Comments
 (0)