Bump version, update copyright

[python-musicpd.git] / musicpd.py

diff --git a/musicpd.py b/musicpd.py
index 1a7fd9759b290ab5db8e4549689e8343dc7cbc5f..6e54b5684433ac5ce42e51deb2365426e4e99276 100644 (file)
--- a/musicpd.py
+++ b/musicpd.py
@@ -1,6 +1,7 @@
 # python-musicpd: Python MPD client library
 # Copyright (C) 2008-2010  J. Alexander Treuman <jat@spatialrift.net>
-# Copyright (C) 2012-2018  Kaliko Jack <kaliko@azylum.org>
+# Copyright (C) 2012-2019  Kaliko Jack <kaliko@azylum.org>
+# Copyright (C) 2019       Naglis Jonaitis <naglis@mailbox.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
@@ -27,7 +28,7 @@ HELLO_PREFIX = "OK MPD "
 ERROR_PREFIX = "ACK "
 SUCCESS = "OK"
 NEXT = "list_OK"
-VERSION = '0.4.3'
+VERSION = '0.4.4'
 
 
 def iterator_wrapper(func):
@@ -104,9 +105,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 import 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):
@@ -207,6 +221,10 @@ class MPDClient:
             "kill":               None,
             "password":           self._fetch_nothing,
             "ping":               self._fetch_nothing,
+            # Partition Commands
+            "partition":          self._fetch_nothing,
+            "listpartitions":     self._fetch_list,
+            "newpartition":       self._fetch_nothing,
             # Audio Output Commands
             "disableoutput":      self._fetch_nothing,
             "enableoutput":       self._fetch_nothing,
@@ -235,7 +253,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 +263,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 +556,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 +584,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()