[PYTHON] Wie man Jupytext gut einstellt, wenn man Code als Team verwaltet

Es ist schmerzhaft, wenn jemand anderes "~ / .jupyter / jupyter_notebook_config.py" mit den automatischen Konvertierungseinstellungen von jupytext bearbeitet. Ich habe eine gute Einstellungsmethode, also werde ich sie teilen.

Erste Schlussfolgerung

Platzieren Sie eine Datei mit dem folgenden Inhalt im Stammverzeichnis des Projekts.

`jupytext.yml`


default_jupytext_formats: "ipynb,py:percent"

Was ist Jupytext?

jupytext ist ein Tool, das ".ipynb" -Dateien in ".py", ".R", ".jl", ".md", ".Rmd" usw. konvertiert. Durch die Einstellung funktioniert es mit jupyter lab und konvertiert es automatisch, wenn eine Datei gespeichert wird. Es kann auch über die Befehlszeile ausgeführt werden und ist daher vielseitig einsetzbar.

Es gibt ein anderes Tool zum Konvertieren in ".ipynb-> .py", "nbconvert", aber es ist sehr wichtig, es zu entwickeln, um es beim Speichern automatisch zu konvertieren.

.ipynb <-> .py-Konvertierung

Das Analysieren mit mehreren Personen zeigt die schlechten Punkte von ".ipynb". Dort sind einige

Es ist schwer, Git zu verwalten.
Es hat das Format "json" und ist zum Zeitpunkt der Überprüfung schwer zu lesen.

Es ist schwer zu teilen. Eine der Lösungen hierfür ist die Konvertierung in das Python-Format. Dies macht das Notebook leicht und leicht zu lesen, was eine nette Geste ist. Sie können das Notebook auch problemlos reproduzieren, indem Sie .py-> .ipynb konvertieren.

Umgebung

#Pipenv-Umgebung
python 3.8.5
jupyterlab 2.2.6

Verwendungsverfahren

1. Installation von Jupytext

Wenn Sie pipenv nicht verwenden, ersetzen Sie es durch ein gutes.

$ pipenv install jupytext

2. Erstellen Sie ein Jupyter-Labor

Wenn Sie jupyter lab nach der Installation starten, werden Sie gefragt, ob Sie es erstellen möchten. Erstellen Sie es also einfach. Wenn Sie manuell erstellen möchten, verwenden Sie "pipenv run jupyter lab build".

Wie einstellen

4 Arten von Einstellmethoden

Es gibt vier Einstellmethoden.

Bearbeiten Sie die .ipynb-Metadaten
jupytext --set-formats ipynb,py notebook.ipynb
Bearbeiten Sie ~ / .jupyter / jupyter_notebook_config.py
Erstellen Sie eine Jupytext-Konfigurationsdatei

1 und 2 müssen für jede Datei festgelegt werden, was problematisch ist. Der Betrieb kann für 3 nicht garantiert werden, da Dateien außerhalb des Repositorys ausgeführt werden müssen.

Dieses Mal werde ich über Nr. 4 erklären. Diese Methode ist nett, da sie bereits festgelegt ist, auch wenn eine andere Person das Repository abruft.

Konfigurationsdatei erstellen

Erstellen Sie eine Konfigurationsdatei mit einem der folgenden Namen. .jupytext jupytext.toml jupytext.yml jupytext.yaml jupytext.json jupytext.py Oder das Format mit "." Am Anfang

Wenn Sie diese Datei im Stammverzeichnis des Projekts ablegen, wird sie automatisch gelesen. Bitte überprüfen Sie den Referenzlink für Details zum Standort.

Die automatische Konvertierung funktioniert wie folgt. Diesmal habe ich es in Yaml geschrieben.

`jupytext.yml`


default_jupytext_formats: "ipynb,py:percent"

In Anbetracht der Verwendung mit VSCode und PyCharm wird für Python-Dateien das Format "py: Prozent" empfohlen.

Daher denke ich, dass die Verzeichnisstruktur so aussehen wird.

.
├── Pipfile
├── Pipfile.lock
├── notebook.ipynb  #Notizbuch erstellt
├── notebook.py  #Konvertierte und generierte Python
└── jupytext.yml  #Einstellungsdatei

Zusammenfassung

Die Konvertierung von ".ipynb <-> .py" erleichtert Teams die Verwaltung von Code. --Jupytext kann beim Speichern einer Datei automatisch konvertiert werden.
Es gibt verschiedene Möglichkeiten, Jupytext einzustellen
Einfache Freigabe von Einstellungen mithilfe einer Einstellungsdatei --py: Prozent ist sicher

das ist alles!

Referenz

Configuration — Jupytext documentation