[PYTHON] Utilisez Jupyter Notebook comme outil de test unitaire ou de création manuelle

Jupyter Notebook C'est pratique, est-ce que vous l'utilisez? C'est pratique pour implémenter et vérifier le code, mais c'est un excellent qui peut même effectuer des tests unitaires et une production manuelle si elle est conçue. Dans cet article, je présenterai une utilisation pratique qui est un peu différente de l'utilisation conventionnelle.

Utilisé pour le test unitaire

Jupyter est pratique car vous pouvez écrire du code tout en vérifiant le résultat. Ne serait-il pas pratique que le travail de confirmation puisse être utilisé tel quel pour les tests unitaires?

Vous pouvez le faire avec pytest-ipynb!

pytest-ipynb peut être facilement installé avec pip.

$ pip install pytest-ipynb

Ce module est une extension de la bibliothèque de test py.test, vous devez donc également installer py.test.

C'est facile à utiliser, jetez simplement un Notebook nommé test * .ipynb dans le répertoire où vous testez. Après cela, vous pouvez écrire le contenu du test dans cette cellule comme suit.

Exemple de test

''' mul test '''
a = 100 * 2
assert a == 200

J'ai essayé de traduire la liste des fonctions du manuel.

--Découvrez le fichier «test * .ipynb» -Chaque cellule de Notebook fonctionne comme un test unitaire (utilisez simplement assert)

• Le commentaire (docstring) dans la première ligne de chaque cellule est traité comme un nom de test ou un nom de fonction. --Si vous mettez "fixture *" ou "setup *" dans la docstring, il sera exécuté avant chaque test unitaire. --Si vous écrivez "KIPCI" dans la docstring, le test Travis-CI sera ignoré (vérifiez si la variable d'environnement CI est définie).
• Le noyau IPython Notebook sera redémarré après le test
• Le dossier de travail pendant le test est local dans le fichier .ipynb

Si vous faites une erreur dans la traduction, veuillez le signaler.

Après cela, lancez simplement py.test -v normalement, et il fera le test, y compris Notebook.

Utilisé pour Readme.md

Il peut également être utilisé pour Readme.md sur Github, ce qui est pratique lorsque vous souhaitez décrire le résultat de l'exécution. GitHub du module "Image4Layer" que j'ai créé génère également Readme.md à partir de Jupyter.

https://github.com/pashango2/Image4Layer

Sélectionnez Fichier> Télécharger en tant que> Markdown (.md) dans le menu Jupyter pour générer un fichier zip markdown.

Renommez le .md généré et ajustez-le et vous avez terminé. Cependant, si vous générez une image, etc., l'image sera développée dans le répertoire racine, donc je pense qu'elle doit être corrigée.

Utilisé pour Sphinx

Comme je l'ai écrit dans l'article "Je veux que tout le monde utilise Sphinx de manière pratique" (http://qiita.com/pashango2/items/d1b379b699af85b529ce), Notebook peut également être ajouté à Sphinx. Je vais. Il existe une extension de Sphinx appelée nbsphinx qui vous permet de capturer des notebooks Jupyter.

L'installation est facile avec pip.

pip install nbsphinx

Lors de l'importation dans Sphinx, l'affichage sera comme suit.

Pour les paramètres détaillés de Sphinx, reportez-vous aux articles suivants.

J'ai créé "sphinx-quickstart-plus" pour faciliter la documentation de Sphinx Je souhaite que tout le monde utilise Sphinx de manière pratique

Utilisé pour mesurer le temps de traitement

C'est une chose basique, mais je pense que certaines personnes peuvent ne pas le savoir, alors je vais le décrire.

La commande % timeit mesure également le temps de traitement de la fonction avec Jupyter. De plus, comme le meilleur moment est mesuré avec un nombre approprié d'essais en tenant compte de la fluctuation du temps de traitement, des résultats de mesure de meilleure qualité peuvent être obtenus que lors de la mesure par vous-même.

In [1]: %timeit l = [x ** 2 for x in range(1000)]
1000 loops, best of 3: 45 ms per loop

Résumé

Je veux lire les articles sur l'utilisation de Jupyter Notebook d'autres personnes!