RomanNum3ral
/
Solaar
mirror of https://github.com/pwr-Solaar/Solaar.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

settings: Add docstrings and type hint 

Related #2273
This commit is contained in:
MattHag 2024-11-03 23:45:11 +01:00 committed by Peter F. Patel-Schneider
parent 8bc42d20fb
commit 0d7fc46a81
1 changed files with 18 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
lib/logitech_receiver/settings_templates.py
View File

@ -1911,15 +1911,20 @@ def check_feature(device, settings_class: SettingsProtocol) -> None | bool | Any
return False # differentiate from an error-free determination that the setting is not supported return False # differentiate from an error-free determination that the setting is not supported
# Returns True if device was queried to find features, False otherwise def check_feature_settings(device, already_known) -> bool:
def check_feature_settings(device, already_known): """Auto-detect device settings by the HID++ 2.0 features they have.
"""Auto-detect device settings by the HID++ 2.0 features they have."""
Returns
-------
bool
True, if device was queried to find features, False otherwise.
"""
if not device.features or not device.online: if not device.features or not device.online:
return False return False
if device.protocol and device.protocol < 2.0: if device.protocol and device.protocol < 2.0:
return False return False
absent = device.persister.get("_absent", []) if device.persister else [] absent = device.persister.get("_absent", []) if device.persister else []
newAbsent = [] new_absent = []
for sclass in SETTINGS: for sclass in SETTINGS:
if sclass.feature: if sclass.feature:
known_present = device.persister and sclass.name in device.persister known_present = device.persister and sclass.name in device.persister
@ -1928,22 +1933,22 @@ def check_feature_settings(device, already_known):
if isinstance(setting, list): if isinstance(setting, list):
for s in setting: for s in setting:
already_known.append(s) already_known.append(s)
if sclass.name in newAbsent: if sclass.name in new_absent:
newAbsent.remove(sclass.name) new_absent.remove(sclass.name)
elif setting: elif setting:
already_known.append(setting) already_known.append(setting)
if sclass.name in newAbsent: if sclass.name in new_absent:
newAbsent.remove(sclass.name) new_absent.remove(sclass.name)
elif setting is None: elif setting is None:
if sclass.name not in newAbsent and sclass.name not in absent and sclass.name not in device.persister: if sclass.name not in new_absent and sclass.name not in absent and sclass.name not in device.persister:
newAbsent.append(sclass.name) new_absent.append(sclass.name)
if device.persister and newAbsent: if device.persister and new_absent:
absent.extend(newAbsent) absent.extend(new_absent)
device.persister["_absent"] = absent device.persister["_absent"] = absent
return True return True
def check_feature_setting(device, setting_name): def check_feature_setting(device, setting_name) -> settings.Setting | None:
for sclass in SETTINGS: for sclass in SETTINGS:
if sclass.feature and sclass.name == setting_name and device.features: if sclass.feature and sclass.name == setting_name and device.features:
setting = check_feature(device, sclass) setting = check_feature(device, sclass)