Phenquestions
Exemple-1 : Accéder à la docstring d'une fonction en utilisant __doc__ attribut
La façon de déclarer et d'accéder à la docstring d'une fonction personnalisée a montré dans le script suivant. Le script suivant calcule le xm où x et n seront pris de l'utilisateur. Pouvoir () fonction a défini dans le script pour effectuer la tâche. Ici, la docstring a été définie pour cette fonction. __doc__ l'attribut a été utilisé dans le script pour imprimer la docstring avec la sortie.
puissance def(x, n):"Calculer x à la puissance n
Lire les valeurs de x et n à partir des arguments de la fonction
et Calculer et renvoyer la valeur de x à la puissance n."
retourner x**n
# Prendre la valeur de x
x = int(input('Entrez la valeur de x:'))
# Prendre la valeur de n
n = int(input('Entrez la valeur de n:'))
# Affiche la valeur de retour de la fonction
print("Le %d à la puissance %d = %d" %(x, n, puissance(x, n)))
# Affiche la valeur docstring
print("Le contenu de la docstring :\n" + power.__doc__)
Production:
La sortie suivante apparaîtra après l'exécution du script ci-dessus.
Exemple-2 : Accéder à la docstring de la classe et de la méthode à l'aide aider() méthode
La façon de déclarer et d'accéder à la docstring du document et les méthodes de cette classe a montré dans le script suivant. La fonction principale du script est de trier une liste numérique et d'inverser les données de la liste. Une liste numérique de 8 éléments a été déclarée dans la classe, et la docstring a été définie au début de la classe en utilisant des guillemets simples triples. La méthode sort_list() a été définie dans la classe pour imprimer les données triées de la liste, et le document l'a défini pour cette méthode. reverse_list() la méthode est définie pour imprimer les données inversées de la liste, et la docstring a également été définie pour cette méthode. aider() méthode a appelé trois fois à la fin du script pour imprimer la docstring du list_operations classer, liste_tri() méthode, et la reverse_list() méthode.
classe list_operations :
classe list_operations :"
Trier et inverser les données de la liste
La classe contient deux méthodes,
La méthode sort_list() va trier et imprimer la liste,
La méthode sort_reverse() inversera et imprimera la liste.
"
# Définir une liste de données numériques
données de liste = [23, 67, 23, 6, 45, 3, 90, 11]
def sort_list(self):
"
Imprimer les valeurs de la liste après tri
La fonction prendra un objet de liste de données numériques à partir de l'argument,
trier les valeurs de la liste en utilisant la méthode sort()
et imprimer les valeurs de la liste triée.
"
# Trier la liste
soi.données de liste.sorte()
# Imprimer la liste triée à l'aide de la boucle
print("Les valeurs de la liste triée :\n")
pour la valeur en soi.données de liste :
print(valeur, " ", fin=")
def reverse_list(self):
"
Imprimer les valeurs de la liste après inversion
La fonction prendra un objet de liste de données numériques à partir de l'argument,
inverser les valeurs de la liste en utilisant la méthode reverse()
et imprimer les valeurs de la liste inversée.
"
# Inverser la liste
soi.données de liste.sens inverse()
# Imprimer la liste inversée en utilisant la boucle
print("Les valeurs de la liste triée :\n")
pour la valeur en soi.données de liste :
print(valeur, " ", fin=")
# Affiche la valeur docstring de la classe
help(list_operations)
# Créer un objet de la classe
obj = list_operations()
# Affiche la valeur docstring de la méthode particulière
aide(obj.liste_tri)
# Appeler la méthode pour imprimer la liste triée
obj.liste_tri()
Production:
La sortie suivante apparaîtra après l'exécution du script. Toute la docstring du script a été imprimée pour la première aider() une fonction. La docstring de la liste_tri() méthode a été imprimée pour la deuxième aider() une fonction.
Exemple-3 : Accéder à la docstring du module Python intégré
Dans les exemples précédents, la docstring a été utilisée dans la classe et la fonction définies par l'utilisateur. Chaque module et classe Python intégrés a sa docstring qui explique le but de l'utilisation de ce module ou de cette fonction particulière. Le codeur du module ou de la fonction définit la docstring pour rendre le code compréhensible pour les utilisateurs. Le script suivant imprimera la docstring prédéfinie du module datetime en utilisant le aider() une fonction.
# Importer le module datetimedate/heure d'importation
# Affiche la docstring de datetime
aide(dateheure)
Production:
La sortie suivante apparaîtra après l'exécution du script. La docstring du module datetime en montre la documentation détaillée pour aider les autres à connaître correctement les fonctions des classes et méthodes définies dans ce module.
Conclusion:
La documentation appropriée est essentielle lorsqu'un module ou une fonction est implémenté dans le but spécifique d'aider l'autre codeur à utiliser le module dans son code pour effectuer la tâche particulière. Si la documentation n'est pas correctement définie pour le module ou la fonction, les autres utilisateurs rencontreront des problèmes pour l'utiliser. Ainsi, chaque codeur doit utiliser la docstring du document pour fournir des informations détaillées aux autres pour comprendre le code.
