Wie paketiert man eine Bibliothek, deren Import in Python Nebenwirkungen erzeugt?

Question

ich auf eine Python-Bibliothek arbeite (nicht von mir), die wie folgt aussieht:

. 
├── README.md 
├── setup.py 
└── library 
    ├── __init__.py 
    ├── core.py 
    ├── a.py 
    └── b.py 

Die Datei __init__.py nutzen core.py die sich a.py und b.py verwendet. Die wichtige Sache zu beachten ist, dass import library einige Nebenwirkungen hat, die absichtlich beabsichtigt sind.

Allerdings möchte ich dem Benutzer die Möglichkeit geben, Funktionen von core.py ohne irgendwelche Nebenwirkungen zu verwenden. Leider, wie Sie wissen, wird import library.core oder from library import core__init__.py (wo Nebenwirkungen auftreten) sowieso ausführen.

Wissen Sie, wie ich mein Paket und die setup.py reorganisieren könnte, um dieses Problem zu lösen?

---

Ich dachte so etwas wie dieses:

. 
├── README.md 
├── setup.py 
├── library_core 
│ ├── __init__.py 
│ ├── core.py 
│ ├── a.py 
│ └── b.py 
└── library 
    └── __init__.py # Import library_core and apply side effects 

I setup.py mit packages = ['library', 'library_core'] aktualisieren würde. Auf diese Weise ändert der Import von library nichts, aber der Benutzer könnte dann library_core ohne irgendwelche Nebenwirkungen importieren. Außerdem würde dies das Duplizieren von Code vermeiden und alles würde im selben Repository bleiben.

Leider funktioniert das nicht, weil ich library_core von library nicht importieren kann, da sie nicht an der gleichen Stelle in der Dateistruktur sind.

Answer 1

Mit zwei Paket scheint der beste Weg zu sein.

Die Verwendung von zwei benachbarten Paketen kann nur funktionieren , wenn die gesamte Bibliothek (mit python setup.py install zum Beispiel) installiert ist. Dies verkompliziert die Entwicklung beträchtlich, beispielsweise für Komponententests: es war dann unmöglich, import library zu tun, da library_core nicht gefunden werden konnte, wenn es nicht installiert war.

Also, die beste Lösung ist einfach ein Unterpaket zu machen, und innerhalb der setup.py wo library_core befindet sich dank der package_dir Option.

Die Dateien Baum würde wie folgt aussehen:

. 
├── README.md 
├── setup.py 
└── library 
    ├── __init__.py 
    └── core 
     ├── __init__.py 
     ├── a.py 
     └── b.py 

Und in setup.py:

setup(
    name = 'library', 
    packages = ['library', 'library.core', 'library_core'], 
    package_dir = {'library_core': 'library/core'}, 
    ... 
) 

Answer 2

Ich würde empfehlen, dass Sie aufhören, sich auf Nebenwirkungen zu verlassen, und vom Benutzer verlangen, sie explizit auszulösen, indem Sie eine dokumentierte Funktion aufrufen. Sonst kämpfen Sie einen verlorenen Kampf: der Standard ist, die Nebenwirkungen auszulösen, und Sie müssen sie dann rückgängig machen, wenn der Benutzer sie nicht will.