Skip to content

refactor(obfuscate): improve type consistency and simplify branch logic #1890

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.

Sign up for GitHub

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

Open
tetienne wants to merge 2 commits into
base: main
Choose a base branch
from
Open

refactor(obfuscate): improve type consistency and simplify branch logic #1890

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f21199f
refactor(obfuscate): improve type consistency and simplify branch logic
tetienne Jan 9, 2026
4cc0b0b
refactor(obfuscate): use tuple for value membership check
tetienne Jan 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 7 additions & 18 deletions pyoverkiz/obfuscate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,15 @@ def obfuscate_string(input: str) -> str:
return re.sub(r"[a-zA-Z0-9_.-]*", "*", str(input))


# pylint: disable=too-many-branches
def obfuscate_sensitive_data(data: dict[str, Any]) -> JSON:
"""Mask Overkiz JSON data to remove sensitive data."""
mask_next_value = False

for key, value in data.items():
if key in ["gatewayId", "id", "deviceURL"]:
if key in {"gatewayId", "id", "deviceURL"}:
data[key] = obfuscate_id(value)

if key in [
if key in {
"label",
"city",
"country",
Expand All @@ -42,15 +41,15 @@ def obfuscate_sensitive_data(data: dict[str, Any]) -> JSON:
"addressLine2",
"longitude",
"latitude",
]:
}:
data[key] = obfuscate_string(value)

if value in [
if value in (
"core:NameState",
"homekit:SetupCode",
"homekit:SetupPayload",
"core:SSIDState",
]:
):
mask_next_value = True

if mask_next_value and key == "value":
Expand All @@ -62,17 +61,7 @@ def obfuscate_sensitive_data(data: dict[str, Any]) -> JSON:
obfuscate_sensitive_data(value)
elif isinstance(value, list):
for val in value:
if isinstance(val, str):
continue
if isinstance(val, int):
continue
if isinstance(val, float):
continue
if isinstance(val, list):
continue
if val is None:
continue

obfuscate_sensitive_data(val)
if isinstance(val, dict):
obfuscate_sensitive_data(val)

return data