X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=musicpd.py;h=89d38e4d5c5d6c77e36d18b8f066c6300cb55f43;hb=884c06a5ce8fb60b80f1b68c16c3eabc0f3283bd;hp=1a7fd9759b290ab5db8e4549689e8343dc7cbc5f;hpb=966e3a848b9d545530cc7c7a78c5185c69183b22;p=python-musicpd.git

diff --git a/musicpd.py b/musicpd.py
index 1a7fd97..89d38e4 100644
--- a/musicpd.py
+++ b/musicpd.py
@@ -104,9 +104,22 @@ class _NotConnected:
         raise ConnectionError("Not connected")
 
 class MPDClient:
-    """MPDClient instance will look for ``MPD_HOST``/``MPD_PORT`` environment
-    variables and set instance attribute ``host``, ``port`` and ``password``
+    """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):
@@ -235,7 +248,7 @@ class MPDClient:
             else use MPD_HOST=${XDG_RUNTIME_DIR:-/run/}/mpd/socket if file exists
         """
         self.host = 'localhost'
-        self.password = None
+        self.pwd = None
         self.port = os.environ.get('MPD_PORT', '6600')
         mpd_host_env = os.environ.get('MPD_HOST')
         if mpd_host_env:
@@ -245,7 +258,7 @@ class MPDClient:
             mpd_host_env.reverse()
             self.host = mpd_host_env[0]
             if len(mpd_host_env) > 1 and mpd_host_env[1]:
-                self.password = mpd_host_env[1]
+                self.pwd = mpd_host_env[1]
         else:
             # Is socket there
             xdg_runtime_dir = os.environ.get('XDG_RUNTIME_DIR', '/run')
@@ -538,9 +551,9 @@ class MPDClient:
         .. note:: Default host/port
 
           If host evaluate to :py:obj:`False`
-           * if ``MPD_HOST`` env. var. is set, use it for host
+           * use ``MPD_HOST`` env. var. if set, extract password if present,
            * else looks for a existing file in ``${XDG_RUNTIME_DIR:-/run/}/mpd/socket``
-           * finally set host to ``localhost``
+           * else set host to ``localhost``
 
           If port evaluate to :py:obj:`False`
            * if ``MPD_PORT`` env. var. is set, use it for port
@@ -566,8 +579,8 @@ class MPDClient:
 
     def disconnect(self):
         """Closes the MPD connection.
-        The client closes the actual socket and not using the
-        'close' request from MPD protocol as suggested in documentation.
+        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()