From a12cf7211da9eb9e47403a09f2147f6ee5e32f32 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ville=20Skytt=C3=A4?= Date: Wed, 11 Dec 2019 00:25:06 +0200 Subject: [PATCH] Upgrade pydocstyle to 5.0.1 (#29830) * Upgrade pydocstyle to 5.0.1 http://www.pydocstyle.org/en/5.0.1/release_notes.html * Pydocstyle and other docstring fixes --- .pre-commit-config-all.yaml | 2 +- .pre-commit-config.yaml | 2 +- .../components/bmw_connected_drive/__init__.py | 2 +- .../bmw_connected_drive/binary_sensor.py | 2 +- .../components/bmw_connected_drive/sensor.py | 2 +- homeassistant/components/dlna_dmr/media_player.py | 2 +- homeassistant/components/emulated_hue/__init__.py | 2 +- homeassistant/components/homeworks/__init__.py | 2 +- homeassistant/components/keba/__init__.py | 2 +- homeassistant/components/nissan_leaf/sensor.py | 2 +- homeassistant/components/starline/account.py | 2 +- homeassistant/components/starline/binary_sensor.py | 2 +- homeassistant/components/starline/entity.py | 2 +- homeassistant/components/starline/sensor.py | 2 +- homeassistant/components/tplink/common.py | 2 +- homeassistant/components/upnp/device.py | 4 ++-- homeassistant/components/upnp/sensor.py | 2 +- homeassistant/components/withings/common.py | 4 ++-- homeassistant/components/withings/sensor.py | 4 ++-- homeassistant/components/wunderground/sensor.py | 14 +++++++------- requirements_test_pre_commit.txt | 2 +- tests/components/mqtt/test_light_json.py | 2 +- tests/components/upnp/test_init.py | 2 +- tests/components/vera/common.py | 2 +- 24 files changed, 33 insertions(+), 33 deletions(-) diff --git a/.pre-commit-config-all.yaml b/.pre-commit-config-all.yaml index f7b29cddc4f..cb01bff85cb 100644 --- a/.pre-commit-config-all.yaml +++ b/.pre-commit-config-all.yaml @@ -24,7 +24,7 @@ repos: - id: flake8 additional_dependencies: - flake8-docstrings==1.5.0 - - pydocstyle==4.0.1 + - pydocstyle==5.0.1 files: ^(homeassistant|script|tests)/.+\.py$ - repo: https://github.com/PyCQA/bandit rev: 1.6.2 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 216bac95f29..e6f37ae6355 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -20,7 +20,7 @@ repos: - id: flake8 additional_dependencies: - flake8-docstrings==1.5.0 - - pydocstyle==4.0.1 + - pydocstyle==5.0.1 files: ^(homeassistant|script|tests)/.+\.py$ - repo: https://github.com/PyCQA/bandit rev: 1.6.2 diff --git a/homeassistant/components/bmw_connected_drive/__init__.py b/homeassistant/components/bmw_connected_drive/__init__.py index 455d821e669..6e7723b16ec 100644 --- a/homeassistant/components/bmw_connected_drive/__init__.py +++ b/homeassistant/components/bmw_connected_drive/__init__.py @@ -119,7 +119,7 @@ class BMWConnectedDriveAccount: def __init__( self, username: str, password: str, region_str: str, name: str, read_only ) -> None: - """Constructor.""" + """Initialize account.""" region = get_region_from_name(region_str) diff --git a/homeassistant/components/bmw_connected_drive/binary_sensor.py b/homeassistant/components/bmw_connected_drive/binary_sensor.py index 8163ae4eae3..d0cb4289d37 100644 --- a/homeassistant/components/bmw_connected_drive/binary_sensor.py +++ b/homeassistant/components/bmw_connected_drive/binary_sensor.py @@ -59,7 +59,7 @@ class BMWConnectedDriveSensor(BinarySensorDevice): def __init__( self, account, vehicle, attribute: str, sensor_name, device_class, icon ): - """Constructor.""" + """Initialize sensor.""" self._account = account self._vehicle = vehicle self._attribute = attribute diff --git a/homeassistant/components/bmw_connected_drive/sensor.py b/homeassistant/components/bmw_connected_drive/sensor.py index f919bba6b95..3c40900bed8 100644 --- a/homeassistant/components/bmw_connected_drive/sensor.py +++ b/homeassistant/components/bmw_connected_drive/sensor.py @@ -69,7 +69,7 @@ class BMWConnectedDriveSensor(Entity): """Representation of a BMW vehicle sensor.""" def __init__(self, account, vehicle, attribute: str, attribute_info): - """Constructor.""" + """Initialize BMW vehicle sensor.""" self._vehicle = vehicle self._account = account self._attribute = attribute diff --git a/homeassistant/components/dlna_dmr/media_player.py b/homeassistant/components/dlna_dmr/media_player.py index a9ea9b21d59..a6ebf95424a 100644 --- a/homeassistant/components/dlna_dmr/media_player.py +++ b/homeassistant/components/dlna_dmr/media_player.py @@ -198,7 +198,7 @@ class DlnaDmrDevice(MediaPlayerDevice): """Representation of a DLNA DMR device.""" def __init__(self, dmr_device, name=None): - """Initializer.""" + """Initialize DLNA DMR device.""" self._device = dmr_device self._name = name diff --git a/homeassistant/components/emulated_hue/__init__.py b/homeassistant/components/emulated_hue/__init__.py index c40a22df451..0a358c6e894 100644 --- a/homeassistant/components/emulated_hue/__init__.py +++ b/homeassistant/components/emulated_hue/__init__.py @@ -312,7 +312,7 @@ class Config: def _load_json(filename): - """Wrapper, because we actually want to handle invalid json.""" + """Load JSON, handling invalid syntax.""" try: return load_json(filename) except HomeAssistantError: diff --git a/homeassistant/components/homeworks/__init__.py b/homeassistant/components/homeworks/__init__.py index 55357acdad4..c6296d8f4c6 100644 --- a/homeassistant/components/homeworks/__init__.py +++ b/homeassistant/components/homeworks/__init__.py @@ -98,7 +98,7 @@ class HomeworksDevice: """Base class of a Homeworks device.""" def __init__(self, controller, addr, name): - """Controller, address, and name of the device.""" + """Initialize Homeworks device.""" self._addr = addr self._name = name self._controller = controller diff --git a/homeassistant/components/keba/__init__.py b/homeassistant/components/keba/__init__.py index 5a9a49a005a..830ebe7ffab 100644 --- a/homeassistant/components/keba/__init__.py +++ b/homeassistant/components/keba/__init__.py @@ -106,7 +106,7 @@ class KebaHandler(KebaKeContact): """Representation of a KEBA charging station connection.""" def __init__(self, hass, host, rfid, refresh_interval): - """Constructor.""" + """Initialize charging station connection.""" super().__init__(host, self.hass_callback) self._update_listeners = [] diff --git a/homeassistant/components/nissan_leaf/sensor.py b/homeassistant/components/nissan_leaf/sensor.py index cd82735d207..6e5d119c7a3 100644 --- a/homeassistant/components/nissan_leaf/sensor.py +++ b/homeassistant/components/nissan_leaf/sensor.py @@ -69,7 +69,7 @@ class LeafRangeSensor(LeafEntity): """Nissan Leaf Range Sensor.""" def __init__(self, car, ac_on): - """Set-up range sensor. Store if AC on.""" + """Set up range sensor. Store if AC on.""" self._ac_on = ac_on super().__init__(car) diff --git a/homeassistant/components/starline/account.py b/homeassistant/components/starline/account.py index aee88c0bd3f..8d0214d1b5c 100644 --- a/homeassistant/components/starline/account.py +++ b/homeassistant/components/starline/account.py @@ -23,7 +23,7 @@ class StarlineAccount: """StarLine Account class.""" def __init__(self, hass: HomeAssistant, config_entry: ConfigEntry): - """Constructor.""" + """Initialize StarLine account.""" self._hass: HomeAssistant = hass self._config_entry: ConfigEntry = config_entry self._update_interval: int = DEFAULT_SCAN_INTERVAL diff --git a/homeassistant/components/starline/binary_sensor.py b/homeassistant/components/starline/binary_sensor.py index 21074069135..f2288e9363b 100644 --- a/homeassistant/components/starline/binary_sensor.py +++ b/homeassistant/components/starline/binary_sensor.py @@ -44,7 +44,7 @@ class StarlineSensor(StarlineEntity, BinarySensorDevice): name: str, device_class: str, ): - """Constructor.""" + """Initialize sensor.""" super().__init__(account, device, key, name) self._device_class = device_class diff --git a/homeassistant/components/starline/entity.py b/homeassistant/components/starline/entity.py index 31d1c79b9f0..5db4d369f5e 100644 --- a/homeassistant/components/starline/entity.py +++ b/homeassistant/components/starline/entity.py @@ -12,7 +12,7 @@ class StarlineEntity(Entity): def __init__( self, account: StarlineAccount, device: StarlineDevice, key: str, name: str ): - """Constructor.""" + """Initialize StarLine entity.""" self._account = account self._device = device self._key = key diff --git a/homeassistant/components/starline/sensor.py b/homeassistant/components/starline/sensor.py index 874fc5a9a7e..0c6cd8de683 100644 --- a/homeassistant/components/starline/sensor.py +++ b/homeassistant/components/starline/sensor.py @@ -42,7 +42,7 @@ class StarlineSensor(StarlineEntity, Entity): unit: str, icon: str, ): - """Constructor.""" + """Initialize StarLine sensor.""" super().__init__(account, device, key, name) self._device_class = device_class self._unit = unit diff --git a/homeassistant/components/tplink/common.py b/homeassistant/components/tplink/common.py index 548edc6822c..0e06babbd52 100644 --- a/homeassistant/components/tplink/common.py +++ b/homeassistant/components/tplink/common.py @@ -32,7 +32,7 @@ class SmartDevices: def __init__( self, lights: List[SmartDevice] = None, switches: List[SmartDevice] = None ): - """Constructor.""" + """Initialize device holder.""" self._lights = lights or [] self._switches = switches or [] diff --git a/homeassistant/components/upnp/device.py b/homeassistant/components/upnp/device.py index fffee57b411..1f34e63bcdf 100644 --- a/homeassistant/components/upnp/device.py +++ b/homeassistant/components/upnp/device.py @@ -17,13 +17,13 @@ class Device: """Hass representation of an UPnP/IGD.""" def __init__(self, igd_device): - """Initializer.""" + """Initialize UPnP/IGD device.""" self._igd_device = igd_device self._mapped_ports = [] @classmethod async def async_discover(cls, hass: HomeAssistantType): - """Discovery UPNP/IGD devices.""" + """Discover UPnP/IGD devices.""" _LOGGER.debug("Discovering UPnP/IGD devices") local_ip = None if DOMAIN in hass.data and "config" in hass.data[DOMAIN]: diff --git a/homeassistant/components/upnp/sensor.py b/homeassistant/components/upnp/sensor.py index 7b5071aabd3..06e4a86401f 100644 --- a/homeassistant/components/upnp/sensor.py +++ b/homeassistant/components/upnp/sensor.py @@ -154,7 +154,7 @@ class PerSecondUPnPIGDSensor(UpnpSensor): """Abstract representation of a X Sent/Received per second sensor.""" def __init__(self, device, direction): - """Initializer.""" + """Initialize sensor.""" super().__init__(device) self._direction = direction diff --git a/homeassistant/components/withings/common.py b/homeassistant/components/withings/common.py index 5ec15eeac54..4c3772d77e7 100644 --- a/homeassistant/components/withings/common.py +++ b/homeassistant/components/withings/common.py @@ -51,7 +51,7 @@ class ThrottleData: """Throttle data.""" def __init__(self, interval: int, data: Any): - """Constructor.""" + """Initialize throttle data.""" self._time = int(time.time()) self._interval = interval self._data = data @@ -126,7 +126,7 @@ class WithingsDataManager: service_available = None def __init__(self, hass: HomeAssistant, profile: str, api: ConfigEntryWithingsApi): - """Constructor.""" + """Initialize data manager.""" self._hass = hass self._api = api self._profile = profile diff --git a/homeassistant/components/withings/sensor.py b/homeassistant/components/withings/sensor.py index 9b5ceab64bf..aae706dec61 100644 --- a/homeassistant/components/withings/sensor.py +++ b/homeassistant/components/withings/sensor.py @@ -55,7 +55,7 @@ class WithingsAttribute: unit_of_measurement: str, icon: str, ) -> None: - """Constructor.""" + """Initialize attribute.""" self.measurement = measurement self.measure_type = measure_type self.friendly_name = friendly_name @@ -73,7 +73,7 @@ class WithingsSleepStateAttribute(WithingsAttribute): def __init__( self, measurement: str, friendly_name: str, unit_of_measurement: str, icon: str ) -> None: - """Constructor.""" + """Initialize sleep state attribute.""" super().__init__(measurement, None, friendly_name, unit_of_measurement, icon) diff --git a/homeassistant/components/wunderground/sensor.py b/homeassistant/components/wunderground/sensor.py index 84c870af54d..cc71e71a1d0 100644 --- a/homeassistant/components/wunderground/sensor.py +++ b/homeassistant/components/wunderground/sensor.py @@ -66,7 +66,7 @@ class WUSensorConfig: device_state_attributes=None, device_class=None, ): - """Constructor. + """Initialize sensor configuration. :param friendly_name: Friendly name :param feature: WU feature. See: @@ -98,7 +98,7 @@ class WUCurrentConditionsSensorConfig(WUSensorConfig): unit_of_measurement: Optional[str] = None, device_class=None, ): - """Constructor. + """Initialize current conditions sensor configuration. :param friendly_name: Friendly name of sensor :field: Field name in the "current_observation" dictionary. @@ -127,7 +127,7 @@ class WUDailyTextForecastSensorConfig(WUSensorConfig): def __init__( self, period: int, field: str, unit_of_measurement: Optional[str] = None ): - """Constructor. + """Initialize daily text forecast sensor configuration. :param period: forecast period number :param field: field name to use as value @@ -164,7 +164,7 @@ class WUDailySimpleForecastSensorConfig(WUSensorConfig): icon=None, device_class=None, ): - """Constructor. + """Initialize daily simple forecast sensor configuration. :param friendly_name: friendly_name of the sensor :param period: forecast period number @@ -207,7 +207,7 @@ class WUHourlyForecastSensorConfig(WUSensorConfig): """Helper for defining sensor configurations for hourly text forecasts.""" def __init__(self, period: int, field: int): - """Constructor. + """Initialize hourly forecast sensor configuration. :param period: forecast period number :param field: field name to use as value @@ -274,7 +274,7 @@ class WUAlmanacSensorConfig(WUSensorConfig): icon: str, device_class=None, ): - """Constructor. + """Initialize almanac sensor configuration. :param friendly_name: Friendly name :param field: value name returned in 'almanac' dict as returned by the WU API @@ -297,7 +297,7 @@ class WUAlertsSensorConfig(WUSensorConfig): """Helper for defining field configuration for alerts.""" def __init__(self, friendly_name: Union[str, Callable]): - """Constructor. + """Initialiize alerts sensor configuration. :param friendly_name: Friendly name """ diff --git a/requirements_test_pre_commit.txt b/requirements_test_pre_commit.txt index 3f4d05a4908..14b866c7034 100644 --- a/requirements_test_pre_commit.txt +++ b/requirements_test_pre_commit.txt @@ -4,4 +4,4 @@ bandit==1.6.2 black==19.10b0 flake8-docstrings==1.5.0 flake8==3.7.9 -pydocstyle==4.0.1 +pydocstyle==5.0.1 diff --git a/tests/components/mqtt/test_light_json.py b/tests/components/mqtt/test_light_json.py index f424b36ded6..52adeb61514 100644 --- a/tests/components/mqtt/test_light_json.py +++ b/tests/components/mqtt/test_light_json.py @@ -117,7 +117,7 @@ class JsonValidator(object): """Helper to compare JSON.""" def __init__(self, jsondata): - """Constructor.""" + """Initialize JSON validator.""" self.jsondata = jsondata def __eq__(self, other): diff --git a/tests/components/upnp/test_init.py b/tests/components/upnp/test_init.py index 1daa60bcb36..86ed017ae8d 100644 --- a/tests/components/upnp/test_init.py +++ b/tests/components/upnp/test_init.py @@ -15,7 +15,7 @@ class MockDevice(Device): """Mock device for Device.""" def __init__(self, udn): - """Initializer.""" + """Initialize mock device.""" device = MagicMock() device.manufacturer = "mock-manuf" device.name = "mock-name" diff --git a/tests/components/vera/common.py b/tests/components/vera/common.py index d78a536e95c..bd87e8bc9f2 100644 --- a/tests/components/vera/common.py +++ b/tests/components/vera/common.py @@ -16,7 +16,7 @@ class ComponentFactory: """Factory class.""" def __init__(self, init_controller_mock): - """Constructor.""" + """Initialize component factory.""" self.init_controller_mock = init_controller_mock async def configure_component(