Publishing should not fail with None brokers ikalchev#27

Accessory.publish and Characteristic.notify should not fail when the
broker is not set. This is to allow updates to happen before the
Accessory is added to a driver or the Characteristic is added to an
Accessory.

pyhap/__init__.py

@@ -6,7 +6,7 @@
 CHARACTERISTICS_FILE = os.path.join(_RESOURCE_DIR, "characteristics.json")
 SERVICES_FILE = os.path.join(_RESOURCE_DIR, "services.json")
 
-HAP_PYTHON_VERSION = (1, 1, 2)
+HAP_PYTHON_VERSION = (1, 1, 3)
 """
 HAP-python current version.
 """

pyhap/accessory.py

@@ -319,12 +319,17 @@ def publish(self, data, sender):
 
         Characteristics call this method to send updates.
 
+        @note: The method will not fail if the broker is not set - it will do nothing.
+
         @param data: Data to publish, usually from a Characteristic.
         @type data: dict
 
         @param sender: The Service or Characteristic from which the call originated.
         @type: Service or Characteristic
         """
+        if self.broker is None:
+            return
+
         acc_data = {
             "aid": self.aid,
             "iid": self.iid_manager.get_iid(sender),

pyhap/characteristic.py

@@ -56,6 +56,13 @@ class CharacteristicError(Exception):
     pass
 
 
+class NotConfiguredError(Exception):
+    """Raised when an operation is attempted on a characteristic that has not been
+    fully configured.
+    """
+    pass
+
+
 _HAP_NUMERIC_FIELDS = {"maxValue", "minValue", "minStep", "unit"}
 """Fields that should be included in the HAP representation of the characteristic.
 
@@ -125,7 +132,8 @@ def set_value(self, value, should_notify=True):
         @type value: Depends on properties["Format"]
 
         @param should_notify: Whether a the change should be sent to subscribed clients.
-            The notification is called _after_ the setter callback.
+            The notification is called _after_ the setter callback. Notify will be
+            performed if and only if the broker is set, i.e. not None.
         @type should_notify: bool
 
         @raise ValueError: When the value being assigned is not one of the valid values
@@ -137,7 +145,7 @@ def set_value(self, value, should_notify=True):
         self.value = value
         if self.setter_callback is not None:
             self.setter_callback(value)
-        if should_notify:
+        if should_notify and self.broker is not None:
             self.notify()
 
     def get_value(self):
@@ -166,7 +174,14 @@ def notify(self):
         @note: Non-blocking, i.e. does not wait for the update to be sent.
         @note: Uses the `get_hap_value`, i.e. sends the HAP value.
         @see: accessory_driver.publish
+
+        @raise NotConfiguredError: When the broker is not set.
         """
+        if self.broker is None:
+            raise NotConfiguredError("Attempted to notify when `broker` is None. "
+                                     "Consider adding the characteristic to a "
+                                     "Service and then to an Accessory.")
+
         data = {
             "type_id": self.type_id,
             "value": self.get_hap_value(),

setup.py

@@ -4,7 +4,7 @@
     name="HAP-python",
     description="HomeKit Accessory Protocol implementation in python3",
     author="Ivan Kalchev",
-    version="1.1.2",
+    version="1.1.3",
     url="https://github.com/ikalchev/HAP-python.git",
     classifiers=[
         "Development Status :: 5 - Production/Stable",

tests/test_accessory.py

@@ -4,12 +4,20 @@
 import pytest
 
 import pyhap.accessory as accessory
+import pyhap.loader as loader
 
 class TestAccessory(object):
 
     def test_init(self):
         acc = accessory.Accessory("Test Accessory")
 
+    def test_publish_no_broker(self):
+        acc = accessory.Accessory("Test Accessory")
+        service = loader.get_serv_loader().get("TemperatureSensor")
+        char = service.get_characteristic("CurrentTemperature")
+        acc.add_service(service)
+        char.set_value(25, should_notify=True)
+
 class TestBridge(TestAccessory):
 
     def test_init(self):

tests/test_characteristic.py

@@ -38,11 +38,9 @@ def test_default_valid_value():
 
 def test_set_value():
     char = get_char(PROPERTIES.copy())
-    char.broker = mock.Mock()
     new_value = 3
-    char.set_value(new_value, should_notify=True)
+    char.set_value(new_value)
     assert char.value == new_value
-    assert char.broker.publish.called
 
 def test_set_value_valid_values():
     valid_values = {"foo": 2, "bar": 3, }
@@ -71,3 +69,8 @@ def test_notify():
     char.notify()
     assert broker_mock.publish.called
     broker_mock.publish.assert_called_with(expected, char)
+
+def test_notify_except_no_broker():
+    char = get_char(PROPERTIES.copy())
+    with pytest.raises(characteristic.NotConfiguredError):
+        char.notify()