From: Kaliko Jack <kaliko@azylum.org>
Date: Wed, 12 Apr 2023 13:45:02 +0000 (+0200)
Subject: Add logging
X-Git-Tag: v0.9.0~22
X-Git-Url: http://git.kaliko.me/?p=python-musicpd.git;a=commitdiff_plain;h=bfbbf9f08541b964bab6fe4b8f05ca6c43199f13

Add logging
---

diff --git a/CHANGES.txt b/CHANGES.txt
index 31706e2..04623a9 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -8,6 +8,7 @@ Changes in 0.9.0
  * mpd_version attribute init to empty string instead of None
  * Fixed send_noidle (introduced with e8daa719)
  * Improved Range object to deal with window parameter
+ * Add logging
 
 Changes in 0.8.0
 ----------------
diff --git a/musicpd.py b/musicpd.py
index ed2e01e..b7f7350 100644
--- a/musicpd.py
+++ b/musicpd.py
@@ -8,8 +8,9 @@
 """Python Music Player Daemon client library"""
 
 
-import socket
+import logging
 import os
+import socket
 
 from functools import wraps
 
@@ -25,6 +26,8 @@ CONNECTION_TIMEOUT = 30
 #: Socket timeout in second (Default is None for no timeout)
 SOCKET_TIMEOUT = None
 
+log = logging.getLogger(__name__)
+
 
 def iterator_wrapper(func):
     """Decorator handling iterate option"""
@@ -334,24 +337,30 @@ class MPDClient:
                 mpd_host_env = _host.split('@', 1)
                 if mpd_host_env[0]:
                     # A password is actually set
+                    log.debug('password detected in MPD_HOST, set client pwd attribute')
                     self.pwd = mpd_host_env[0]
                     if mpd_host_env[1]:
                         self.host = mpd_host_env[1]
+                        log.debug('host detected in MPD_HOST: %s', self.host)
                 elif mpd_host_env[1]:
                     # No password set but leading @ is an abstract socket
                     self.host = '@'+mpd_host_env[1]
+                    log.debug('host detected in MPD_HOST: %s (abstract socket)', self.host)
             else:
                 # MPD_HOST is a plain host
                 self.host = _host
+                log.debug('host detected in MPD_HOST: @%s', self.host)
         else:
             # Is socket there
             xdg_runtime_dir = os.getenv('XDG_RUNTIME_DIR', '/run')
             rundir = os.path.join(xdg_runtime_dir, 'mpd/socket')
             if os.path.exists(rundir):
                 self.host = rundir
+                log.debug('host detected in ${XDG_RUNTIME_DIR}/run: %s (unix socket)', self.host)
         _mpd_timeout = os.getenv('MPD_TIMEOUT', '')
         if _mpd_timeout.isdigit():
             self.mpd_timeout = int(_mpd_timeout)
+            log.debug('timeout detected in MPD_TIMEOUT: %d', self.mpd_timeout)
         else:  # Use CONNECTION_TIMEOUT as default even if MPD_TIMEOUT carries gargage
             self.mpd_timeout = CONNECTION_TIMEOUT
 
@@ -700,8 +709,10 @@ class MPDClient:
         if self._sock is not None:
             raise ConnectionError("Already connected")
         if host[0] in ['/', '@']:
+            log.debug('Connecting unix socket %s', host)
             self._sock = self._connect_unix(host)
         else:
+            log.debug('Connecting tcp socket %s:%s (timeout: %ss)', host, port, self.mpd_timeout)
             self._sock = self._connect_tcp(host, port)
         self._rfile = self._sock.makefile("r", encoding='utf-8', errors='surrogateescape')
         self._rbfile = self._sock.makefile("rb")
@@ -711,6 +722,7 @@ class MPDClient:
         except:
             self.disconnect()
             raise
+        log.debug('Connected')
 
     @property
     def socket_timeout(self):