Fixed tests

[python-musicpd.git] / musicpd.py

diff --git a/musicpd.py b/musicpd.py
index a2637fb4c4aa139e11cd28cf7b1cd8e3ddc5de80..89d38e4d5c5d6c77e36d18b8f066c6300cb55f43 100644 (file)
--- a/musicpd.py
+++ b/musicpd.py
@@ -1,6 +1,6 @@
 # python-musicpd: Python MPD client library
 # Copyright (C) 2008-2010  J. Alexander Treuman <jat@spatialrift.net>
-# Copyright (C) 2012-2014  Kaliko Jack <kaliko@azylum.org>
+# Copyright (C) 2012-2018  Kaliko Jack <kaliko@azylum.org>
 #
 # python-musicpd is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published by
@@ -15,9 +15,11 @@
 # 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=C0111
+# pylint: disable=missing-docstring
 
 import socket
+import os
+
 from functools import wraps
 
 
@@ -25,7 +27,7 @@ HELLO_PREFIX = "OK MPD "
 ERROR_PREFIX = "ACK "
 SUCCESS = "OK"
 NEXT = "list_OK"
-VERSION = '0.4.2'
+VERSION = '0.4.3'
 
 
 def iterator_wrapper(func):
@@ -102,6 +104,24 @@ class _NotConnected:
         raise ConnectionError("Not connected")
 
 class MPDClient:
+    """MPDClient instance will look for ``MPD_HOST``/``MPD_PORT``/``XDG_RUNTIME_DIR`` environment
+    variables and set instance attribute ``host``, ``port`` and ``pwd``
+    accordingly.
+
+    Then :py:obj:`musicpd.MPDClient.connect` will use ``host`` and ``port`` as defaults if not provided as args.
+
+    Cf. :py:obj:`musicpd.MPDClient.connect` for details.
+
+    >>> from os inport environ
+    >>> environ['MPD_HOST'] = 'pass@mpdhost'
+    >>> cli = musicpd.MPDClient()
+    >>> cli.pwd == environ['MPD_HOST'].split('@')[0]
+    True
+    >>> cli.host == environ['MPD_HOST'].split('@')[1]
+    True
+    >>> # cli.connect() will use host/port as set in MPD_HOST/MPD_PORT
+    """
+
     def __init__(self):
         self.iterate = False
         self._reset()
@@ -219,6 +239,32 @@ class MPDClient:
             "readmessages":       self._fetch_messages,
             "sendmessage":        self._fetch_nothing,
         }
+        self._get_envvars()
+
+    def _get_envvars(self):
+        """
+        Retrieve MPD env. var. to overrides "localhost:6600"
+            Use MPD_HOST/MPD_PORT if set
+            else use MPD_HOST=${XDG_RUNTIME_DIR:-/run/}/mpd/socket if file exists
+        """
+        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]
+        else:
+            # Is socket there
+            xdg_runtime_dir = os.environ.get('XDG_RUNTIME_DIR', '/run')
+            rundir = os.path.join(xdg_runtime_dir, 'mpd/socket')
+            if os.path.exists(rundir):
+                self.host = rundir
 
     def __getattr__(self, attr):
         if attr == 'send_noidle':  # have send_noidle to cancel idle as well as noidle
@@ -446,7 +492,6 @@ class MPDClient:
         self.mpd_version = line[len(HELLO_PREFIX):].strip()
 
     def _reset(self):
-        # pylint: disable=w0201
         self.mpd_version = None
         self._iterating = False
         self._pending = []
@@ -495,7 +540,29 @@ class MPDClient:
         self._write_command("noidle")
         return self._fetch_list()
 
-    def connect(self, host, port):
+    def connect(self, host=None, port=None):
+        """Connects the MPD server
+
+        :param str host: hostname, IP or FQDN (defaults to `localhost` or socket, see below for details)
+        :param str port: port number (defaults to 6600)
+
+        The connect method honors MPD_HOST/MPD_PORT environment variables.
+
+        .. note:: Default host/port
+
+          If host evaluate to :py:obj:`False`
+           * use ``MPD_HOST`` env. var. if set, extract password if present,
+           * else looks for a existing file in ``${XDG_RUNTIME_DIR:-/run/}/mpd/socket``
+           * else set host to ``localhost``
+
+          If port evaluate to :py:obj:`False`
+           * if ``MPD_PORT`` env. var. is set, use it for port
+           * else use ``6600``
+        """
+        if not host:
+            host = self.host
+        if not port:
+            port = self.port
         if self._sock is not None:
             raise ConnectionError("Already connected")
         if host.startswith("/"):
@@ -511,6 +578,10 @@ class MPDClient:
             raise
 
     def disconnect(self):
+        """Closes the MPD connection.
+        The client closes the actual socket, it does not use the
+        'close' request from MPD protocol (as suggested in documentation).
+        """
         if hasattr(self._rfile, 'close'):
             self._rfile.close()
         if hasattr(self._wfile, 'close'):