Docstring nuchy

Docstring Numpy est la forme courte d'une chaîne de documentation Numpy. Les docstrings Numpy fournissent un moyen pratique d'associer la documentation aux modules, fonctions, classes et méthodes Numpy. Dans ce guide, nous apprendrons à créer les docstrings dans Numpy et nous essaierons de comprendre quand, comment et où ils sont utilisés. Les docstrings sont des commentaires en plusieurs lignes à l'intérieur des fonctions, des méthodes, des modules, des classes, etc. Avant d'apprendre les docstrings, comprenons quels sont les commentaires multilines.

Puisque nous savons déjà comment rédiger les commentaires multilines, nous pouvons soit utiliser les citations simples triples ou les citations triples doubles. Nous utilisons une chaîne de documentation lorsque nous voulons décrire nos fonctions afin que nous puissions obtenir la documentation lorsque nous en avons besoin. Certains IDE vous donnent une documentation en survolant le nom et certains mettent en évidence certains mots clés. Mais le fait est que les docstrings dans Numpy sont beaucoup plus flexibles que dans d'autres langues. Docstring est un littéral de cordes qui se produit au début de la définition de la fonction. Nous devons fournir des valeurs spécifiques tout en utilisant les docstrings en cas de fonctions, de classes, etc.

Lorsque vous utilisez des docstrings avec des fonctions, nous devons passer les arguments. Lorsque nous les utilisons avec des classes, nous passons les attributs et les méthodes. Dans le cas des modules, nous devons fournir une liste de classes et de fonctions. Dans le cas du package, nous passons la liste des modules avec fonctionnalité. Donc, fondamentalement, le but du docstring est, comme son nom l'explique, qu'il aide à la documentation de notre code. Nous faisons de la documentation afin que si quelqu'un utilise notre code à l'avenir, il sera en mesure de comprendre notre code et la logique derrière notre code à l'aide de Docstring. Les fonctions intégrées contiennent également des docstrings; Nous pouvons utiliser la fonction de l'aide () pour examiner le docstring des fonctions intégrées.

Il existe quelques différences entre les commentaires et les docstrings. Les commentaires sont ignorés par les interprètes mais les docstrings ne sont pas ignorés par les interprètes. La mémoire est allouée aux docstrings. Un commentaire est une description du code mais d'un autre côté, les docstrings nous disent le but du code.

Syntaxe:

La syntaxe pour écrire les docstrings dans Numpy est:

"" "Message docstring" ""
Ou
"Message docstring"

Veuillez noter que le docstring n'est pas une fonction ou une méthode, donc elle n'a pas de syntaxe appropriée. La seule chose à noter ici est que nous commençons le docstring avec trois citations simples ou trois citations doubles. Nous écrivons notre description du code et la terminons à nouveau avec trois citations simples ou trois citations doubles à la fin. Il n'y a aucune chose obligatoire à écrire pour les docstrings. Il vous suffit de mettre trois citations simples ou doubles avant et après la description de votre chaîne.

Exemple 1:

Pour comprendre les docstrings d'une meilleure manière, effectuons un exemple. Dans cet exemple, après avoir inclus la bibliothèque Numpy, nous déclarons simplement la variable «A» et une autre variable «B». Après cela, nous créons notre docstring qui dit «Ajoutons« A »et« B »Variables». Dans notre cas, c'est un exemple facile mais si notre code est complexe, cela aide beaucoup le codeur à comprendre le code. Après cela, nous résumons les variables «A» et «B» et stockons leur sortie, ce qui se traduit par une autre variable qui est «C». Enfin, nous imprimons la valeur de la variable «C». Maintenant, nous exécutons notre code.

Importer Numpy comme NP
a = 1
b = 2
"Permet d'ajouter des variables A et B"
c = a + b
Imprimer (c)

Ceci est notre sortie du morceau de code donné. Nous pouvons voir que le système n'a donné aucune erreur sur une syntaxe incorrecte ou quoi que ce soit pour la ligne7 de notre code. De plus, le système n'a pas imprimé notre docstring. Au lieu de cela, il n'a imprimé que la sortie de notre variable «C» dans laquelle nous avons dit à notre système d'imprimer. Cela montre comment les docstrings fonctionnent. La prochaine fois, lorsqu'un nouveau codeur essaie de travailler sur notre code, il comprendra ce que nous faisons avec l'aide de notre docstring. Mais il ne sera pas imprimé en tant que sortie afin que l'utilisateur du code ne soit pas dérangé par celui-ci.

Exemple 2:

Maintenant, nous effectuons un exemple complexe pour comprendre le travail du docstring. Tout d'abord, nous incluons la bibliothèque Numpy, puis écrivons une chaîne Doc dans laquelle nous expliquons la ligne de code suivante où nous expliquons l'initialisation du tableau. Nous ajoutons également les docstrings dans l'autre partie du code. Maintenant, si nous partageons ce code avec un nouveau développeur Python sans ajouter les docstrings, il sera en quelque sorte difficile pour lui de connaître le travail et le but de ce code. Il doit d'abord rechercher les fonctions que nous avons utilisées. Mais si nous ajoutons un docstring à notre code, il sera facile pour les autres développeurs de comprendre le code sans étudier davantage sur les fonctions. Nous ne nous limitons pas à ajouter des commentaires à certaines limites; Les commentaires peuvent être d'une ou plusieurs lignes. Il peut également être ajouté plus d'une fois dans un code. Ensuite, importez Numpy comme np.

"Création de la variable à laquelle nous passerons un tableau de taille 1x6"
array = np.Array ([11, 22, 33, 44, 55, 66])
"Attribution du tableau à la fonction tofile () pour le laisser enregistrer dans le fichier nommé ARR"
déployer.tofile ("arr.poubelle")
"Afficher le fichier à l'aide de la fonction de fichier"
Imprimer (NP.FromFile ("arr.bin ", dtype = int))

Comme le montre l'extrait suivant, les docstrings ne sont pas affichés dans la sortie, ce qui signifie qu'il n'affecte pas la sortie ou la compilation du code. Les docstrings sont ignorés pendant le processus de compilation.

Conclusion

Dans ce guide, nous avons appris les docstrings dans Numpy. Nous avons comparé les docstrings avec des commentaires et expliqué la différence entre les deux. Nous avons appris la syntaxe des docstrings et comment écrire les docstrings dans notre code. De plus, nous avons également essayé d'expliquer ce que sont les docstrings dans Numpy et comment ils fonctionnent avec l'aide d'exemples. Enfin, nous avons remarqué qu'ils sont essentiels pour les codeurs. Nous ne répéterons pas l'importance des docstrings dans Numpy. Nous dirons simplement que vous devriez utiliser les docstrings dans votre code. Dans Numpy, le style d'écriture des docstrings est le plus populaire. Il est largement utilisé dans la communauté de programmation pour se faire connaître le travail et les fonctionnalités de leurs codes. Ce guide vous aidera à démarrer avec des docstrings Numpy. Nous avons essayé de couvrir la plupart de ce dont vous aurez besoin en utilisant les docstrings dans Numpy.