X-Git-Url: http://git.kaliko.me/?p=python-musicpd.git;a=blobdiff_plain;f=doc%2Fsource%2Fuse.rst;h=8e9fe4793cc7e3c67d55dcca6cb1fafa0fa2d281;hp=cdf0ed223effa1dcf53066685a7c5dc33b05a68c;hb=57628d1d2e54b60c27ff5bcf60c6d17beeffc22c;hpb=0c16ca07e3ac85ab212c3444f9e5a71c4a96a406

diff --git a/doc/source/use.rst b/doc/source/use.rst
index cdf0ed2..8e9fe47 100644
--- a/doc/source/use.rst
+++ b/doc/source/use.rst
@@ -1,3 +1,6 @@
+.. SPDX-FileCopyrightText: 2018-2021  kaliko <kaliko@azylum.org>
+.. SPDX-License-Identifier: GPL-3.0-or-later
+
 Using the client library
 =========================
 
@@ -24,6 +27,8 @@ them), and the functions used to parse their responses see :ref:`commands`.
 
 See the `MPD protocol documentation`_ for more details.
 
+.. _environment_variables:
+
 Environment variables
 ---------------------
 
@@ -38,14 +43,33 @@ The client honors the following environment variables:
   * ``MPD_TIMEOUT`` timeout for connecting to MPD and waiting for MPD’s response in seconds
   * ``XDG_RUNTIME_DIR`` path to look for potential socket: ``${XDG_RUNTIME_DIR}/mpd/socket``
 
-Defaults settings
------------------
+.. _default_settings:
+
+Default settings
+----------------
 
   * If ``MPD_HOST`` is not set, then look for a socket in ``${XDG_RUNTIME_DIR}/mpd/socket``
   * If there is no socket use ``localhost``
   * If ``MPD_PORT`` is not set, then use ``6600``
   * If ``MPD_TIMEOUT`` is not set, then uses :py:obj:`musicpd.CONNECTION_TIMEOUT`
 
+
+Context manager
+---------------
+
+Calling MPDClient in a context manager :py:obj:`musicpd.MPDClient.connect` is
+transparently called with :ref:`default setting<default_settings>` (use
+:ref:`environment variables<environment_variables>` to override defaults).
+Leaving the context manager :py:obj:`musicpd.MPDClient.disconnect` is called.
+
+.. code-block:: python
+
+    import os
+    os.environ['MPD_HOST'] = 'mpdhost'
+    with MPDClient() as c:
+        c.status()
+        c.next()
+
 Command lists
 -------------
 
@@ -101,7 +125,7 @@ Idle prefixed commands
 ----------------------
 
 Each command have a *send\_<CMD>* and a *fetch\_<CMD>* variant, which allows to
-send a MPD command and then fetch the result later.
+send a MPD command and then fetch the result later (non-blocking call).
 This is useful for the idle command:
 
 .. code-block:: python
@@ -122,6 +146,8 @@ This is useful for the idle command:
     >>> gobject.io_add_watch(client, gobject.IO_IN, callback)
     >>> gobject.MainLoop().run()
 
+See also use of :ref:`socket timeout<socket_timeout>` with idle command.
+
 Fetching binary content (cover art)
 -----------------------------------
 
@@ -172,6 +198,8 @@ You can also use `readpicture` command to fetch embedded picture:
 
 Refer to `MPD protocol documentation`_ for the meaning of `binary`, `size` and `data`.
 
+.. _socket_timeout:
+
 Socket timeout
 --------------
 
@@ -218,6 +246,10 @@ Here is a solution to use ``idle`` command with ``socket_timeout``:
                 cli.noidle()
     except socket.timeout as err:
         print(f'{err} (timeout {cli.socket_timeout})')
+    except (OSError, musicpd.MPDError) as err:
+        print(f'{err!r}')
+        if cli._sock is not None:
+            cli.disconnect()
     except KeyboardInterrupt:
         pass
 
@@ -232,8 +264,9 @@ Some explanations:
 
 All three commands in the while loop (send_idle, fetch_idle, noidle) are not
 triggering a socket timeout unless the connection is actually lost (actually it
-could also be that MPD took to much time to answer, but MPD taking more than a
+could also be that MPD took too much time to answer, but MPD taking more than a
 couple of seconds for these commands should never occur).
 
 
 .. _MPD protocol documentation: http://www.musicpd.org/doc/protocol/
+.. vim: spell spelllang=en