Update docs with note about logging config (#903)

* Update docs with note about logging config * Switch to __name__ in getLogger()
pydicom · Jan 2, 2024 · a952c71 · a952c71
1 parent 8db4ff1
commit a952c71
Show file tree

Hide file tree

Showing 32 changed files with 40 additions and 34 deletions.
diff --git a/docs/tutorials/create_scu.rst b/docs/tutorials/create_scu.rst
@@ -252,8 +252,14 @@ Troubleshooting associations
 ----------------------------
 
 By itself our output isn't very helpful in understanding what's going on.
-Fortunately, by default *pynetdicom* has lots of logging output, which can be
-sent to the terminal by calling :func:`~debug_logger`:
+Fortunately *pynetdicom* has lots of logging output, but by default its
+configured to send it all to the :class:`~logging.NullHandler` which prevents
+warnings and errors being printed to ``sys.stderr``. This can be undone by
+importing :mod:`logging` and setting ``logging.getLogger("pynetdicom").handlers = []``
+or by adding your own logging handlers.
+
+If you need to troubleshoot, then a quick way to send the debugging output to
+``sys.stderr`` is by calling :func:`~debug_logger`:
 
 .. code-block:: python
  :linenos:

diff --git a/pynetdicom/__init__.py b/pynetdicom/__init__.py
@@ -68,12 +68,12 @@
 
 
 # Setup default logging
-logging.getLogger("pynetdicom").addHandler(logging.NullHandler())
+logging.getLogger(__name__).addHandler(logging.NullHandler())
 
 
 def debug_logger() -> None:
  """Setup the logging for debugging."""
- logger = logging.getLogger("pynetdicom")
+ logger = logging.getLogger(__name__)
  # Ensure only have one StreamHandler
  logger.handlers = []
  handler = logging.StreamHandler()

diff --git a/pynetdicom/_handlers.py b/pynetdicom/_handlers.py
@@ -61,7 +61,7 @@
  from pynetdicom.pdu_items import SOPClassCommonExtendedNegotiation
 
 
-LOGGER = logging.getLogger("pynetdicom.events")
+LOGGER = logging.getLogger(__name__)
 
 
 # Debugging handlers

diff --git a/pynetdicom/_validators.py b/pynetdicom/_validators.py
@@ -7,7 +7,7 @@
 from pydicom.uid import UID
 
 
-LOGGER = logging.getLogger("pynetdicom._validators")
+LOGGER = logging.getLogger(__name__)
 
 
 def validate_ae(value: str) -> Tuple[bool, str]:

diff --git a/pynetdicom/acse.py b/pynetdicom/acse.py
@@ -29,7 +29,7 @@
  from pynetdicom.transport import AssociationSocket
 
 
-LOGGER = logging.getLogger("pynetdicom.acse")
+LOGGER = logging.getLogger(__name__)
 
 
 class ACSE:

diff --git a/pynetdicom/ae.py b/pynetdicom/ae.py
@@ -41,7 +41,7 @@
 )
 
 
-LOGGER = logging.getLogger("pynetdicom.ae")
+LOGGER = logging.getLogger(__name__)
 
 
 _T = TypeVar("_T")

diff --git a/pynetdicom/association.py b/pynetdicom/association.py
@@ -90,7 +90,7 @@
 
 
 # pylint: enable=no-name-in-module
