Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Requirements von Logiken und Userfunctions installieren beim Start? #579

Open
bmxp opened this issue Aug 19, 2023 · 9 comments
Open

Requirements von Logiken und Userfunctions installieren beim Start? #579

bmxp opened this issue Aug 19, 2023 · 9 comments
Labels
core Issue relates to the core of SmartomeNG docu needs to be included oder updated in documentation enhancement resolved

Comments

@bmxp
Copy link
Member

bmxp commented Aug 19, 2023

Ab und zu gibt es Bibliotheken, die in Logiken oder Userfunctions genutzt werden. Diese Abhängigkeiten werden derzeit nicht berücksichtigt bei der Installation von Abhängigkeiten beim Systemstart.
Vielleicht könnte man das auf irgendeine Art berücksichtigen?

@msinn
Copy link
Member

msinn commented Aug 19, 2023

Meinst Du eine Lösung wie:

  • Auf dem Parameter Tab ein Feld für die Requirements hinzufügen
  • beim Start von shng Die Logik Paremeter auf die Requirements hin durchsehen und
  • die Requirements der requirements/conf_all.txt und der requirements/all.txt hinzufügen bevor die Requirements geprüft werden
    ?

@msinn msinn added enhancement core Issue relates to the core of SmartomeNG labels Aug 19, 2023
@Morg42
Copy link
Member

Morg42 commented Aug 21, 2023

Wenn das auf dem Parameter-Tab eingetragen werden kann, müsste es ja irgendwo gesichert werden - im Header der Logics- bzw. userfunctions-Datei?

In dem Fall wäre das ein Wechsel der bisherigen Konvention, Metadaten in gesonderten Dateien zu speichern. Möglich wäre ggf.

# requirements: foo im Header der Python-Datei (z.B.: ununterbrochener Kommentarblock von Dateibeginn an)

Eine zusätzliche yaml-Datei wäre möglich, müsste aber von Hand gepflegt werden und gilt dann jeweils für alle Logiken bzw. UF, da scheint mir Variante 1 besser handlebar.

@msinn
Copy link
Member

msinn commented Aug 21, 2023

Wenn das auf dem Parameter-Tab eingetragen werden kann, müsste es ja irgendwo gesichert werden - im Header der Logics- bzw. userfunctions-Datei?

Ich wäre für weder-noch. Meiner Meinung nach, würde die Information in die etc/logic.yaml gehören.

Einen direkten Zusammenhang mit den Userfunctions sehe ich erstmal nicht. Logiken können ja einfach ein import Statement enthalten.

Bei den Userfunctions Requirements zu hinterlegen ist noch mal ein weiteres Thema. Da muss ich noch mal drauf rumdenken. Eine Datei unter etc (analog zur etc/logic.yaml) könnte für Userfunctions auch noch ein anderes Problem lösen, das ich habe: Wenn ich eine Userfunctions Datei disablen möchte, muss ich bisher die .py Datei umbenennen (andere Endung dran). Es gibt bisher dafür keinen "Schalter".

@msinn
Copy link
Member

msinn commented Aug 21, 2023

Nei den Userfunctions könnte man das auch analog zu Plugins, dem lib Verzeichnis, … lösen.

In das functions Verzeichnis könnte man eine requirements.txt legen und shpypi könnte diese Datei mit in den Aufbau der Gesamt-Requirements aufnehmen.

@msinn
Copy link
Member

msinn commented Aug 29, 2023

Ich habe lib.shpypi erstmal so erweitert, dass in den Verzeichnissen ../logics und ../functions gespeicherte requirements.txt Dateien mit ausgewertet werden. In den generierten Dateien werden die Einträge als **user-defined'' gelistet. In der requirements/conf-all.txt sieht das z.B. dann so aus:

# configured plugin 'piratewthr'
# configured plugin 'darksky'
# configured plugin 'avm'
# configured plugin 'enigma2'
# SmartHomeNG-lib
# user-defined 'functions'
# user-defined 'logics'
requests>=2.20.0

Das ist noch nicht die eleganteste Version (da Logiken ja häufig in der Admin GUI geschrieben/modifiziert werden und man für die Requirements noch in den Maschinenraum muss, aber es ist erstmal eine praktikable Lösung.

Die requirements.txt Dateien werden im Konfigurations-Backup mit gesichert.

@CannonRS
Copy link
Contributor

Macht es nicht Sinn die requirements direkt in die User-Funktion oder Logik auszulagern. Also irgendwie als Kommentar oder in einer Variable im Code? Also so z.B.:

#requirements: pymodbus>='3.5.2'

oder
requirements = 'pymodbus>=3.5.2'

VIelleicht denke ich da zu naiv. Aber wäre die Auswertung aufwändig?

@Morg42
Copy link
Member

Morg42 commented Mar 3, 2024

Ich glaube, die meisten Ideen, die nicht auf einer requirements.txt basieren, dürften einfach daran scheitern, dass die requirements bei Laden von shng geprüft werden, die Logiken aber erst beim Starten geladen werden. Die notwendigen Informationen (nicht zuletzt die notwendigen/konfigurierten Verzeichnisse) stehen zu dem Zeitpunkt noch gar nicht zur Verfügung.

Ich halte es da für praktikabler, eine logics/requirements.txt (und analog) zu lesen, und wenn im Admin-UI die Logiken bearbeitet werden, könnte man die ggf. dort auf eine solche Zeile hin parsen, die dann an die requirements.txt angefügt wird. Das scheint mir aber noch ein langer Weg zu sein; und persönlich halte ich das nicht für dringlich über die schon vorhandene Implementation der requirements.txt hinaus.

@Morg42
Copy link
Member

Morg42 commented Dec 8, 2024

Zum jetzigen Zeitpunkt erstmal erledigt, da requirements gelesen und berücksichtigt werden.

Weitere Verbesserungen sind später im Rahmen Erweiterung core/admin-ui noch möglich.

@Morg42 Morg42 added the resolved label Dec 8, 2024
@bmxp
Copy link
Member Author

bmxp commented Dec 8, 2024

Ich habe eben mal danach geschaut aber keine Dokumentation dazu gefunden. Es ist zwar in den Release Notes zu 1.10 zu lesen das in lib.backup die requirements.txt berücksichtigt werden aber nicht, das in etc/logics oder etc/userfunctions die ggf. vorhandene requirements.txt ausgewertet wird.

@bmxp bmxp added the docu needs to be included oder updated in documentation label Dec 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Issue relates to the core of SmartomeNG docu needs to be included oder updated in documentation enhancement resolved
Projects
None yet
Development

No branches or pull requests

4 participants