class_name und classname -> Konsolidierung der Schreibweisen

[Robert]

Hi!

In https://knx-user-forum.de/forum/supp...95#post1420195 sind mir die unterschiedlichen Schreibweisen von "class_name" (in /etc/plugin.yaml) und "classname" (in /plugins/xxxx/plugin.yaml) schon auf die Füße gefallen bzw. dort war ein Bug versteckt.

In zuvor genannten Post habe ich aufgedröselt wer da wen wie benennt - sicher wäre es sinnvoll ein und den gleichen Namen einheitlich zu haben.

siehe auch _get_classname_and_classpath in lib/plugin.py

1. erst wird versucht über "classname = plg_conf.get(KEY_CLASS_NAME,'')" mit der in lib/constants.py definierten Konstante "KEY_CLASS_NAME = 'class_name'" aufzulösen
2. wenn das nicht klappt (ich will das ja nicht immer redundant setzen - denke das war der Gedanke...) wird es mit classname = self.meta.get_string('classname') eben aus der plugin-eigenen plugin-yaml gelesen

Insgesamt unschön ist die verwirrende Schreibweise mal "class_name", mal "classname". Zeile 272 könnte generell auch die Konstante nehmen. Dann müssten aber alle Plugin.yaml geändert werden... Oder man versucht es dort mit beiden Schreibweisen.

Vorschlag:

1. Ändern aller /plugins/xxxx/yaml auf "class_name", inkl. der Doku
2. diese Änderung muss dann auch in die ganzen /dev und Doku-Sachen im smarthome-Repo
3. Umbennung von _get_classname und _set_classname in _____class_name___

Zu diesem Zweck würde ich mich auf Python-, Markdown-, JSON- und YAML-Dateien beschränken. Javascript und HTML referenzieren in allen Fällen imho andere "classname".

Ich kann das gerne als zwei PRs aufbereiten - jedoch macht diese Arbeit nur Sinn wenn es dann zeitnah gemerged wird.

Grüße
Robert

[Robert]

Hab mal zwei PRs erstellt - smarthome läuft noch...

https://github.com/smarthomeNG/smarthome/pull/334
https://github.com/smarthomeNG/plugins/pull/293

[henfri]

Danke Robert,

das hat mir auch schon Kummer bereitet!

Gruß,
Hendrik