Skip to content

Enable ruff PTH rule (migrate to pathlib) #2004

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

Merged
iMicknl merged 1 commit into from
Apr 19, 2026
Merged

Enable ruff PTH rule (migrate to pathlib) #2004

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ select = [
"ERA",
# flake8-pyi
"PYI",
# flake8-pathlib
"PTH",
]
ignore = [
"E501", # Line too long
Expand Down
45 changes: 16 additions & 29 deletions tests/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
"""Unit tests for the high-level OverkizClient behaviour and responses."""

# ruff: noqa: ASYNC230, S106
# ruff: noqa: S106
# S106: Test credentials use dummy values.
# ASYNC230: Blocking open() is acceptable for reading test fixtures

from __future__ import annotations

import json
import os
from pathlib import Path
from unittest.mock import AsyncMock, patch

import aiohttp
Expand All @@ -25,7 +24,7 @@
from pyoverkiz.response_handler import check_response
from pyoverkiz.utils import create_local_server_config

CURRENT_DIR = os.path.dirname(os.path.abspath(__file__))
CURRENT_DIR = Path(__file__).resolve().parent


class TestOverkizClient:
Expand Down Expand Up @@ -60,9 +59,7 @@ async def test_get_api_type_local(self, local_client: OverkizClient):
@pytest.mark.asyncio
async def test_get_devices_basic(self, client: OverkizClient):
"""Ensure the client can fetch and parse the basic devices fixture."""
with open(
os.path.join(CURRENT_DIR, "devices.json"), encoding="utf-8"
) as raw_devices:
with (CURRENT_DIR / "devices.json").open(encoding="utf-8") as raw_devices:
resp = MockResponse(raw_devices.read())

with patch.object(aiohttp.ClientSession, "get", return_value=resp):
Expand All @@ -81,8 +78,7 @@ async def test_fetch_events_basic(
self, client: OverkizClient, fixture_name: str, event_length: int
):
"""Parameterised test that fetches events fixture and checks the expected count."""
with open(
os.path.join(CURRENT_DIR, "fixtures/event/" + fixture_name),
with (CURRENT_DIR / "fixtures" / "event" / fixture_name).open(
encoding="utf-8",
) as raw_events:
resp = MockResponse(raw_events.read())
Expand All @@ -94,8 +90,8 @@ async def test_fetch_events_basic(
@pytest.mark.asyncio
async def test_fetch_events_simple_cast(self, client: OverkizClient):
"""Check that event state values from the cloud (strings) are cast to appropriate types."""
with open(
os.path.join(CURRENT_DIR, "fixtures/event/events.json"), encoding="utf-8"
with (CURRENT_DIR / "fixtures" / "event" / "events.json").open(
encoding="utf-8",
) as raw_events:
resp = MockResponse(raw_events.read())

Expand Down Expand Up @@ -195,8 +191,7 @@ async def test_backoff_retries_on_concurrent_requests(
@pytest.mark.asyncio
async def test_fetch_events_casting(self, client: OverkizClient, fixture_name: str):
"""Validate that fetched event states are cast to the expected Python types for each data type."""
with open(
os.path.join(CURRENT_DIR, "fixtures/event/" + fixture_name),
with (CURRENT_DIR / "fixtures" / "event" / fixture_name).open(
encoding="utf-8",
) as raw_events:
resp = MockResponse(raw_events.read())
Expand Down Expand Up @@ -264,8 +259,7 @@ async def test_get_setup(
gateway_count: int,
):
"""Ensure setup parsing yields expected device and gateway counts and device metadata."""
with open(
os.path.join(CURRENT_DIR, "fixtures/setup/" + fixture_name),
with (CURRENT_DIR / "fixtures" / "setup" / fixture_name).open(
encoding="utf-8",
) as setup_mock:
resp = MockResponse(setup_mock.read())
Expand Down Expand Up @@ -316,8 +310,7 @@ async def test_get_setup(
@pytest.mark.asyncio
async def test_get_diagnostic_data(self, client: OverkizClient, fixture_name: str):
"""Verify that diagnostic data can be fetched and is not empty."""
with open(
os.path.join(CURRENT_DIR, "fixtures/setup/" + fixture_name),
with (CURRENT_DIR / "fixtures" / "setup" / fixture_name).open(
encoding="utf-8",
) as setup_mock:
resp = MockResponse(setup_mock.read())
Expand All @@ -329,8 +322,7 @@ async def test_get_diagnostic_data(self, client: OverkizClient, fixture_name: st
@pytest.mark.asyncio
async def test_get_diagnostic_data_redacted_by_default(self, client: OverkizClient):
"""Ensure diagnostics are redacted when no argument is provided."""
with open(
os.path.join(CURRENT_DIR, "fixtures/setup/setup_tahoma_1.json"),
with (CURRENT_DIR / "fixtures" / "setup" / "setup_tahoma_1.json").open(
encoding="utf-8",
) as setup_mock:
resp = MockResponse(setup_mock.read())
Expand All @@ -349,8 +341,7 @@ async def test_get_diagnostic_data_redacted_by_default(self, client: OverkizClie
@pytest.mark.asyncio
async def test_get_diagnostic_data_without_masking(self, client: OverkizClient):
"""Ensure diagnostics can be returned without masking when requested."""
with open(
os.path.join(CURRENT_DIR, "fixtures/setup/setup_tahoma_1.json"),
with (CURRENT_DIR / "fixtures" / "setup" / "setup_tahoma_1.json").open(
encoding="utf-8",
) as setup_mock:
raw_setup = setup_mock.read()
Expand Down Expand Up @@ -546,8 +537,7 @@ async def test_check_response_exception_handling(
):
"""Ensure client raises the correct error for various error fixtures/status codes."""
if fixture_name:
with open(
os.path.join(CURRENT_DIR, "fixtures/exceptions/" + fixture_name),
with (CURRENT_DIR / "fixtures" / "exceptions" / fixture_name).open(
encoding="utf-8",
) as raw_events:
resp = MockResponse(raw_events.read(), status_code)
Expand All @@ -563,8 +553,7 @@ async def test_get_setup_options(
client: OverkizClient,
):
"""Check that setup options are parsed and return the expected number of Option instances."""
with open(
os.path.join(CURRENT_DIR, "fixtures/endpoints/setup-options.json"),
with (CURRENT_DIR / "fixtures" / "endpoints" / "setup-options.json").open(
encoding="utf-8",
) as raw_events:
resp = MockResponse(raw_events.read())
Expand Down Expand Up @@ -665,8 +654,7 @@ async def test_get_setup_option(
instance: Option | None,
):
"""Verify retrieval of a single setup option by name, including non-existent options."""
with open(
os.path.join(CURRENT_DIR, "fixtures/endpoints/" + fixture_name),
with (CURRENT_DIR / "fixtures" / "endpoints" / fixture_name).open(
encoding="utf-8",
) as raw_events:
resp = MockResponse(raw_events.read())
Expand Down Expand Up @@ -696,8 +684,7 @@ async def test_get_action_groups(
scenario_count: int,
):
"""Ensure action groups (scenarios) are parsed correctly and contain actions and commands."""
with open(
os.path.join(CURRENT_DIR, "fixtures/action_groups/" + fixture_name),
with (CURRENT_DIR / "fixtures" / "action_groups" / fixture_name).open(
encoding="utf-8",
) as action_group_mock:
resp = MockResponse(action_group_mock.read())
Expand Down
13 changes: 6 additions & 7 deletions utils/mask_fixtures.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,23 @@

from __future__ import annotations

import glob
import json
import os
from pathlib import Path

from pyoverkiz.obfuscate import obfuscate_sensitive_data

# only process .JSON files in folder.
for filename in glob.glob(os.path.join("tests/fixtures/setup", "*.json")):
with open(filename, encoding="utf-8") as input_file:
print(f"Masking {filename}")
for filepath in Path("tests/fixtures/setup").glob("*.json"):
with filepath.open(encoding="utf-8") as input_file:
print(f"Masking {filepath}")

try:
file = json.loads(input_file.read())
output = obfuscate_sensitive_data(file)
except Exception as exception: # pylint: disable=broad-except
print(f"Error while masking: {filename}")
print(f"Error while masking: {filepath}")
print(exception)
continue

with open(filename, encoding="utf-8", mode="w") as output_file:
with filepath.open(encoding="utf-8", mode="w") as output_file:
json.dump(output, output_file, ensure_ascii=False, indent=4)
Loading