Magic Comment (PEP 263) am Anfang der einzugebenden Datein festlegen

[SophieAltenburg]

In die Comment Section der einzugebenden Datein soll nach Möglichkeit ein Kommentar die kompatiblen Chefkoch-Versionen vermerken und diese soll beim Einlesen geprüft werden. In JSON-Datein sind eventuell keine Kommentare möglich. In den Python-Datein, die die Simulationsschritte enthalten, müssen sie aber unbedingt rein.

[SophieAltenburg]

In JSON Datein sind keine Kommentare möglich, daher sollen die Nutzereingaben durch .YML files passieren. Magic Comments sollen also in .YML files eingefügt werden.

[ChristophWWagner]

Grundsätzlich sind Magic Comments immer gefährlich, da ein Kommentar eigentlich keinen Einfluss auf das Geschehen haben sollte. Klar gibt es diese "ugly implementations" überall, die komisches Zeug auf der Basis von Kommentaen tun. Meist deutet das allerdings lediglich auf schlechte Architektur hin. Das wollen wir besser machen :)

Wie würdet ihr vorschlagen die Version abzuprüfen? Ich würde folgendes vorschlagen:

• Nur exakt einen zentralen Namen für Versionsdefinitionen verwenden (z.B. 'version'), um Verwirrung zu minimieren
• Einen konsistente Namensregel für Versionsconstraints verwenden (z.B. 'minXxxxVersion'), wobei 'Xxxx' für den Namen dessen steht, was gerade auf Version geprüft werden soll, ebenfalls um Verwirrung vorzubeugen
• Das kann man damit beliebig auf alles mögliche erweitern: 'minRecipeVersion', 'minStepVersion', 'minChefkochVersion', 'minPythonVersion', ...
• Jeder PythonStep bekommt neben der execute function` ebenfalls ein 'version' Feld (optional), das die Version des Steps kennzeichnet kennzeichnet
• Jede Section im cheffile kann mit einem ' version' Feld ausgestattet werden, um jedem Recipe, Flavour, etc. auch eine Versionskennung hinzuzufügen. Da das cheffile aus mehreren Konfigurationsdateien bestehen kann, wären hier Versionskonflikte denkbar. Über Details, wie das genau aufzulösen ist, würde ich mir später Gedanken machen. Erstmal reicht es abzusehen, dass diese Felder gebraucht werden.

Weitere Ideen? Seht ihr bei irgendetwas konkrete Probleme dabei?

• Chefkoch selbst hat bereits ein version Feld
• In der Konfiguration kann an jeder beliebigen Stelle