DTLcode — Guide utilisateur v1.7-3
Analyser rapidement un fichier source et comprendre son rôle sans l'exécuter.
À quoi sert DTLcode ?
DTLcode aide à répondre à une question simple : « À quoi sert ce fichier source ? » Il lit le fichier, reconnaît son langage, repère ses composants et produit une page HTML claire présentant son rôle probable.
Vous pouvez l'utiliser pour découvrir un ancien programme, préparer une documentation, orienter un audit ou obtenir une première vue d'ensemble avant de lire le code en détail.
Prérequis
Avec l'exécutable
Utilisez DTLcode.exe directement. Python n'est pas requis sur le poste.
Avec le source
Utilisez Python 3.10 ou une version ultérieure. Aucune bibliothèque externe n'est nécessaire.
Premiers pas
Méthode la plus simple : la boîte de dialogue
- Double-cliquez sur
DTLcode.exe. - Dans la fenêtre de sélection, choisissez le fichier source à analyser.
- Attendez la création de
DTLcode_report.html. - Le rapport s'ouvre automatiquement dans votre navigateur par défaut.
Si vous annulez la sélection, le programme se ferme sans créer de fichier et sans afficher d'erreur.
Utilisation en ligne de commande
Cette commande analyse MonProgramme.py, écrit DTLcode_report.html dans le dossier courant et tente de l'ouvrir.
La même opération peut être exécutée depuis le fichier Python.
Lire le rapport
Informations générales
Le haut de la page indique le nom et le chemin du fichier, le langage détecté, le nombre de lignes, la taille et l'encodage. Ces données permettent de vérifier immédiatement que le bon fichier a été analysé.
Rôle et déroulement
À quoi sert ce fichier résume sa finalité probable. Comment le programme obtient le résultat présente les principales étapes repérées : lecture de données, analyse, transformation, appels externes ou création d'un résultat.
Tableau des sous-routines
Le tableau comporte deux colonnes :
| Colonne | Contenu |
|---|---|
| Fonction | Intitulé fonctionnel et lisible de la sous-routine. |
| Description | Une ou deux phrases expliquant les opérations réellement observées : lecture, analyse, validation, création d'objets, génération HTML, etc. |
La description ne répète pas le nom technique de la sous-routine. Si son rôle n'est pas certain, DTLcode indique les opérations visibles plutôt que d'inventer une intention.
Ressources, erreurs et utilisation
- Interface et présentation : interactions avec l'utilisateur ou éléments visuels détectés.
- Ressources utilisées : fichiers, URL, réseau, base de données ou commandes observés.
- Gestion des erreurs : présence de contrôles, exceptions ou traitements de panne.
- Limites ou avertissements : extension inconnue, fichier très volumineux ou analyse réduite.
- Utilisation : syntaxe et paramètres déduits du programme analysé.
Exemples pratiques
Analyser un programme Python
Utilisez des guillemets lorsque le chemin contient des espaces. Python bénéficie de l'analyse la plus détaillée : imports, classes, fonctions, affectations et opérations présentes dans les corps de fonctions.
Choisir le nom et l'emplacement du rapport
L'option -o ou --output fixe le chemin de la page HTML. Le dossier de destination doit déjà exister et être accessible en écriture.
Utiliser DTLcode dans un script
Le code de sortie permet à un script Batch ou PowerShell de détecter un échec. L'ouverture automatique du rapport dépend de l'association HTML configurée dans Windows.
Afficher la version
La commande affiche le nom et la version sans analyser de fichier.
Messages, erreurs et dépannage
Codes de sortie
| Code | Situation | Action conseillée |
|---|---|---|
| 0 | Rapport créé, version affichée ou sélection annulée. | Aucune action nécessaire. |
| 1 | Erreur de lecture, d'écriture ou erreur système. | Vérifiez les droits, l'encodage et le dossier de sortie. |
| 2 | Le chemin n'existe pas ou ne désigne pas un fichier. | Corrigez le chemin ou sélectionnez un autre fichier. |
Problèmes courants
| Symptôme | Cause probable | Solution |
|---|---|---|
| Le rapport ne s'ouvre pas | Aucune application n'est associée aux fichiers HTML. | Ouvrez manuellement le fichier dans un navigateur. |
| Impossible d'écrire le rapport | Dossier absent ou protégé. | Choisissez un dossier existant dans lequel vous pouvez écrire. |
| Langage inconnu | Extension non reconnue ou absente. | Vérifiez l'extension ; une analyse générique reste produite. |
| Peu d'informations | Langage générique, code dynamique ou fichier principalement composé de données. | Considérez le rapport comme une orientation et complétez par une lecture humaine. |
| Caractères incorrects | Encodage rare non reconnu. | Convertissez une copie du fichier en UTF-8 puis relancez l'analyse. |
Bien interpréter les résultats
- Le rapport est une synthèse heuristique, pas une preuve formelle du comportement.
- DTLcode ne suit pas les appels dans d'autres fichiers et n'analyse qu'une cible à la fois.
- Une fonctionnalité peut exister sans être détectée, notamment si elle est construite dynamiquement.
- Une ressource citée dans le code n'est pas nécessairement utilisée lors de chaque exécution.
- Pour un fichier de plus de 5 000 lignes, la synthèse est volontairement limitée.