Changeset 61c5043

Timestamp:

Nov 29, 2009, 10:14:51 PM (15 years ago)

Author:

Nimrod Gileadi <nimrodg@…>

Branches:

master, debian, mac, no-cups, web

Children:

b17d602

Parents:

d566e6b

git-author:

Nimrod Gileadi <nimrodg@…> (11/29/09 22:14:51)

git-committer:

Nimrod Gileadi <nimrodg@…> (11/29/09 22:14:51)

Message:

Added docstrings. Beautified debugging output slightly.

File:

• gutenbach-rhythmbox-plugin/__init__.py (modified) (4 diffs)

gutenbach-rhythmbox-plugin/__init__.py

@@ +1 @@
+"""
+This module implements a Rhythmbox plugin that sends selected track to a
+printer queue. It's meant to be used with gutenbach, a music spooling printer
+server.
+
+The plugin uses lpr to send the files to gutenbach.
+"""
+import gtk
 import rb
-import gtk
+import subprocess
+import urllib
 import urlparse
-import urllib
-import subprocess
 
 # UI Change is an extra item added to right-click menu when clicking on tracks
@@ -18 +25 @@
 
     def activate(self, shell):
+        """Adds a new item to the right-click menu which allows
+        sending music files to the gutenbach server.
+        """
         self.shell = shell
         # Create action for sending a track to gutenbach
@@ -38 +48 @@
 
     def gutenbach_action(self, action, shell):
+        """An action called when the user clicks the right-click menu item
+        to send a track to gutenbach.
+        This function calls an instance of lpr for each file to be added.
+        """
         source = shell.get_property("selected-source")
         # For each track currently selected in the song browser
@@ -51 +65 @@
                     printer = self.printer
                 command = 'lpr -P %s "%s"' % (printer, path)
-                print command
+                print "About to run command '%s'" % command
                 subprocess.Popen(command, shell=True)