Merge 33fbaa3 into 9c5a2ed

Author: hthiery

.github/workflows/test.yml

@@ -20,12 +20,15 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Install dependencies
-        run: pip install pytest pytest-cov python-coveralls coverage flake8
+        run: pip install pytest pytest-cov python-coveralls coverage flake8 pydocstyle
 
       - name: Lint with flake8
         run: |
           flake8 pyfritzhome --count --show-source --statistics
 
+      - name: Run pydocstyle for analysising with Python docstring conventions.
+        run: pydocstyle
+
       - name: Setup
         run: python setup.py install
 

pyfritzhome/__init__.py

@@ -1,3 +1,5 @@
+"""Init file for pyfritzhome."""
+
 from .errors import InvalidError, LoginError
 from .fritzhome import Fritzhome
 from .fritzhomedevice import FritzhomeDevice

pyfritzhome/cli.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python
+"""A simple CLI tool."""
 # -*- coding: utf-8 -*-
 
 from __future__ import print_function
@@ -165,7 +166,7 @@ def template_apply(fritz, args):
 
 
 def main(args=None):
-    """The main function."""
+    """Enter the main function of the CLI tool."""
     parser = argparse.ArgumentParser(description="Fritz!Box Smarthome CLI tool.")
     parser.add_argument(
         "-v", action="store_true", dest="verbose", help="be more verbose"

pyfritzhome/devicetypes/__init__.py

@@ -1,3 +1,5 @@
+"""Init file for the device types."""
+
 from .fritzhomedevicealarm import FritzhomeDeviceAlarm
 from .fritzhomedevicebutton import FritzhomeDeviceButton
 from .fritzhomedevicepowermeter import FritzhomeDevicePowermeter

pyfritzhome/devicetypes/fritzhomedevicealarm.py

@@ -1,3 +1,4 @@
+"""The alarm device class."""
 # -*- coding: utf-8 -*-
 
 import logging

pyfritzhome/devicetypes/fritzhomedevicebase.py

@@ -1,3 +1,4 @@
+"""The base device class."""
 # -*- coding: utf-8 -*-
 
 from __future__ import print_function

pyfritzhome/devicetypes/fritzhomedeviceblind.py

@@ -1,3 +1,4 @@
+"""The blind device class."""
 # -*- coding: utf-8 -*-
 
 import logging
@@ -53,22 +54,29 @@ def _update_blind_from_node(self, node):
             pass
 
     def get_level(self):
+        """Get the blind level."""
         return self.level
 
     def get_level_percentage(self):
+        """Get the blind level in percentage."""
         return self.levelpercentage
 
     def set_level(self, level):
+        """Set the blind level."""
         self._fritz.set_level(self.ain, level)
 
     def set_level_percentage(self, levelpercentage):
+        """Set the blind level in percentage."""
         self._fritz.set_level_percentage(self.ain, levelpercentage)
 
     def set_blind_open(self):
+        """Open the blind."""
         self._fritz.set_blind_open(self.ain)
 
     def set_blind_close(self):
+        """Close the blind."""
         self._fritz.set_blind_close(self.ain)
 
     def set_blind_stop(self):
+        """Stop the blind."""
         self._fritz.set_blind_stop(self.ain)

pyfritzhome/devicetypes/fritzhomedevicebutton.py

@@ -1,3 +1,4 @@
+"""The button device class."""
 # -*- coding: utf-8 -*-
 
 import logging
@@ -41,6 +42,7 @@ def _update_button_from_node(self, node):
             pass
 
     def get_button_by_ain(self, ain):
+        """Return the button by AIN."""
         return self.buttons[ain]
 
 
@@ -53,6 +55,7 @@ class FritzhomeButton(object):
     last_pressed = None
 
     def __init__(self, node=None):
+        """Create a button object."""
         if node is not None:
             self._update_from_node(node)
 
@@ -67,7 +70,9 @@ def _update_from_node(self, node):
             pass
 
     def get_node_value(self, elem, node):
+        """Get the node value."""
         return elem.findtext(node)
 
     def get_node_value_as_int(self, elem, node) -> int:
+        """Get the node value as integer."""
         return int(self.get_node_value(elem, node))

pyfritzhome/devicetypes/fritzhomedevicefeatures.py

@@ -1,7 +1,10 @@
+"""The feature list class."""
 from enum import IntFlag
 
 
 class FritzhomeDeviceFeatures(IntFlag):
+    """The feature list class."""
+
     ALARM = 0x0010
     UNKNOWN = 0x0020
     BUTTON = 0x0020

pyfritzhome/devicetypes/fritzhomedevicelightbulb.py

@@ -1,3 +1,4 @@
+"""The light bulb device class."""
 # -*- coding: utf-8 -*-
 
 import logging