Meilleures pratiques pour transformer les carnets jupyter en scripts python

Nous avons le même problème. Cependant, nous utilisons plusieurs notebooks pour prototyper les résultats qui devraient aussi devenir plusieurs scripts python après tout.

notre approche est que nous avons mis de côté le code, qui coutures à répéter à travers ces carnets. Nous l'avons mis dans le module python, qui est importé par chaque ordinateur portable et également utilisé dans la production. Nous améliorons ce module de façon itérative de façon continue et ajoutons des tests de ce que nous trouvons lors du prototypage.

deviennent alors un peu comme les scripts de configuration (que nous copions simplement dans les fichiers Python résultants) et plusieurs vérifications de prototypage et validations, dont nous n'avons pas besoin dans la production.

nous n'avons surtout pas peur du remaniement:)

Life saver : pendant que vous écrivez vos notebooks, remaniez progressivement votre code en fonctions, en écrivant quelques tests et docstrings minimaux assert .

après cela, le remaniement de bloc-notes en écriture est naturel. Non seulement cela, mais il rend votre vie plus facile en écrivant de longs carnets, même si vous n'avez pas l'intention de les transformer en autre chose.

exemple de Base d'un le contenu de la cellule avec des tests et des docstrings" minimes":

def zip_count(f):
    """Given zip filename, returns number of files inside.

    str -> int"""
    from contextlib import closing
    with closing(zipfile.ZipFile(f)) as archive:
        num_files = len(archive.infolist())
    return num_files

zip_filename = 'data/myfile.zip'

# Make sure `myfile` always has three files
assert zip_count(zip_filename) == 3
# And total zip size is under 2 MB
assert os.path.getsize(zip_filename) / 1024**2 < 2

print(zip_count(zip_filename))

une fois que vous l'aurez exporté vers des fichiers .py , votre code ne sera probablement pas encore structuré en classes. Mais il vaut la peine de l'effort d'avoir remanié votre ordinateur portable au point où il a un ensemble de fonctions documentées, chacune avec un ensemble de simples assert déclarations qui peuvent facilement être déplacés dans tests.py pour les tests avec pytest , unittest , ou ce que vous avez. Si elle fait sens, regrouper ces fonctions dans des méthodes pour vos classes est mort-facile après cela.

si tout va bien, tout ce que vous devez faire après cela est d'écrire votre if __name__ == '__main__': et ses" hooks": si vous écrivez un script qui sera appelé par le terminal , vous voudrez Gérer les arguments en ligne de commande , si vous écrivez un module, vous voudrez penser à son API avec le __init__.py fichier , etc.

tout dépend de ce que le cas d'utilisation prévue est, bien sûr: il ya une grande différence entre la conversion d'un carnet à un petit script par rapport à le transformer en un module ou un paquet à part entière.

voici quelques idées pour un workflow de bloc-notes à script :

1. Exportation de Jupyter Portable fichier Python (.py) par le biais de l'interface graphique.
2. supprimer les lignes" helper " qui ne pas faire le travail réel: print déclarations, parcelles,etc.
3. si nécessaire, Regroupez votre logique en classes. Le seul travail de remaniement supplémentaire requis devrait être d'écrire vos docstrings et attributs de classe.
4. écrivez les entrées de votre script avec if __name__ == '__main__' .
5. séparez vos énoncés assert pour chacune de vos fonctions/méthodes, et étoffez une suite de test minimale dans tests.py .