Changeset 32

Timestamp:

May 17, 2007, 7:16:18 PM (17 years ago)

Author:

simon

Message:

A doc-comment, shock! Remove my custom list of prefixes.

File:

• mpd-status/trunk/mpdstatus.py (modified) (2 diffs)

mpd-status/trunk/mpdstatus.py

@@ -21 +21 @@
 from sre import compile
 import sys
+
 state_map = {
     'play': u'Playing',
@@ -26 +27 @@
     'stop': u'Stopped'
     }
+"""Mapping from the states we get from mpd to nicer display names."""
+
 fields = ['artist', 'album', 'track', 'title']
-strip_paths = [
-    u'albums',
-    u'classical',
-    u'houseofdoom',
-    u'mods',
-    u'original',
-    u'soundtracks'
-    ]
+"""The fields to display."""
+
+strip_paths = []
+"""List of path prefixes to remove from the filename for display."""
+
 
 strip_expr = compile(u'(%s)/' % ur'|'.join(strip_paths))
 
 def get_status(connection):
+    """Get playing state and song information.
+    
+    @return: Play state and song information.
+    @rtype: C{dict}
+    @param connection: mpd connection to use.
+    @type connection: C{mpdclient2.mpd_connection}
+    """
     songinfo = {}
     songinfo['state'] = state_map[connection.status()['state']]