# python-musicpd: Python MPD client library
-# Copyright (C) 2012-2020 kaliko <kaliko@azylum.org>
+# Copyright (C) 2012-2021 kaliko <kaliko@azylum.org>
# Copyright (C) 2019 Naglis Jonaitis <naglis@mailbox.org>
# Copyright (C) 2019 Bart Van Loon <bbb@bbbart.be>
# Copyright (C) 2008-2010 J. Alexander Treuman <jat@spatialrift.net>
ERROR_PREFIX = "ACK "
SUCCESS = "OK"
NEXT = "list_OK"
-VERSION = '0.5.0'
-#: seconds before a tcp connection attempt times out
-CONNECTION_TIMEOUT = 5
+VERSION = '0.7.0'
+#: Seconds before a connection attempt times out
+#: (overriden by MPD_TIMEOUT env. var.)
+CONNECTION_TIMEOUT = 30
+#: Socket timeout in second (Default is None for no timeout)
+SOCKET_TIMEOUT = None
def iterator_wrapper(func):
def __init__(self):
self.iterate = False
+ #: Socket timeout value in seconds
+ self._socket_timeout = SOCKET_TIMEOUT
+ #: Current connection timeout value, defaults to
+ #: :py:obj:`CONNECTION_TIMEOUT` or env. var. ``MPD_TIMEOUT`` if provided
+ self.mpd_timeout = None
self._reset()
self._commands = {
# Status Commands
"random": self._fetch_nothing,
"repeat": self._fetch_nothing,
"setvol": self._fetch_nothing,
+ "getvol": self._fetch_object,
"single": self._fetch_nothing,
"replay_gain_mode": self._fetch_nothing,
"replay_gain_status": self._fetch_item,
"kill": None,
"password": self._fetch_nothing,
"ping": self._fetch_nothing,
+ "binarylimit": self._fetch_nothing,
"tagtypes": self._fetch_list,
"tagtypes disable": self._fetch_nothing,
"tagtypes enable": self._fetch_nothing,
"""
self.host = 'localhost'
self.pwd = None
- self.port = os.environ.get('MPD_PORT', '6600')
- mpd_host_env = os.environ.get('MPD_HOST')
- if mpd_host_env:
- # If password is set:
- # mpd_host_env = ['pass', 'host'] because MPD_HOST=pass@host
- mpd_host_env = mpd_host_env.split('@')
- mpd_host_env.reverse()
- self.host = mpd_host_env[0]
- if len(mpd_host_env) > 1 and mpd_host_env[1]:
- self.pwd = mpd_host_env[1]
+ self.port = os.getenv('MPD_PORT', '6600')
+ if os.getenv('MPD_HOST'):
+ # If password is set: MPD_HOST=pass@host
+ if '@' in os.getenv('MPD_HOST'):
+ mpd_host_env = os.getenv('MPD_HOST').split('@', 1)
+ if mpd_host_env[0]:
+ # A password is actually set
+ self.pwd = mpd_host_env[0]
+ if mpd_host_env[1]:
+ self.host = mpd_host_env[1]
+ elif mpd_host_env[1]:
+ # No password set but leading @ is an abstract socket
+ self.host = '@'+mpd_host_env[1]
+ else:
+ # MPD_HOST is a plain host
+ self.host = os.getenv('MPD_HOST')
else:
# Is socket there
- xdg_runtime_dir = os.environ.get('XDG_RUNTIME_DIR', '/run')
+ 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
+ self.mpd_timeout = os.getenv('MPD_TIMEOUT')
+ if self.mpd_timeout and self.mpd_timeout.isdigit():
+ self.mpd_timeout = int(self.mpd_timeout)
+ else: # Use CONNECTION_TIMEOUT as default even if MPD_TIMEOUT carries gargage
+ self.mpd_timeout = CONNECTION_TIMEOUT
def __getattr__(self, attr):
if attr == 'send_noidle': # have send_noidle to cancel idle as well as noidle
parts.append('{0!s}'.format(Range(arg)))
else:
parts.append('"%s"' % escape(str(arg)))
+ if '\n' in ' '.join(parts):
+ raise CommandError('new line found in the command!')
self._write_line(" ".join(parts))
def _read_binary(self, amount):
obj['data'] = self._read_binary(amount)
except IOError as err:
raise ConnectionError('Error reading binary content: %s' % err)
- if len(obj['data']) != amount:
+ if len(obj['data']) != amount: # can we ever get there?
raise ConnectionError('Error reading binary content: '
'Expects %sB, got %s' % (amount, len(obj['data'])))
# Fetches trailing new line
if not hasattr(socket, "AF_UNIX"):
raise ConnectionError(
"Unix domain sockets not supported on this platform")
+ # 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)
return sock
def _connect_tcp(self, host, port):
sock = None
try:
sock = socket.socket(af, socktype, proto)
- sock.settimeout(CONNECTION_TIMEOUT)
+ sock.settimeout(self.mpd_timeout)
sock.connect(sa)
- sock.settimeout(None)
+ sock.settimeout(self.socket_timeout)
return sock
except socket.error as socket_err:
err = socket_err
The connect method honors MPD_HOST/MPD_PORT environment variables.
+ The underlying socket also honors MPD_TIMEOUT environment variable
+ and defaults to :py:obj:`musicpd.CONNECTION_TIMEOUT` (connect command only).
+
+ If you want to have a timeout for each command once you got connected,
+ set its value in :py:obj:`MPDClient.socket_timeout` (in second) or at
+ module level in :py:obj:`musicpd.SOCKET_TIMEOUT`.
+
.. note:: Default host/port
If host evaluate to :py:obj:`False`
* use ``MPD_HOST`` environment variable if set, extract password if present,
- * else looks for a existing file in ``${XDG_RUNTIME_DIR:-/run/}/mpd/socket``
+ * else looks for an existing file in ``${XDG_RUNTIME_DIR:-/run/}/mpd/socket``
* else set host to ``localhost``
If port evaluate to :py:obj:`False`
self.port = port
if self._sock is not None:
raise ConnectionError("Already connected")
- if host.startswith("/"):
+ if host[0] in ['/', '@']:
self._sock = self._connect_unix(host)
else:
self._sock = self._connect_tcp(host, port)
self.disconnect()
raise
+ @property
+ def socket_timeout(self):
+ """Socket timeout in second (defaults to :py:obj:`SOCKET_TIMEOUT`).
+ Use None to disable socket timout."""
+ return self._socket_timeout
+
+ @socket_timeout.setter
+ def socket_timeout(self, timeout):
+ 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
self._reset()
def fileno(self):
+ """Return the socket’s file descriptor (a small integer).
+ This is useful with :py:obj:`select.select`.
+ """
if self._sock is None:
raise ConnectionError("Not connected")
return self._sock.fileno()