Provide proper deprecation of the "address" argument and field

dtantsur · dtantsur · commit 07950d8ea6a5 · 2019-05-20T14:45:36.000+02:00
* Raise deprecation warnings when address is used * Add a compatibility property to avoid breaking existing code (based on suggestion by Bas Stottelaar in PR #27) * Make addresses keyword-only, so that address can be eventually removed and replaced with it without breaking consumers * Raise TypeError instead of an assertion on conflicting address and addresses
diff --git a/examples/browser.py b/examples/browser.py
@@ -19,10 +19,7 @@ def on_service_state_change(
     if state_change is ServiceStateChange.Added:
         info = zeroconf.get_service_info(service_type, name)
         if info:
-            addresses = [
-                "%s:%d" % (socket.inet_ntoa(addr), cast(int, info.port))
-                for addr in info.addresses
-            ]
+            addresses = ["%s:%d" % (socket.inet_ntoa(addr), cast(int, info.port)) for addr in info.addresses]
             print("  Addresses: %s" % ", ".join(addresses))
             print("  Weight: %d, priority: %d" % (info.weight, info.priority))
             print("  Server: %s" % (info.server,))
diff --git a/examples/registration.py b/examples/registration.py
@@ -20,12 +20,10 @@
     info = ServiceInfo(
         "_http._tcp.local.",
         "Paul's Test Web Site._http._tcp.local.",
-        socket.inet_aton("127.0.0.1"),
-        80,
-        0,
-        0,
-        desc,
-        "ash-2.local.",
+        addresses=[socket.inet_aton("127.0.0.1")],
+        port=80,
+        properties=desc,
+        server="ash-2.local.",
     )
 
     zeroconf = Zeroconf()
diff --git a/examples/self_test.py b/examples/self_test.py
@@ -21,11 +21,9 @@
     info = ServiceInfo(
         "_http._tcp.local.",
         "My Service Name._http._tcp.local.",
-        socket.inet_aton("127.0.0.1"),
-        1234,
-        0,
-        0,
-        desc,
+        addresses=[socket.inet_aton("127.0.0.1")],
+        port=1234,
+        properties=desc,
     )
     print("   Registering service...")
     r.register_service(info)
diff --git a/test_zeroconf.py b/test_zeroconf.py
@@ -969,9 +969,15 @@ def test_multiple_addresses():
     # Old way
     info = ServiceInfo(type_, registration_name, address, 80, 0, 0, desc, "ash-2.local.")
 
-    assert not hasattr(info, "address")
+    assert info.address == address
     assert info.addresses == [address]
 
+    # Updating works
+    address2 = socket.inet_aton("10.0.1.3")
+    info.address = address2
+
+    assert info.addresses == [address2]
+
     # Compatibility way
     info = ServiceInfo(type_, registration_name, [address, address], 80, 0, 0, desc, "ash-2.local.")
 
diff --git a/zeroconf.py b/zeroconf.py
@@ -30,6 +30,7 @@
 import sys
 import threading
 import time
+import warnings
 from functools import reduce
 from typing import AnyStr, Dict, List, Optional, Union, cast
 from typing import Callable, Set, Tuple  # noqa # used in type hints
@@ -1441,13 +1442,14 @@ def __init__(
         server: Optional[str] = None,
         host_ttl: int = _DNS_HOST_TTL,
         other_ttl: int = _DNS_OTHER_TTL,
-        addresses: Optional[List[bytes]] = None,
+        *,
+        addresses: Optional[List[bytes]] = None
     ) -> None:
         """Create a service description.
 
         type_: fully qualified service type name
         name: fully qualified service name
-        address: IP address as unsigned short, network byte order (legacy)
+        address: IP address as unsigned short, network byte order (deprecated, use addresses)
         port: port that the service runs on
         weight: weight of the service
         priority: priority of the service
@@ -1461,11 +1463,8 @@ def __init__(
         """
 
         # Accept both none, or one, but not both.
-        assert (
-            (address is None and addresses is None)
-            or (address is None and addresses)
-            or (address and addresses is None)
-        )
+        if address is not None and addresses is not None:
+            raise TypeError("address and addresses cannot be provided together")
 
         if not type_.endswith(service_type_name(name, allow_underscores=True)):
             raise BadTypeInNameException
@@ -1474,6 +1473,7 @@ def __init__(
         if addresses is not None:
             self.addresses = addresses
         elif address is not None:
+            warnings.warn("address is deprecated, use addresses instead", DeprecationWarning)
             if isinstance(address, list):
                 self.addresses = address
             else:
@@ -1492,6 +1492,22 @@ def __init__(
         self.host_ttl = host_ttl
         self.other_ttl = other_ttl
 
+    @property
+    def address(self):
+        warnings.warn("ServiceInfo.address is deprecated, use addresses instead", DeprecationWarning)
+        try:
+            return self.addresses[0]
+        except IndexError:
+            return None
+
+    @address.setter
+    def address(self, value):
+        warnings.warn("ServiceInfo.address is deprecated, use addresses instead", DeprecationWarning)
+        if value is None:
+            self.addresses = []
+        else:
+            self.addresses = [value]
+
     @property
     def properties(self) -> ServicePropertiesType:
         return self._properties