-LOGGER = logging.getLogger("pynetdicom.assoc")
+LOGGER = logging.getLogger(__name__)
 HandlerType = dict[
  evt.EventType,
  (list[tuple[Callable, None | list[Any]]] | tuple[Callable, None | list[Any]]),

diff --git a/pynetdicom/dimse.py b/pynetdicom/dimse.py
@@ -62,7 +62,7 @@
  from pynetdicom.pdu_primitives import P_DATA
 
 
-LOGGER = logging.getLogger("pynetdicom.dimse")
+LOGGER = logging.getLogger(__name__)
 
 _RQ_TO_MESSAGE = {
  C_ECHO: C_ECHO_RQ,

diff --git a/pynetdicom/dimse_messages.py b/pynetdicom/dimse_messages.py
@@ -36,7 +36,7 @@
  from pynetdicom.dimse_primitives import NTF
 
 
-LOGGER = logging.getLogger("pynetdicom.dimse")
+LOGGER = logging.getLogger(__name__)
 
 
 # PS3.7 Section 9.3

diff --git a/pynetdicom/dimse_primitives.py b/pynetdicom/dimse_primitives.py
@@ -36,7 +36,7 @@ def close(self) -> None:
  ...
 
 
-LOGGER = logging.getLogger("pynetdicom.dimse_primitives")
+LOGGER = logging.getLogger(__name__)
 
 
 DimseServiceType = Union[

diff --git a/pynetdicom/dsutils.py b/pynetdicom/dsutils.py
@@ -18,7 +18,7 @@
 from pynetdicom.utils import pretty_bytes
 
 
-LOGGER = logging.getLogger("pynetdicom.dsutils")
+LOGGER = logging.getLogger(__name__)
 
 
 def create_file_meta(

diff --git a/pynetdicom/dul.py b/pynetdicom/dul.py
@@ -40,7 +40,7 @@
  _QueueType = queue.Queue[Union[_PDUPrimitiveType, T_CONNECT]]
 
 
-LOGGER = logging.getLogger("pynetdicom.dul")
+LOGGER = logging.getLogger(__name__)
 
 
 class DULServiceProvider(Thread):

diff --git a/pynetdicom/events.py b/pynetdicom/events.py
@@ -52,7 +52,7 @@
  )
 
 
-LOGGER = logging.getLogger("pynetdicom.events")
+LOGGER = logging.getLogger(__name__)
 
 
 EventType = Union["NotificationEvent", "InterventionEvent"]

diff --git a/pynetdicom/fsm.py b/pynetdicom/fsm.py
@@ -24,7 +24,7 @@
  from pynetdicom.pdu_primitives import A_ASSOCIATE, P_DATA, A_RELEASE
 
 
-LOGGER = logging.getLogger("pynetdicom.sm")
+LOGGER = logging.getLogger(__name__)
 
 
 class InvalidEventError(Exception):

diff --git a/pynetdicom/pdu.py b/pynetdicom/pdu.py
@@ -57,7 +57,7 @@
  )
 
 
-LOGGER = logging.getLogger("pynetdicom.pdu")
+LOGGER = logging.getLogger(__name__)
 
 _PDVItem = List[PresentationDataValueItem]
 _AbortType = Union["A_ABORT", "A_P_ABORT"]

diff --git a/pynetdicom/pdu_items.py b/pynetdicom/pdu_items.py
@@ -75,7 +75,7 @@
  )
 
 
-LOGGER = logging.getLogger("pynetdicom.pdu_items")
+LOGGER = logging.getLogger(__name__)
 
 # Predefine some structs to make decoding and encoding faster
 UCHAR = Struct("B")

diff --git a/pynetdicom/pdu_primitives.py b/pynetdicom/pdu_primitives.py
@@ -22,7 +22,7 @@
 from pynetdicom.utils import validate_uid, decode_bytes, set_ae, set_uid
 from pynetdicom._globals import DEFAULT_MAX_LENGTH
 
-LOGGER = logging.getLogger("pynetdicom.pdu_primitives")
+LOGGER = logging.getLogger(__name__)
 
 _PDUPrimitiveType = Union["A_ASSOCIATE", "A_RELEASE", "A_ABORT", "A_P_ABORT", "P_DATA"]
 _UserInformationPrimitiveType = List[

diff --git a/pynetdicom/presentation.py b/pynetdicom/presentation.py
@@ -47,7 +47,7 @@
  from pynetdicom.pdu_primitives import SCP_SCU_RoleSelectionNegotiation
 
 
-LOGGER = logging.getLogger("pynetdicom.presentation")
+LOGGER = logging.getLogger(__name__)
 
 
 # Used with the event handlers to give the users access to the context

diff --git a/pynetdicom/service_class.py b/pynetdicom/service_class.py
@@ -76,7 +76,7 @@
 DestinationType = tuple[str, int] | tuple[str, int, dict[str, Any]]
 
 
-LOGGER = logging.getLogger("pynetdicom.service-c")
+LOGGER = logging.getLogger(__name__)
 
 
 class attempt:

diff --git a/pynetdicom/service_class_n.py b/pynetdicom/service_class_n.py
@@ -36,7 +36,7 @@
  _UPS = N_CREATE | N_EVENT_REPORT | N_GET | N_SET | N_ACTION | C_FIND
 
 
-LOGGER = logging.getLogger("pynetdicom.service-n")
+LOGGER = logging.getLogger(__name__)
 
 
 class ApplicationEventLoggingServiceClass(ServiceClass):

diff --git a/pynetdicom/sop_class.py b/pynetdicom/sop_class.py
@@ -38,7 +38,7 @@
 )
 
 
-LOGGER = logging.getLogger("pynetdicom.sop")
+LOGGER = logging.getLogger(__name__)
 
 
 def uid_to_service_class(uid: str) -> Type[ServiceClass]:

diff --git a/pynetdicom/tests/parrot.py b/pynetdicom/tests/parrot.py
@@ -13,7 +13,7 @@
 from pynetdicom.transport import AssociationServer
 
 
-LOGGER = logging.getLogger("pynetdicom")
+LOGGER = logging.getLogger(__name__)
 
 
 class ParrotRequest(BaseRequestHandler):

diff --git a/pynetdicom/tests/test_dimse_c.py b/pynetdicom/tests/test_dimse_c.py
@@ -44,7 +44,7 @@
 )
 
 
