Meilleures pratiques pour enregistrer les applications Python

Dans les applications Python, le module de journalisation doit être utilisé à la place de Print () pour créer un système de journal avec une structure claire, des informations complètes et des problèmes faciles à résoudre. Tout d'abord, utilisez la journalisation de la bibliothèque standard au lieu de PRINT () car elle prend en charge la journalisation à plusieurs niveaux (débogage, informations, avertissement, erreur, critique) et peut contrôler le format et l'emplacement de sortie de manière flexible; Deuxièmement, les informations de contexte, telles que le nom du module, le nom de la fonction, le numéro de ligne et les valeurs de variable clé, doivent être ajoutées au journal pour améliorer la lisibilité et les capacités de diagnostic du journal; Troisièmement, les journaux de processus en fonction de l'environnement, permettent le niveau de débogage pendant le développement, et l'environnement de production est limité à I. NFO ou à l'avertissement ou au-dessus des niveaux, et les journaux peuvent être gérés de manière centralisée en combinaison avec des fichiers ou des services tiers; Enfin, les pièges courants doivent être évités, comme utiliser logging.exception () au lieu de l'impression (e), et ne pas appeler BasicConfig () au niveau supérieur du module. Il est recommandé d'utiliser __name__ pour créer des journalistes et d'utiliser RotatingFileHandler pour implémenter la rotation des journaux, garantissant ainsi l'efficacité et la praticité du système de journal.

La connexion des applications Python semble simple, mais si vous le faites vraiment bien, vous devez toujours faire attention à la méthode. Le simple fait d'écrire print() ne suffit pas. Ce qui est vraiment utile, c'est un système de journal avec une structure claire, des informations complètes et des problèmes faciles à résoudre. Les points suivants sont des pratiques pratiques que j'ai résumées dans des projets réels.

Utilisez la journalisation de la bibliothèque standard au lieu de l'impression

De nombreux débutants aiment utiliser print() pour produire des informations de débogage au début, mais dans les projets formels, c'est loin d'être. Le module logging intégré de Python prend non seulement en charge différents niveaux de journalisation (tels que le débogage, les informations, l'avertissement, l'erreur, la critique), mais fournit également un contrôle flexible de l'emplacement et du format de sortie.

Par exemple:

 journalisation d'importation

logging.basicConfig (niveau = logging.info)
logger = logging.getLogger (__ name__)

Logger.info ("Ceci est un message d'information")
Logger.Error ("Ceci est un message d'erreur")

De cette façon, vous ne pouvez afficher les journaux qu'à un niveau d'erreur ou au-dessus, selon les besoins sans les informations pour perturber votre vision. Et il prend en charge la sortie sur les fichiers, le courrier et même les serveurs distants.

Ajouter des informations de contexte au journal

Cela n’aide pas beaucoup à regarder un «mal». La clé est de savoir où et pourquoi elle a mal tourné. Donc suggération:

• Chaque journal contient des informations telles que le nom du module, le nom de la fonction, le numéro de ligne, etc.
• Enregistrer les valeurs de variable clé ou les paramètres d'entrée
• S'il se trouve dans une application Web, vous pouvez ajouter le chemin de demande, l'ID utilisateur, etc.

La méthode de configuration est également très simple. Ajouter des paramètres de format à BasicConfig:

 logging.basicConfig (
    format = "% (asctime) s [% (niveaux) s]% (nom) s -% (funcname) s:% (lineno) d -% (message) s",
    niveau = logging.debug
)

De cette façon, les journaux de sortie sont plus clairs.

Journal de traitement gradué: développement vs production

Pendant le développement local, nous pouvons ouvrir des journaux de débogage pour faciliter les détails de la visualisation; Mais dans les environnements de production, seules les informations ou les avertissements ou au-dessus des journaux sont généralement conservés pour éviter la perte de performances et l'explosion des journaux.

Vous pouvez définir dynamiquement les niveaux de journal en fonction de différents environnements, tels que:

 Si Env == "Production":
    Logger.setLevel (Logging.Warning)
autre:
    logger.setLevel (logging.debug)

Vous pouvez également écrire des journaux à différents fichiers ou gérés de manière centralisée via des services tiers (tels que Sentry, Elk Stack).

Évitez les pièges courants

Lors de l'utilisation de l'exploitation forestière, il y a plusieurs problèmes mineurs courants qui sont facilement négligés:

• ❌ Ne pas utiliser except Exception as e: print(e) , logging.exception() doit être utilisé pour imprimer la pile d'erreur complète
• ❌ N'appelez pas basicConfig() directement en haut du module, sinon il peut affecter la configuration du journal d'autres modules.
• ✅ Il est recommandé d'utiliser __name__ pour créer un enregistreur pour s'assurer que chaque module a un espace de noms indépendant
• ✅ Il est préférable de faire tourner les fichiers journaux régulièrement, vous pouvez utiliser RotatingFileHandler ou TimedRotatingFileHandler

Fondamentalement, c'est tout. Le système de journaux n'est pas compliqué, mais les détails ne sont pas effectués correctement et peuvent facilement devenir une décoration ou un fardeau. Ce n'est que par configuration rationnelle et utilisation standardisée que nous pouvons aider à des moments critiques.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!