Releasing 0.9.0

[python-musicpd.git] / musicpd.py

diff --git a/musicpd.py b/musicpd.py
index 3e22598b811581cc3d6ecfcda670d5eece13a296..e24b51d85cc2f3f672172cd034b2bc7b9caea402 100644 (file)
--- a/musicpd.py
+++ b/musicpd.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# SPDX-FileCopyrightText: 2012-2023  kaliko <kaliko@azylum.org>
+# SPDX-FileCopyrightText: 2012-2024  kaliko <kaliko@azylum.org>
 # SPDX-FileCopyrightText: 2021       Wonko der Verständige <wonko@hanstool.org>
 # SPDX-FileCopyrightText: 2019       Naglis Jonaitis <naglis@mailbox.org>
 # SPDX-FileCopyrightText: 2019       Bart Van Loon <bbb@bbbart.be>
@@ -19,11 +19,11 @@ ERROR_PREFIX = "ACK "
 SUCCESS = "OK"
 NEXT = "list_OK"
 #: Module version
-VERSION = '0.9.0b1'
+VERSION = '0.9.0'
 #: Seconds before a connection attempt times out
 #: (overriden by :envvar:`MPD_TIMEOUT` env. var.)
 CONNECTION_TIMEOUT = 30
-#: Socket timeout in second (Default is None for no timeout)
+#: Socket timeout in second > 0 (Default is :py:obj:`None` for no timeout)
 SOCKET_TIMEOUT = None
 
 log = logging.getLogger(__name__)
@@ -164,12 +164,12 @@ class MPDClient:
       :py:attr:`musicpd.MPDClient.port` keep track of current connection
       host and port, :py:attr:`musicpd.MPDClient.pwd` is set once with
       password extracted from environment variable.
-      Calling :py:meth:`password` methode with a new password
+      Calling MPS's password method with a new password
       won't update :py:attr:`musicpd.MPDClient.pwd` value.
 
       Moreover, :py:attr:`musicpd.MPDClient.pwd` is only an helper attribute
       exposing password extracted from :envvar:`MPD_HOST` environment variable, it
-      will not be used as default value for the :py:meth:`password` method
+      will not be used as default value for the MPD's password command.
     """
 
     def __init__(self):
@@ -349,7 +349,7 @@ class MPDClient:
             else:
                 # MPD_HOST is a plain host
                 self.host = _host
-                log.debug('host detected in MPD_HOST: @%s', self.host)
+                log.debug('host detected in MPD_HOST: %s', self.host)
         else:
             # Is socket there
             xdg_runtime_dir = os.getenv('XDG_RUNTIME_DIR', '/run')
@@ -436,9 +436,9 @@ class MPDClient:
         parts = [command]
         for arg in args:
             if isinstance(arg, tuple):
-                parts.append('{0!s}'.format(Range(arg)))
+                parts.append(f'{Range(arg)!s}')
             else:
-                parts.append('"%s"' % escape(str(arg)))
+                parts.append(f'"{escape(str(arg))}"')
         if '\n' in ' '.join(parts):
             raise CommandError('new line found in the command!')
         self._write_line(" ".join(parts))
@@ -642,10 +642,13 @@ class MPDClient:
         # abstract socket
         if path.startswith('@'):
             path = '\0'+path[1:]
-        sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
-        sock.settimeout(self.mpd_timeout)
-        sock.connect(path)
-        sock.settimeout(self.socket_timeout)
+        try:
+            sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+            sock.settimeout(self.mpd_timeout)
+            sock.connect(path)
+            sock.settimeout(self.socket_timeout)
+        except socket.error as socket_err:
+            raise ConnectionError(socket_err) from socket_err
         return sock
 
     def _connect_tcp(self, host, port):
@@ -654,23 +657,29 @@ class MPDClient:
         except AttributeError:
             flags = 0
         err = None
-        for res in socket.getaddrinfo(host, port, socket.AF_UNSPEC,
-                                      socket.SOCK_STREAM, socket.IPPROTO_TCP,
-                                      flags):
+        try:
+            gai = socket.getaddrinfo(host, port, socket.AF_UNSPEC,
+                                     socket.SOCK_STREAM, socket.IPPROTO_TCP,
+                                     flags)
+        except socket.error as gaierr:
+            raise ConnectionError(gaierr) from gaierr
+        for res in gai:
             af, socktype, proto, _, sa = res
             sock = None
             try:
+                log.debug('opening socket %s', sa)
                 sock = socket.socket(af, socktype, proto)
                 sock.settimeout(self.mpd_timeout)
                 sock.connect(sa)
                 sock.settimeout(self.socket_timeout)
                 return sock
             except socket.error as socket_err:
+                log.debug('opening socket %s failed: %s', sa, socket_err)
                 err = socket_err
                 if sock is not None:
                     sock.close()
         if err is not None:
-            raise ConnectionError(str(err))
+            raise ConnectionError(err)
         raise ConnectionError("getaddrinfo returns an empty list")
 
     def noidle(self):
@@ -727,15 +736,25 @@ class MPDClient:
     @property
     def socket_timeout(self):
         """Socket timeout in second (defaults to :py:obj:`SOCKET_TIMEOUT`).
-        Use None to disable socket timout."""
+        Use :py:obj:`None` to disable socket timout.
+
+        :setter: Set the socket timeout (integer > 0)
+        :type: int or None
+        """
         return self._socket_timeout
 
     @socket_timeout.setter
     def socket_timeout(self, timeout):
-        self._socket_timeout = timeout
+        if timeout is not None:
+            if int(timeout) <= 0:
+                raise ValueError('socket_timeout expects a non zero positive integer')
+            self._socket_timeout = int(timeout)
+        else:
+            self._socket_timeout = timeout
         if getattr(self._sock, 'settimeout', False):
             self._sock.settimeout(self._socket_timeout)
 
+
     def disconnect(self):
         """Closes the MPD connection.
         The client closes the actual socket, it does not use the