From d376371c2578a754e7fa8ba20e20e05f26edd496 Mon Sep 17 00:00:00 2001 From: epenet <6771947+epenet@users.noreply.github.com> Date: Tue, 11 Jun 2024 14:59:49 +0200 Subject: [PATCH] Fix pylint warnings in testing config custom components (#119370) --- .../custom_components/test/image_processing.py | 12 +++++++++--- .../testing_config/custom_components/test/light.py | 13 ++++++++++--- tests/testing_config/custom_components/test/lock.py | 11 +++++++++-- .../testing_config/custom_components/test/remote.py | 11 +++++++++-- .../testing_config/custom_components/test/switch.py | 11 +++++++++-- .../custom_components/test/weather.py | 1 + .../custom_components/test_embedded/__init__.py | 5 ++++- .../custom_components/test_embedded/switch.py | 11 +++++++++-- .../test_integration_platform/__init__.py | 5 ++++- .../custom_components/test_package/__init__.py | 5 ++++- .../test_package_loaded_executor/__init__.py | 5 ++++- .../test_package_loaded_loop/__init__.py | 5 ++++- .../test_package_raises_cancelled_error/__init__.py | 5 ++++- .../__init__.py | 8 ++++++-- .../custom_components/test_standalone.py | 5 ++++- 15 files changed, 90 insertions(+), 23 deletions(-) diff --git a/tests/testing_config/custom_components/test/image_processing.py b/tests/testing_config/custom_components/test/image_processing.py index 343c60a78fe..fe22325c3e0 100644 --- a/tests/testing_config/custom_components/test/image_processing.py +++ b/tests/testing_config/custom_components/test/image_processing.py @@ -1,11 +1,17 @@ """Provide a mock image processing.""" from homeassistant.components.image_processing import ImageProcessingEntity +from homeassistant.core import HomeAssistant +from homeassistant.helpers.entity_platform import AddEntitiesCallback +from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType async def async_setup_platform( - hass, config, async_add_entities_callback, discovery_info=None -): + hass: HomeAssistant, + config: ConfigType, + async_add_entities_callback: AddEntitiesCallback, + discovery_info: DiscoveryInfoType | None = None, +) -> None: """Set up the test image_processing platform.""" async_add_entities_callback([TestImageProcessing("camera.demo_camera", "Test")]) @@ -13,7 +19,7 @@ async def async_setup_platform( class TestImageProcessing(ImageProcessingEntity): """Test image processing entity.""" - def __init__(self, camera_entity, name): + def __init__(self, camera_entity, name) -> None: """Initialize test image processing.""" self._name = name self._camera = camera_entity diff --git a/tests/testing_config/custom_components/test/light.py b/tests/testing_config/custom_components/test/light.py index 4cd49fec606..6422bb4fccb 100644 --- a/tests/testing_config/custom_components/test/light.py +++ b/tests/testing_config/custom_components/test/light.py @@ -5,6 +5,9 @@ Call init before using it in your tests to ensure clean test data. from homeassistant.components.light import ColorMode, LightEntity from homeassistant.const import STATE_OFF, STATE_ON +from homeassistant.core import HomeAssistant +from homeassistant.helpers.entity_platform import AddEntitiesCallback +from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType from tests.common import MockToggleEntity @@ -13,6 +16,7 @@ ENTITIES = [] def init(empty=False): """Initialize the platform with entities.""" + # pylint: disable-next=global-statement global ENTITIES # noqa: PLW0603 ENTITIES = ( @@ -27,8 +31,11 @@ def init(empty=False): async def async_setup_platform( - hass, config, async_add_entities_callback, discovery_info=None -): + hass: HomeAssistant, + config: ConfigType, + async_add_entities_callback: AddEntitiesCallback, + discovery_info: DiscoveryInfoType | None = None, +) -> None: """Return mock entities.""" async_add_entities_callback(ENTITIES) @@ -64,7 +71,7 @@ class MockLight(MockToggleEntity, LightEntity): state, unique_id=None, supported_color_modes: set[ColorMode] | None = None, - ): + ) -> None: """Initialize the mock light.""" super().__init__(name, state, unique_id) if supported_color_modes is None: diff --git a/tests/testing_config/custom_components/test/lock.py b/tests/testing_config/custom_components/test/lock.py index e97d3f8de22..0c24e1b5b41 100644 --- a/tests/testing_config/custom_components/test/lock.py +++ b/tests/testing_config/custom_components/test/lock.py @@ -4,6 +4,9 @@ Call init before using it in your tests to ensure clean test data. """ from homeassistant.components.lock import LockEntity, LockEntityFeature +from homeassistant.core import HomeAssistant +from homeassistant.helpers.entity_platform import AddEntitiesCallback +from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType from tests.common import MockEntity @@ -12,6 +15,7 @@ ENTITIES = {} def init(empty=False): """Initialize the platform with entities.""" + # pylint: disable-next=global-statement global ENTITIES # noqa: PLW0603 ENTITIES = ( @@ -35,8 +39,11 @@ def init(empty=False): async def async_setup_platform( - hass, config, async_add_entities_callback, discovery_info=None -): + hass: HomeAssistant, + config: ConfigType, + async_add_entities_callback: AddEntitiesCallback, + discovery_info: DiscoveryInfoType | None = None, +) -> None: """Return mock entities.""" async_add_entities_callback(list(ENTITIES.values())) diff --git a/tests/testing_config/custom_components/test/remote.py b/tests/testing_config/custom_components/test/remote.py index 3226c93310c..6d3f2ec955d 100644 --- a/tests/testing_config/custom_components/test/remote.py +++ b/tests/testing_config/custom_components/test/remote.py @@ -5,6 +5,9 @@ Call init before using it in your tests to ensure clean test data. from homeassistant.components.remote import RemoteEntity from homeassistant.const import STATE_OFF, STATE_ON +from homeassistant.core import HomeAssistant +from homeassistant.helpers.entity_platform import AddEntitiesCallback +from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType from tests.common import MockToggleEntity @@ -13,6 +16,7 @@ ENTITIES = [] def init(empty=False): """Initialize the platform with entities.""" + # pylint: disable-next=global-statement global ENTITIES # noqa: PLW0603 ENTITIES = ( @@ -27,8 +31,11 @@ def init(empty=False): async def async_setup_platform( - hass, config, async_add_entities_callback, discovery_info=None -): + hass: HomeAssistant, + config: ConfigType, + async_add_entities_callback: AddEntitiesCallback, + discovery_info: DiscoveryInfoType | None = None, +) -> None: """Return mock entities.""" async_add_entities_callback(ENTITIES) diff --git a/tests/testing_config/custom_components/test/switch.py b/tests/testing_config/custom_components/test/switch.py index b06db33746f..9099040e2b6 100644 --- a/tests/testing_config/custom_components/test/switch.py +++ b/tests/testing_config/custom_components/test/switch.py @@ -1,8 +1,15 @@ """Stub switch platform for translation tests.""" +from homeassistant.core import HomeAssistant +from homeassistant.helpers.entity_platform import AddEntitiesCallback +from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType + async def async_setup_platform( - hass, config, async_add_entities_callback, discovery_info=None -): + hass: HomeAssistant, + config: ConfigType, + async_add_entities_callback: AddEntitiesCallback, + discovery_info: DiscoveryInfoType | None = None, +) -> None: """Stub setup for translation tests.""" async_add_entities_callback([]) diff --git a/tests/testing_config/custom_components/test/weather.py b/tests/testing_config/custom_components/test/weather.py index b051531b9e8..cef0584e4e0 100644 --- a/tests/testing_config/custom_components/test/weather.py +++ b/tests/testing_config/custom_components/test/weather.py @@ -33,6 +33,7 @@ ENTITIES = [] def init(empty=False): """Initialize the platform with entities.""" + # pylint: disable-next=global-statement global ENTITIES # noqa: PLW0603 ENTITIES = [] if empty else [MockWeather()] diff --git a/tests/testing_config/custom_components/test_embedded/__init__.py b/tests/testing_config/custom_components/test_embedded/__init__.py index b83493817fd..b3fe1be4d74 100644 --- a/tests/testing_config/custom_components/test_embedded/__init__.py +++ b/tests/testing_config/custom_components/test_embedded/__init__.py @@ -1,8 +1,11 @@ """Component with embedded platforms.""" +from homeassistant.core import HomeAssistant +from homeassistant.helpers.typing import ConfigType + DOMAIN = "test_embedded" -async def async_setup(hass, config): +async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Mock config.""" return True diff --git a/tests/testing_config/custom_components/test_embedded/switch.py b/tests/testing_config/custom_components/test_embedded/switch.py index 46dac4419a6..f287f5ee547 100644 --- a/tests/testing_config/custom_components/test_embedded/switch.py +++ b/tests/testing_config/custom_components/test_embedded/switch.py @@ -1,7 +1,14 @@ """Switch platform for the embedded component.""" +from homeassistant.core import HomeAssistant +from homeassistant.helpers.entity_platform import AddEntitiesCallback +from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType + async def async_setup_platform( - hass, config, async_add_entities_callback, discovery_info=None -): + hass: HomeAssistant, + config: ConfigType, + async_add_entities_callback: AddEntitiesCallback, + discovery_info: DiscoveryInfoType | None = None, +) -> None: """Find and return test switches.""" diff --git a/tests/testing_config/custom_components/test_integration_platform/__init__.py b/tests/testing_config/custom_components/test_integration_platform/__init__.py index 220beb05367..8c3929398a1 100644 --- a/tests/testing_config/custom_components/test_integration_platform/__init__.py +++ b/tests/testing_config/custom_components/test_integration_platform/__init__.py @@ -1,10 +1,13 @@ """Provide a mock package component.""" +from homeassistant.core import HomeAssistant +from homeassistant.helpers.typing import ConfigType + from .const import TEST # noqa: F401 DOMAIN = "test_integration_platform" -async def async_setup(hass, config): +async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Mock a successful setup.""" return True diff --git a/tests/testing_config/custom_components/test_package/__init__.py b/tests/testing_config/custom_components/test_package/__init__.py index 50e132e2c07..33b04428ba4 100644 --- a/tests/testing_config/custom_components/test_package/__init__.py +++ b/tests/testing_config/custom_components/test_package/__init__.py @@ -1,10 +1,13 @@ """Provide a mock package component.""" +from homeassistant.core import HomeAssistant +from homeassistant.helpers.typing import ConfigType + from .const import TEST # noqa: F401 DOMAIN = "test_package" -async def async_setup(hass, config): +async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Mock a successful setup.""" return True diff --git a/tests/testing_config/custom_components/test_package_loaded_executor/__init__.py b/tests/testing_config/custom_components/test_package_loaded_executor/__init__.py index 50e132e2c07..33b04428ba4 100644 --- a/tests/testing_config/custom_components/test_package_loaded_executor/__init__.py +++ b/tests/testing_config/custom_components/test_package_loaded_executor/__init__.py @@ -1,10 +1,13 @@ """Provide a mock package component.""" +from homeassistant.core import HomeAssistant +from homeassistant.helpers.typing import ConfigType + from .const import TEST # noqa: F401 DOMAIN = "test_package" -async def async_setup(hass, config): +async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Mock a successful setup.""" return True diff --git a/tests/testing_config/custom_components/test_package_loaded_loop/__init__.py b/tests/testing_config/custom_components/test_package_loaded_loop/__init__.py index b9080a2048a..28eb409ba2b 100644 --- a/tests/testing_config/custom_components/test_package_loaded_loop/__init__.py +++ b/tests/testing_config/custom_components/test_package_loaded_loop/__init__.py @@ -1,8 +1,11 @@ """Provide a mock package component.""" +from homeassistant.core import HomeAssistant +from homeassistant.helpers.typing import ConfigType + from .const import TEST # noqa: F401 -async def async_setup(hass, config): +async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Mock a successful setup.""" return True diff --git a/tests/testing_config/custom_components/test_package_raises_cancelled_error/__init__.py b/tests/testing_config/custom_components/test_package_raises_cancelled_error/__init__.py index 37d3becb2d3..2bdf421c9b0 100644 --- a/tests/testing_config/custom_components/test_package_raises_cancelled_error/__init__.py +++ b/tests/testing_config/custom_components/test_package_raises_cancelled_error/__init__.py @@ -2,8 +2,11 @@ import asyncio +from homeassistant.core import HomeAssistant +from homeassistant.helpers.typing import ConfigType -async def async_setup(hass, config): + +async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Mock a successful setup.""" asyncio.current_task().cancel() await asyncio.sleep(0) diff --git a/tests/testing_config/custom_components/test_package_raises_cancelled_error_config_entry/__init__.py b/tests/testing_config/custom_components/test_package_raises_cancelled_error_config_entry/__init__.py index 55ce19865c6..caceba1d1da 100644 --- a/tests/testing_config/custom_components/test_package_raises_cancelled_error_config_entry/__init__.py +++ b/tests/testing_config/custom_components/test_package_raises_cancelled_error_config_entry/__init__.py @@ -2,13 +2,17 @@ import asyncio +from homeassistant.config_entries import ConfigEntry +from homeassistant.core import HomeAssistant +from homeassistant.helpers.typing import ConfigType -async def async_setup(hass, config): + +async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Mock a successful setup.""" return True -async def async_setup_entry(hass, entry): +async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> None: """Mock an unsuccessful entry setup.""" asyncio.current_task().cancel() await asyncio.sleep(0) diff --git a/tests/testing_config/custom_components/test_standalone.py b/tests/testing_config/custom_components/test_standalone.py index 0b7ce8033e5..7d4c713d3c2 100644 --- a/tests/testing_config/custom_components/test_standalone.py +++ b/tests/testing_config/custom_components/test_standalone.py @@ -1,8 +1,11 @@ """Provide a mock standalone component.""" +from homeassistant.core import HomeAssistant +from homeassistant.helpers.typing import ConfigType + DOMAIN = "test_standalone" -async def async_setup(hass, config): +async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool: """Mock a successful setup.""" return True -- GitLab