Add black code formatter (theolind#235)

* Add config and tools for black

* Run black

Author: MartinHjelmare

.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+# See https://pre-commit.com/
+# See https://github.com/psf/black#version-control-integration
+repos:
+  - repo: https://github.com/psf/black
+    rev: stable
+    hooks:
+      - id: black
+        language_version: python3.6

Makefile

@@ -1,6 +1,8 @@
-.PHONY: help build clean clean-build clean-pyc coverage lint release test-release test test-all
+.PHONY: help black black-format build clean clean-build clean-pyc coverage lint release test-release test test-all
 
 help:
+	@echo "black - run black code formatter check"
+	@echo "black-format - run black code formatter format"
 	@echo "build - build a distribution"
 	@echo "clean - run all clean operations"
 	@echo "clean-build - remove build artifacts"
@@ -12,6 +14,12 @@ help:
 	@echo "test - run tests quickly with the default Python"
 	@echo "test-all - run tests on every Python version with tox"
 
+black:
+	black --check ./
+
+black-format:
+	black ./
+
 build:
 	python setup.py sdist bdist_wheel
 

README.md

@@ -228,6 +228,15 @@ Use the Makefile to run common development tasks.
 make
 ```
 
+### Code formatting
+
+We use black code formatter to automatically format the code.
+This requires Python 3.6 for development.
+
+```sh
+black ./
+```
+
 ### Release
 
 See the [release instructions](RELEASE.md).

async_main.py

@@ -10,7 +10,7 @@
 
 def event(message):
     """Handle mysensors updates."""
-    print('sensor_update ' + str(message.node_id))
+    print("sensor_update " + str(message.node_id))
 
 
 LOOP = asyncio.get_event_loop()
@@ -19,8 +19,8 @@ def event(message):
 try:
     # To create a serial gateway.
     GATEWAY = mysensors.AsyncSerialGateway(
-        '/dev/ttyACM0', loop=LOOP, event_callback=event,
-        protocol_version='2.1')
+        "/dev/ttyACM0", loop=LOOP, event_callback=event, protocol_version="2.1"
+    )
     LOOP.run_until_complete(GATEWAY.start())
     LOOP.run_forever()
 except KeyboardInterrupt:

main.py

@@ -13,7 +13,8 @@ def event(message):
 
 # To create a serial gateway.
 GATEWAY = mysensors.SerialGateway(
-    '/dev/ttyACM0', event_callback=event, protocol_version='2.0')
+    "/dev/ttyACM0", event_callback=event, protocol_version="2.0"
+)
 
 # To create a TCP gateway.
 # GATEWAY = mysensors.TCPGateway('127.0.0.1', event_callback=event)

mqtt.py

@@ -26,35 +26,40 @@ def subscribe(self, topic, callback, qos):
 
         def _message_callback(mqttc, userdata, msg):
             """Callback added to callback list for received message."""
-            callback(msg.topic, msg.payload.decode('utf-8'), msg.qos)
+            callback(msg.topic, msg.payload.decode("utf-8"), msg.qos)
 
         self._mqttc.subscribe(topic, qos)
         self._mqttc.message_callback_add(topic, _message_callback)
         self.topics[topic] = callback
 
     def start(self):
         """Run the MQTT client."""
-        print('Start MQTT client')
+        print("Start MQTT client")
         self._mqttc.loop_start()
 
     def stop(self):
         """Stop the MQTT client."""
-        print('Stop MQTT client')
+        print("Stop MQTT client")
         self._mqttc.disconnect()
         self._mqttc.loop_stop()
 
 
 def event(message):
     """Callback for mysensors updates."""
-    print('sensor_update ' + str(message.node_id))
+    print("sensor_update " + str(message.node_id))
 
 
-MQTTC = MQTT('localhost', 1883, 60)
+MQTTC = MQTT("localhost", 1883, 60)
 MQTTC.start()
 
 GATEWAY = mysensors.MQTTGateway(
-    MQTTC.publish, MQTTC.subscribe, in_prefix='mygateway1-out',
-    out_prefix='mygateway1-in', retain=True, event_callback=event,
-    protocol_version='2.0')
+    MQTTC.publish,
+    MQTTC.subscribe,
+    in_prefix="mygateway1-out",
+    out_prefix="mygateway1-in",
+    retain=True,
+    event_callback=event,
+    protocol_version="2.0",
+)
 
 GATEWAY.start()

mysensors/__init__.py

@@ -24,7 +24,7 @@ class Gateway:
 
     # pylint: disable=too-many-instance-attributes
 
-    def __init__(self, event_callback=None, protocol_version='1.4'):
+    def __init__(self, event_callback=None, protocol_version="1.4"):
         """Set up Gateway."""
         protocol_version = safe_is_version(protocol_version)
         self.const = get_const(protocol_version)
@@ -42,7 +42,7 @@ def __init__(self, event_callback=None, protocol_version='1.4'):
 
     def __repr__(self):
         """Return the representation."""
-        return '<{}>'.format(self.__class__.__name__)
+        return "<{}>".format(self.__class__.__name__)
 
     def logic(self, data):
         """Parse the data and respond to it appropriately.
@@ -53,13 +53,12 @@ def logic(self, data):
         try:
             msg = Message(data)
         except ValueError as exc:
-            _LOGGER.warning('Not a valid message: %s', exc)
+            _LOGGER.warning("Not a valid message: %s", exc)
             return None
         try:
             msg.validate(self.protocol_version)
         except vol.Invalid as exc:
-            _LOGGER.warning(
-                'Invalid %s: %s', msg, humanize_error(msg.__dict__, exc))
+            _LOGGER.warning("Invalid %s: %s", msg, humanize_error(msg.__dict__, exc))
             return None
 
         msg.gateway = self
@@ -102,35 +101,39 @@ def is_sensor(self, sensorid, child_id=None):
         """Return True if a sensor and its child exist."""
         ret = sensorid in self.sensors
         if not ret:
-            _LOGGER.warning('Node %s is unknown', sensorid)
+            _LOGGER.warning("Node %s is unknown", sensorid)
         if ret and child_id is not None:
             ret = child_id in self.sensors[sensorid].children
             if not ret:
-                _LOGGER.warning('Child %s is unknown', child_id)
-        if not ret and parse_ver(self.protocol_version) >= parse_ver('2.0'):
-            _LOGGER.info('Requesting new presentation for node %s',
-                         sensorid)
+                _LOGGER.warning("Child %s is unknown", child_id)
+        if not ret and parse_ver(self.protocol_version) >= parse_ver("2.0"):
+            _LOGGER.info("Requesting new presentation for node %s", sensorid)
             msg = Message(gateway=self).modify(
-                node_id=sensorid, child_id=SYSTEM_CHILD_ID,
+                node_id=sensorid,
+                child_id=SYSTEM_CHILD_ID,
                 type=self.const.MessageType.internal,
-                sub_type=self.const.Internal.I_PRESENTATION)
+                sub_type=self.const.Internal.I_PRESENTATION,
+            )
             if self._route_message(msg):
                 self.tasks.add_job(msg.encode)
         return ret
 
     def _route_message(self, msg):
-        if not isinstance(msg, Message) or \
-                msg.type == self.const.MessageType.presentation:
+        if (
+            not isinstance(msg, Message)
+            or msg.type == self.const.MessageType.presentation
+        ):
             return None
-        if (msg.node_id not in self.sensors
-                or msg.type == self.const.MessageType.stream
-                or not self.sensors[msg.node_id].new_state):
+        if (
+            msg.node_id not in self.sensors
+            or msg.type == self.const.MessageType.stream
+            or not self.sensors[msg.node_id].new_state
+        ):
             return msg
         self.sensors[msg.node_id].queue.append(msg.encode())
         return None
 
-    def set_child_value(
-            self, sensor_id, child_id, value_type, value, **kwargs):
+    def set_child_value(self, sensor_id, child_id, value_type, value, **kwargs):
         """Add a command to set a sensor value, to the queue.
 
         A queued command will be sent to the sensor when the gateway
@@ -145,12 +148,18 @@ def set_child_value(
             return
         if self.sensors[sensor_id].new_state:
             self.sensors[sensor_id].set_child_value(
-                child_id, value_type, value,
-                children=self.sensors[sensor_id].new_state)
+                child_id, value_type, value, children=self.sensors[sensor_id].new_state
+            )
         else:
-            self.tasks.add_job(partial(
-                self.sensors[sensor_id].set_child_value, child_id, value_type,
-                value, **kwargs))
+            self.tasks.add_job(
+                partial(
+                    self.sensors[sensor_id].set_child_value,
+                    child_id,
+                    value_type,
+                    value,
+                    **kwargs
+                )
+            )
 
     def send(self, message):
         """Write a message to the arduino gateway."""
@@ -177,25 +186,42 @@ class BaseSyncGateway(Gateway):
     """MySensors base sync gateway."""
 
     def __init__(
-            self, transport, *args, persistence=False,
-            persistence_file='mysensors.pickle', **kwargs):
+        self,
+        transport,
+        *args,
+        persistence=False,
+        persistence_file="mysensors.pickle",
+        **kwargs
+    ):
         """Set up gateway."""
         super().__init__(*args, **kwargs)
         self.tasks = SyncTasks(
-            self.const, persistence, persistence_file, self.sensors, transport)
+            self.const, persistence, persistence_file, self.sensors, transport
+        )
 
 
 class BaseAsyncGateway(Gateway):
     """MySensors base async gateway."""
 
     def __init__(
-            self, transport, *args, loop=None, persistence=False,
-            persistence_file='mysensors.pickle', **kwargs):
+        self,
+        transport,
+        *args,
+        loop=None,
+        persistence=False,
+        persistence_file="mysensors.pickle",
+        **kwargs
+    ):
         """Set up gateway."""
         super().__init__(*args, **kwargs)
         self.tasks = AsyncTasks(
-            self.const, persistence, persistence_file, self.sensors,
-            transport, loop=loop)
+            self.const,
+            persistence,
+            persistence_file,
+            self.sensors,
+            transport,
+            loop=loop,
+        )
 
     async def start(self):
         """Start the gateway and task allow tasks to be scheduled."""

mysensors/cli/__init__.py

@@ -8,13 +8,13 @@
 from mysensors.cli.gateway_serial import async_serial_gateway, serial_gateway
 from mysensors.cli.gateway_tcp import async_tcp_gateway, tcp_gateway
 
-SETTINGS = dict(help_option_names=['-h', '--help'])
+SETTINGS = dict(help_option_names=["-h", "--help"])
 
 
 @click.group(
-    options_metavar='', subcommand_metavar='<command>',
-    context_settings=SETTINGS)
-@click.option('--debug', is_flag=True, help='Start pymysensors in debug mode.')
+    options_metavar="", subcommand_metavar="<command>", context_settings=SETTINGS
+)
+@click.option("--debug", is_flag=True, help="Start pymysensors in debug mode.")
 @click.version_option(__version__)
 def cli(debug):
     """Run pymysensors as an app for testing purposes."""