-LOGGER = logging.getLogger("pynetdicom")
+LOGGER = logging.getLogger(__name__)
 LOGGER.setLevel(logging.CRITICAL)
 
 

diff --git a/pynetdicom/tests/test_dimse_msg.py b/pynetdicom/tests/test_dimse_msg.py
@@ -99,7 +99,7 @@
  n_set_rq_cmd_empty,
 )
 
-LOGGER = logging.getLogger("pynetdicom")
+LOGGER = logging.getLogger(__name__)
 LOGGER.setLevel(logging.CRITICAL)
 
 

diff --git a/pynetdicom/tests/test_dimse_n.py b/pynetdicom/tests/test_dimse_n.py
@@ -69,7 +69,7 @@
  PYD_CONFIG.settings.reading_validation_mode = 0
 
 
-LOGGER = logging.getLogger("pynetdicom")
+LOGGER = logging.getLogger(__name__)
 LOGGER.setLevel(logging.CRITICAL)
 
 

diff --git a/pynetdicom/tests/test_pdu.py b/pynetdicom/tests/test_pdu.py
@@ -58,7 +58,7 @@
 from pynetdicom.sop_class import Verification
 from pynetdicom.utils import pretty_bytes
 
-LOGGER = logging.getLogger("pynetdicom")
+LOGGER = logging.getLogger(__name__)
 LOGGER.setLevel(logging.CRITICAL)
 
 

diff --git a/pynetdicom/tests/test_primitives.py b/pynetdicom/tests/test_primitives.py
@@ -32,7 +32,7 @@
  PYD_CONFIG.settings.reading_validation_mode = 0
 
 
-LOGGER = logging.getLogger("pynetdicom")
+LOGGER = logging.getLogger(__name__)
 LOGGER.setLevel(logging.CRITICAL)
 
 

diff --git a/pynetdicom/tests/test_status.py b/pynetdicom/tests/test_status.py
@@ -16,7 +16,7 @@
  HAS_STATUS = False
 
 
-LOGGER = logging.getLogger("pynetdicom")
+LOGGER = logging.getLogger(__name__)
 LOGGER.setLevel(logging.CRITICAL)
 
 

diff --git a/pynetdicom/tests/test_timer.py b/pynetdicom/tests/test_timer.py
@@ -8,7 +8,7 @@
 from pynetdicom.timer import Timer
 from .utils import sleep
 
-LOGGER = logging.getLogger("pynetdicom")
+LOGGER = logging.getLogger(__name__)
 LOGGER.setLevel(logging.CRITICAL)
 
 

diff --git a/pynetdicom/timer.py b/pynetdicom/timer.py
@@ -6,7 +6,7 @@
 from typing import Optional
 
 
-LOGGER = logging.getLogger("pynetdicom.artim")
+LOGGER = logging.getLogger(__name__)
 
 
 class Timer:

diff --git a/pynetdicom/transport.py b/pynetdicom/transport.py
@@ -37,7 +37,7 @@
  from pynetdicom.dul import _QueueType
 
 
-LOGGER = logging.getLogger("pynetdicom.transport")
+LOGGER = logging.getLogger(__name__)
 
 
 class T_CONNECT:

diff --git a/pynetdicom/utils.py b/pynetdicom/utils.py
@@ -27,7 +27,7 @@
 from pynetdicom import _config
 
 
-LOGGER = logging.getLogger("pynetdicom.utils")
+LOGGER = logging.getLogger(__name__)
 
 
 def decode_bytes(encoded_value: bytes) -> str: