Mark zeroconf.logger as protected by renaming to zeroconf._logger

bdraco · bdraco · commit f34f9c457848 · 2021-06-13T09:09:11.000-10:00
- The public API should only access zeroconf and zeroconf.aio
  as internals may be relocated between releases
diff --git a/tests/test_init.py b/tests/test_init.py
@@ -136,8 +136,8 @@ def on_service_state_change(zeroconf, service_type, state_change, name):
         # mock zeroconf's logger warning() and debug()
         from unittest.mock import patch
 
-        patch_warn = patch('zeroconf.log.warning')
-        patch_debug = patch('zeroconf.log.debug')
+        patch_warn = patch('zeroconf._logger.log.warning')
+        patch_debug = patch('zeroconf._logger.log.debug')
         mocked_log_warn = patch_warn.start()
         mocked_log_debug = patch_debug.start()
 
diff --git a/tests/test_logger.py b/tests/test_logger.py
@@ -5,22 +5,22 @@
 """Unit tests for logger.py."""
 
 from unittest.mock import patch
-from zeroconf.logger import QuietLogger
+from zeroconf._logger import QuietLogger
 
 
 def test_log_warning_once():
     """Test we only log with warning level once."""
     quiet_logger = QuietLogger()
-    with patch("zeroconf.logger.log.warning") as mock_log_warning, patch(
-        "zeroconf.logger.log.debug"
+    with patch("zeroconf._logger.log.warning") as mock_log_warning, patch(
+        "zeroconf._logger.log.debug"
     ) as mock_log_debug:
         quiet_logger.log_warning_once("the warning")
 
     assert mock_log_warning.mock_calls
     assert not mock_log_debug.mock_calls
 
-    with patch("zeroconf.logger.log.warning") as mock_log_warning, patch(
-        "zeroconf.logger.log.debug"
+    with patch("zeroconf._logger.log.warning") as mock_log_warning, patch(
+        "zeroconf._logger.log.debug"
     ) as mock_log_debug:
         quiet_logger.log_warning_once("the warning")
 
@@ -31,16 +31,16 @@ def test_log_warning_once():
 def test_log_exception_warning():
     """Test we only log with warning level once."""
     quiet_logger = QuietLogger()
-    with patch("zeroconf.logger.log.warning") as mock_log_warning, patch(
-        "zeroconf.logger.log.debug"
+    with patch("zeroconf._logger.log.warning") as mock_log_warning, patch(
+        "zeroconf._logger.log.debug"
     ) as mock_log_debug:
         quiet_logger.log_exception_warning("the exception warning")
 
     assert mock_log_warning.mock_calls
     assert not mock_log_debug.mock_calls
 
-    with patch("zeroconf.logger.log.warning") as mock_log_warning, patch(
-        "zeroconf.logger.log.debug"
+    with patch("zeroconf._logger.log.warning") as mock_log_warning, patch(
+        "zeroconf._logger.log.debug"
     ) as mock_log_debug:
         quiet_logger.log_exception_warning("the exception warning")
 
diff --git a/zeroconf/__init__.py b/zeroconf/__init__.py
@@ -36,6 +36,7 @@
     DNSService,
     DNSText,
 )
+from ._logger import QuietLogger, log  # noqa # import needed for backwards compat
 from .exceptions import (  # noqa # import needed for backwards compat
     AbstractMethodException,
     BadTypeInNameException,
@@ -45,7 +46,6 @@
     NonUniqueNameException,
     ServiceNameAlreadyRegistered,
 )
-from .logger import QuietLogger, log  # noqa # import needed for backwards compat
 from .services import (  # noqa # import needed for backwards compat
     instance_name_from_service_info,
     Signal,
diff --git a/zeroconf/_core.py b/zeroconf/_core.py
@@ -30,6 +30,7 @@
 
 from ._dns import DNSIncoming, DNSOutgoing, DNSQuestion
 from ._handlers import QueryHandler, RecordManager
+from ._logger import QuietLogger, log
 from .cache import DNSCache
 from .const import (
     _CACHE_CLEANUP_INTERVAL,
@@ -48,7 +49,6 @@
     _UNREGISTER_TIME,
 )
 from .exceptions import NonUniqueNameException
-from .logger import QuietLogger, log
 from .services import (
     RecordUpdateListener,
     ServiceBrowser,
diff --git a/zeroconf/_dns.py b/zeroconf/_dns.py
@@ -25,6 +25,7 @@
 import struct
 from typing import Any, Dict, List, Optional, TYPE_CHECKING, Tuple, Union, cast
 
+from ._logger import QuietLogger, log
 from .const import (
     _CLASSES,
     _CLASS_MASK,
@@ -48,7 +49,6 @@
     _TYPE_TXT,
 )
 from .exceptions import AbstractMethodException, IncomingDecodeError, NamePartTooLongException
-from .logger import QuietLogger, log
 from .utils.net import _is_v6_address
 from .utils.struct import int2byte
 from .utils.time import current_time_millis, millis_to_seconds
diff --git a/zeroconf/_handlers.py b/zeroconf/_handlers.py
@@ -24,6 +24,7 @@
 from typing import List, Optional, TYPE_CHECKING, Union
 
 from ._dns import DNSAddress, DNSIncoming, DNSOutgoing, DNSPointer, DNSQuestion, DNSRecord
+from ._logger import log
 from .const import (
     _CLASS_IN,
     _DNS_OTHER_TTL,
@@ -36,7 +37,6 @@
     _TYPE_SRV,
     _TYPE_TXT,
 )
-from .logger import log
 from .services import (
     RecordUpdateListener,
 )
diff --git a/zeroconf/_logger.py b/zeroconf/_logger.py
diff --git a/zeroconf/asyncio.py b/zeroconf/asyncio.py
@@ -20,8 +20,8 @@
     USA
 """
 
+from ._logger import log
 from .aio import AsyncZeroconf  # pylint: disable=unused-import  # noqa
-from .logger import log
 
 # The asyncio module would shadow system asyncio in some import cases
 # to resolve this, the module has been renamed zeroconf.aio
diff --git a/zeroconf/utils/net.py b/zeroconf/utils/net.py
@@ -30,8 +30,8 @@
 
 import ifaddr
 
+from .._logger import log
 from ..const import _IPPROTO_IPV6, _MDNS_ADDR6_BYTES, _MDNS_ADDR_BYTES, _MDNS_PORT
-from ..logger import log
 
 
 @enum.unique

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@`
`24`	`24`	`from typing import List, Optional, TYPE_CHECKING, Union`
`25`	`25`
`26`	`26`	`from ._dns import DNSAddress, DNSIncoming, DNSOutgoing, DNSPointer, DNSQuestion, DNSRecord`
	`27`	`+from ._logger import log`
`27`	`28`	`from .const import (`
`28`	`29`	`_CLASS_IN,`
`29`	`30`	`_DNS_OTHER_TTL,`
`@@ -36,7 +37,6 @@`
`36`	`37`	`_TYPE_SRV,`
`37`	`38`	`_TYPE_TXT,`
`38`	`39`	`)`
`39`		`-from .logger import log`
`40`	`40`	`from .services import (`
`41`	`41`	`RecordUpdateListener,`
`42`	`42`	`)`