# You should have received a copy of the GNU Lesser General Public License
# along with python-musicpd. If not, see <http://www.gnu.org/licenses/>.
-# pylint: disable=missing-docstring
-
import socket
import os
ERROR_PREFIX = "ACK "
SUCCESS = "OK"
NEXT = "list_OK"
-VERSION = '0.6.0'
-#: seconds before a tcp connection attempt times out
-CONNECTION_TIMEOUT = 5
+VERSION = '0.8.0b0'
+#: 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):
for index in self.tpl:
try:
index = int(index)
- except (TypeError, ValueError):
- raise CommandError('Not a tuple of int')
+ except (TypeError, ValueError) as err:
+ raise CommandError('Not a tuple of int') from err
class _NotConnected:
def __getattr__(self, attr):
return self._dummy
- def _dummy(*args):
+ def _dummy(self, *args):
raise ConnectionError("Not connected")
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
"""
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
if command not in self._commands:
command = command.replace("_", " ")
if command not in self._commands:
- raise AttributeError("'%s' object has no attribute '%s'" %
- (self.__class__.__name__, attr))
+ cls = self.__class__.__name__
+ raise AttributeError(f"'{cls}' object has no attribute '{attr}'")
return lambda *args: wrapper(command, args)
def _send(self, command, args):
if retval is not None:
self._pending.append(command)
- def _fetch(self, command, args=None):
+ def _fetch(self, command, args=None): # pylint: disable=unused-argument
+ cmd_fmt = command.replace(" ", "_")
if self._command_list is not None:
- raise CommandListError("Cannot use fetch_%s in a command list" %
- command.replace(" ", "_"))
+ raise CommandListError(f"Cannot use fetch_{cmd_fmt} in a command list")
if self._iterating:
- raise IteratingError("Cannot use fetch_%s while iterating" %
- command.replace(" ", "_"))
+ raise IteratingError(f"Cannot use fetch_{cmd_fmt} while iterating")
if not self._pending:
raise PendingCommandError("No pending commands to fetch")
if self._pending[0] != command:
- raise PendingCommandError("'%s' is not the currently "
- "pending command" % command)
+ raise PendingCommandError(f"'{command}' is not the currently pending command")
del self._pending[0]
retval = self._commands[command]
if callable(retval):
return retval()
return retval
- def _execute(self, command, args):
+ def _execute(self, command, args): # pylint: disable=unused-argument
if self._iterating:
- raise IteratingError("Cannot execute '%s' while iterating" %
- command)
+ raise IteratingError(f"Cannot execute '{command}' while iterating")
if self._pending:
- raise PendingCommandError(
- "Cannot execute '%s' with pending commands" % command)
+ raise PendingCommandError(f"Cannot execute '{command}' with pending commands")
retval = self._commands[command]
if self._command_list is not None:
if not callable(retval):
- raise CommandListError(
- "'%s' not allowed in command list" % command)
+ raise CommandListError(f"'{command}' not allowed in command list")
self._write_command(command, args)
self._command_list.append(retval)
else:
if callable(retval):
return retval()
return retval
+ return None
def _write_line(self, line):
- self._wfile.write("%s\n" % line)
+ self._wfile.write(f"{line!s}\n")
self._wfile.flush()
def _write_command(self, command, args=None):
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):
raise CommandError(error)
if self._command_list is not None:
if line == NEXT:
- return
+ return None
if line == SUCCESS:
- raise ProtocolError("Got unexpected '%s'" % SUCCESS)
+ raise ProtocolError(f"Got unexpected '{SUCCESS}'")
elif line == SUCCESS:
- return
+ return None
return line
def _read_pair(self, separator, binary=False):
line = self._read_line(binary=binary)
if line is None:
- return
+ return None
pair = line.split(separator, 1)
if len(pair) < 2:
- raise ProtocolError("Could not parse pair: '%s'" % line)
+ raise ProtocolError(f"Could not parse pair: '{line}'")
return pair
def _read_pairs(self, separator=": ", binary=False):
for key, value in self._read_pairs():
if key != seen:
if seen is not None:
- raise ProtocolError("Expected key '%s', got '%s'" %
- (seen, key))
+ raise ProtocolError(f"Expected key '{seen}', got '{key}'")
seen = key
yield value
def _fetch_nothing(self):
line = self._read_line()
if line is not None:
- raise ProtocolError("Got unexpected return value: '%s'" % line)
+ raise ProtocolError(f"Got unexpected return value: '{line}'")
def _fetch_item(self):
pairs = list(self._read_pairs())
if len(pairs) != 1:
- return
+ return None
return pairs[0][1]
@iterator_wrapper
try:
obj['data'] = self._read_binary(amount)
except IOError as err:
- raise ConnectionError('Error reading binary content: %s' % err)
- if len(obj['data']) != amount:
+ raise ConnectionError(f'Error reading binary content: {err}') from err
+ data_bytes = len(obj['data'])
+ if data_bytes != amount: # can we ever get there?
raise ConnectionError('Error reading binary content: '
- 'Expects %sB, got %s' % (amount, len(obj['data'])))
+ f'Expects {amount}B, got {data_bytes}')
# Fetches trailing new line
self._read_line(binary=True)
# Fetches SUCCESS code
raise ConnectionError("Connection lost while reading MPD hello")
line = line.rstrip("\n")
if not line.startswith(HELLO_PREFIX):
- raise ProtocolError("Got invalid MPD hello: '%s'" % line)
+ raise ProtocolError(f"Got invalid MPD hello: '{line}'")
self.mpd_version = line[len(HELLO_PREFIX):].strip()
def _reset(self):
def _connect_unix(self, path):
if not hasattr(socket, "AF_UNIX"):
- raise ConnectionError(
- "Unix domain sockets not supported on this platform")
+ 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
sock.close()
if err is not None:
raise ConnectionError(str(err))
- else:
- raise ConnectionError("getaddrinfo returns an empty list")
+ raise ConnectionError("getaddrinfo returns an empty list")
def noidle(self):
# noidle's special case
if not self._pending or self._pending[0] != 'idle':
- raise CommandError(
- 'cannot send noidle if send_idle was not called')
+ raise CommandError('cannot send noidle if send_idle was not called')
del self._pending[0]
self._write_command("noidle")
return self._fetch_list()
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()
if self._iterating:
raise IteratingError("Cannot begin command list while iterating")
if self._pending:
- raise PendingCommandError("Cannot begin command list "
- "with pending commands")
+ raise PendingCommandError("Cannot begin command list with pending commands")
self._write_command("command_list_ok_begin")
self._command_list = []
home / dev / repositories / python-musicpd.git / blobdiff