[PYTHON] Verwenden Sie Jupyter Notebook als Komponententest oder manuelles Erstellungswerkzeug

Jupyter Notebook Es ist praktisch, benutzt ihr es? Es ist praktisch für die Implementierung und Überprüfung des Codes, aber es ist hervorragend geeignet, um sogar Unit-Tests und manuelle Produktion durchzuführen, wenn es entwickelt wurde. In diesem Artikel werde ich eine bequeme Verwendung vorstellen, die sich ein wenig von der herkömmlichen Verwendung unterscheidet.

Wird für Unit-Tests verwendet

Jupyter ist praktisch, da Sie Code schreiben können, während Sie das Ergebnis überprüfen. Wäre es nicht praktisch, wenn die Bestätigungsarbeiten so wie sie sind für Unit-Tests verwendet werden könnten?

Sie können dies mit pytest-ipynb tun!

pytest-ipynb kann einfach mit pip installiert werden.

$ pip install pytest-ipynb

Dieses Modul ist eine Erweiterung der Testbibliothek py.test, daher müssen Sie auch py.test installieren.

Es ist einfach zu bedienen, werfen Sie einfach ein Notizbuch mit dem Namen "test * .ipynb" in das Verzeichnis, in dem Sie testen. Danach können Sie den Testinhalt wie folgt in diese Zelle schreiben.

Testbeispiel

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

Ich habe versucht, die Funktionsliste des Handbuchs zu übersetzen.

• Entdecken Sie die Datei 'test * .ipynb' -Jede Zelle im Notebook wird als Komponententest ausgeführt (verwenden Sie einfach assert).
• Der Kommentar (docstring) in der ersten Zeile jeder Zelle wird als Testname oder Funktionsname behandelt.
• Wenn Sie 'fixture *' oder'setup * 'in die Dokumentzeichenfolge einfügen, wird diese vor jedem Komponententest ausgeführt.
• Wenn Sie "SKIPCI" in die Dokumentzeichenfolge schreiben, wird der Travis-CI-Test übersprungen (überprüfen Sie, ob die CI-Umgebungsvariable definiert ist).
• Der IPython Notebook-Kernel wird nach dem Testen neu gestartet
• Der Arbeitsordner während des Tests befindet sich lokal in der IPynb-Datei

Wenn Sie bei der Übersetzung einen Fehler machen, weisen Sie bitte darauf hin.

Führen Sie danach einfach "py.test -v" normal aus und der Test wird einschließlich Notebook ausgeführt.

Wird für Readme.md verwendet

Es kann auch für Readme.md auf Github verwendet werden. Dies ist praktisch, wenn Sie das Ausführungsergebnis beschreiben möchten. GitHub des von mir erstellten Moduls "Image4Layer" generiert auch Readme.md aus Jupyter.

https://github.com/pashango2/Image4Layer

Wählen Sie im Jupyter-Menü Datei> Herunterladen als> Markdown (.md), um eine Markdown-Zip-Datei zu erstellen.

Benennen Sie die generierte .md um und optimieren Sie sie, und Sie sind fertig. Wenn Sie jedoch ein Bild usw. generieren, wird das Bild im Stammverzeichnis erweitert, sodass ich denke, dass es korrigiert werden muss.

Wird für Sphinx verwendet

Wie ich in dem Artikel "Ich möchte, dass jeder Sphinx bequem benutzt" (http://qiita.com/pashango2/items/d1b379b699af85b529ce) schrieb, kann Notebook auch zu Sphinx hinzugefügt werden. Ich werde. Es gibt eine Sphinx-Erweiterung namens nbsphinx, mit der Sie Jupyter-Notizbücher erfassen können.

Die Installation ist mit pip einfach.

pip install nbsphinx

Beim Import in Sphinx sieht die Anzeige wie folgt aus.

Ausführliche Informationen zu Sphinx finden Sie in den folgenden Artikeln.

Ich habe "sphinx-quickstart-plus" erstellt, um die Sphinx-Dokumentation bequemer zu gestalten Ich möchte, dass jeder Sphinx bequem benutzt

Wird zur Messung der Verarbeitungszeit verwendet

Es ist eine grundlegende Sache, aber ich denke, einige Leute wissen es vielleicht nicht, also werde ich es beschreiben.

Der Befehl % timeit misst auch die Verarbeitungszeit der Funktion mit Jupyter. Da die beste Zeit mit einer angemessenen Anzahl von Versuchen unter Berücksichtigung der Schwankung der Verarbeitungszeit gemessen wird, können darüber hinaus Messergebnisse von höherer Qualität erzielt werden, als wenn Sie selbst messen.

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

Zusammenfassung

Ich möchte die Jupyter Notebook-Nutzungsartikel anderer Leute lesen!