Styles de programmation d’Adapter
Adapter est écrit en Python, et les développeurs d’Adapter doivent donc se conformer au Guide de style pour le code Python.
En outre, pour améliorer la qualité du code et la lisibilité du programme, les développeurs d’Adapter doivent également respecter les conventions définies dans cette section.
Conventions de nommage
-
Utilisez la casse camel pour nommer la classe, comme indiqué ci-dessous :
class AdapterWidget -
Utilisez des lettres minuscules reliées par des underscores pour nommer les variables membres et les fonctions membres, comme indiqué ci-dessous :
self.pick_count # Remarquez que les variables sont généralement des noms def start_viz(self): # Remarquez que le nom de fonction est généralement un verbe + objet pass -
Un underscore placé avant le nom d’une variable membre ou d’une fonction membre indique qu’il est recommandé d’utiliser ces variables et fonctions uniquement à l’intérieur de la classe. Toutefois, il reste possible d’utiliser ces variables et fonctions en dehors de la classe si nécessaire, comme indiqué ci-dessous :
self._socket = socket() # Indique que la variable _socket n'est utilisée qu'à l'intérieur de la classe def _init_widget(self): # Indique que la fonction _init_widget n'est utilisée qu'à l'intérieur de la classe pass -
Utilisez des lettres majuscules reliées par des underscores pour nommer les constantes, comme indiqué ci-dessous :
ADAPTER_DIR = "D:/adapter_for_communication"
Conventions de commentaires
N’ajoutez des commentaires que lorsque la logique est complexe ou que l’information du commentaire est critique.
-
Commentaires sur une seule ligne
Utilisez # pour commencer le commentaire.
-
Commentaires multilignes
Utilisez des triples guillemets (""") pour délimiter les commentaires multilignes. Veuillez noter que les """ qui terminent un commentaire multiligne doivent se trouver sur une ligne à part.
-
L’introduction d’une fonction, d’une classe ou d’un package
L’introduction d’une fonction ou d’une classe doit être placée à la fin de la fonction ou de la classe, tandis que l’introduction d’un package doit être placée au début, comme indiqué ci-dessous :
def viz_is_running(self): """ Sera appelée lorsqu'on constate que viz est en cours d'exécution pendant le démarrage de viz. """ class Adapter(QObject): """ Classe de base qui encapsule les interfaces Viz/Vision/Hub/Robserver. """ """ Classes de base de service. """ import logging
Conventions de journalisation
Les journaux peuvent être utilisés pour le dépannage lorsqu’une erreur survient. Le journal doit être émis au moment approprié, par exemple lorsqu’une fonction clé est appelée et que des données de référence sont renvoyées.
Adapter prend en charge deux méthodes pour produire le journal:
-
print: Cette méthode ne peut produire le journal que dans la console, ce qui est pratique pour visualiser en temps réel l’état d’exécution du projet. Cependant, les messages de journal seront perdus en cas d’erreur, et il n’est donc pas recommandé d’utiliser cette méthode en production.
-
logging: Cette méthode est davantage recommandée car elle permet de définir le format d’affichage du journal et d’enregistrer les messages de journal dans un fichier (optionnel).