Adding in support to upload presentations to the Documents List API.

api.jfisher · api.jfisher · commit d996880d444c · 2007-09-19T16:55:53.000Z
diff --git a/samples/docs/docs_example.py b/samples/docs/docs_example.py
@@ -27,43 +27,61 @@
 
 
 class DocsSample(object):
+  """A DocsSample object demonstrates the Document List feed."""
 
   def __init__(self, email, password):
-    """Takes an email and password corresponding to a gmail account to
-    demonstrate the functionality of the Document List feed."""
-
+    """Constructor for the DocsSample object.
+    
+    Takes an email and password corresponding to a gmail account to
+    demonstrate the functionality of the Document List feed.
+    
+    Args:
+      email: [string] The e-mail address of the account to use for the sample.
+      password: [string] The password corresponding to the account specified by
+          the email parameter.
+    
+    Returns:
+      A DocsSample object used to run the sample demonstrating the
+      functionality of the Document List feed.
+    """
     self.gd_client = gdata.docs.service.DocsService()
     self.gd_client.email = email
     self.gd_client.password = password
     self.gd_client.source = 'Document List Python Sample'
     self.gd_client.ProgrammaticLogin()
 
   def _PrintFeed(self, feed):
-    """Prints out the contents of a feed to the console."""
-
+    """Prints out the contents of a feed to the console.
+   
+    Args:
+      feed: A gdata.docs.DocumentListFeed instance.
+    """
     print '\n'
-    if not len(feed.entry):
+    if not feed.entry:
       print 'No entries in feed.\n'
     for i, entry in enumerate(feed.entry):
       print '%s %s\n' % (i+1, entry.title.text.encode('UTF-8'))
 
   def _GetFileExtension(self, file_name):
-    """Returns the three letter file extension for a file in upper case
-    characters."""
-
-    match = re.search('.*\.([a-zA-Z]{3}$)',file_name)
+    """Returns the uppercase file extension for a file.
+    
+    Args:
+      file_name: [string] The basename of a filename.
+      
+    Returns:
+      A string containing the file extension of the file.
+    """
+    match = re.search('.*\.([a-zA-Z]{3}$)', file_name)
     if match:
       return match.group(1).upper()
-    else:
-      return False
+    return False
 
   def _UploadMenu(self):
     """Prompts that enable a user to upload a file to the Document List feed."""
-
     file_path = ''
     file_path = raw_input('Enter path to file: ')
 
-    if file_path == '':
+    if not file_path:
       return
     elif not os.path.isfile(file_path):
       print 'Not a valid file.'
@@ -79,18 +97,21 @@ def _UploadMenu(self):
       content_type = gdata.docs.service.SUPPORTED_FILETYPES[ext]
    
     title = ''
-    while title == '':
+    while not title:
       title = raw_input('Enter name for document: ')
 
     try:
-      ms = gdata.MediaSource(file_path = file_path, content_type = content_type)
+      ms = gdata.MediaSource(file_path=file_path, content_type=content_type)
     except IOError:
       print 'Problems reading file. Check permissions.'
       return
    
-    if ext in ['CSV','ODS','XLS']:
+    if ext in ['CSV', 'ODS', 'XLS']:
       print 'Uploading spreadsheet...'
       entry = self.gd_client.UploadSpreadsheet(ms, title)
+    elif ext in ['PPT', 'PPS']:
+      print 'Uploading presentation...'
+      entry = self.gd_client.UploadPresentation(ms, title)
     else:
       print 'Uploading word processor document...'
       entry = self.gd_client.UploadDocument(ms, title)
@@ -103,50 +124,60 @@ def _UploadMenu(self):
 
   def _ListAllDocuments(self):
     """Retrieves a list of all of a user's documents and displays them."""
-
     feed = self.gd_client.GetDocumentListFeed()
     self._PrintFeed(feed)
 
   def _ListAllSpreadsheets(self):
     """Retrieves a list of a user's spreadsheets and displays them."""
-
-    q = gdata.docs.service.DocumentQuery(categories=['spreadsheet'])
-    feed = self.gd_client.Query(q.ToUri())
+    query = gdata.docs.service.DocumentQuery(categories=['spreadsheet'])
+    feed = self.gd_client.Query(query.ToUri())
     self._PrintFeed(feed)
 
   def _ListAllWPDocuments(self):
-    """Retrieves a list of a user's word processor documents and displays 
-       them."""
+    """Retrieves a list of a user's WP documents and displays them."""
+    query = gdata.docs.service.DocumentQuery(categories=['document'])
+    feed = self.gd_client.Query(query.ToUri())
+    self._PrintFeed(feed)
 
-    q = gdata.docs.service.DocumentQuery(categories=['document'])
-    feed = self.gd_client.Query(q.ToUri())
+  def _ListAllPresentations(self):
+    """Retrieves a list of a user's presentations and displays them."""
+    query = gdata.docs.service.DocumentQuery(categories=['presentation'])
+    feed = self.gd_client.Query(query.ToUri())
     self._PrintFeed(feed)
 
   def _FullTextSearch(self):
-    """Provides prompts to search a user's documents and displays the results
+    """Searches a user's documents for a text string.
+    
+    Provides prompts to search a user's documents and displays the results
     of such a search. The text_query parameter of the DocumentListQuery object
     corresponds to the contents of the q parameter in the feed. Note that this
-    parameter searches the content of documents, not just their titles."""
-
+    parameter searches the content of documents, not just their titles.
+    """
     input = raw_input('Enter search term: ')
-    q = gdata.docs.service.DocumentQuery(text_query=input)
-    feed = self.gd_client.Query(q.ToUri())
+    query = gdata.docs.service.DocumentQuery(text_query=input)
+    feed = self.gd_client.Query(query.ToUri())
     self._PrintFeed(feed)
 
   def _PrintMenu(self):
     """Displays a menu of options for the user to choose from."""
-
     print ('\nDocument List Sample\n'
            '1) List all of your documents.\n'
            '2) List all of your spreadsheets.\n'
            '3) List all of your word processor documents.\n'
-           '4) Search your documents.\n'
-           '5) Upload a document.\n'
-           '6) Exit.\n')
+           '4) List all of your presentations.\n'
+           '5) Search your documents.\n'
+           '6) Upload a document.\n'
+           '7) Exit.\n')
 
   def _GetMenuChoice(self, max):
-    """Retrieves the menu selection from the user."""
-
+    """Retrieves the menu selection from the user.
+    
+    Args:
+      max: [int] The maximum number of allowed choices (inclusive)
+      
+    Returns:
+      The integer of the menu item chosen by the user.
+    """
     while True:
       input = raw_input('> ')
 
@@ -162,15 +193,13 @@ def _GetMenuChoice(self, max):
         return num
 
   def Run(self):
-    """Allows the user to pick from various actions which demonstrate uses of
-    the Document List feed."""
-
+    """Prompts the user to choose funtionality to be demonstrated."""
     try:
       while True:
 
         self._PrintMenu()
 
-        choice = self._GetMenuChoice(6)
+        choice = self._GetMenuChoice(7)
 
         if choice == 1:
           self._ListAllDocuments()
@@ -179,10 +208,12 @@ def Run(self):
         elif choice == 3:
           self._ListAllWPDocuments()
         elif choice == 4:
-          self._FullTextSearch()
+          self._ListAllPresentations()
         elif choice == 5:
-          self._UploadMenu()
+          self._FullTextSearch()
         elif choice == 6:
+          self._UploadMenu()
+        elif choice == 7:
           return
 
     except KeyboardInterrupt:
@@ -191,12 +222,10 @@ def Run(self):
 
 
 def main():
-  """Demonstrates use of the Docs client library extension using the
-     DocsSample object."""
-
+  """Demonstrates use of the Docs extension using the DocsSample object."""
   # Parse command line options
   try:
-    opts, args = getopt.getopt(sys.argv[1:], "", ["user=", "pw="])
+    opts, args = getopt.getopt(sys.argv[1:], '', ['user=', 'pw='])
   except getopt.error, msg:
     print 'python docsExample.py --user [username] --pw [password] '
     sys.exit(2)
@@ -206,17 +235,17 @@ def main():
   key = ''
   # Process options
   for option, arg in opts:
-    if option == "--user":
+    if option == '--user':
       user = arg
-    elif option == "--pw":
+    elif option == '--pw':
       pw = arg
 
-  if user == '':
+  while not user:
     print 'NOTE: Please run these tests only with a test account.'
     user = raw_input('Please enter your username: ')
-  while pw == '':
+  while not pw:
     pw = getpass.getpass()
-    if pw == '':
+    if not pw:
       print 'Password cannot be blank.'
 
   try:
diff --git a/src/gdata/docs/__init__.py b/src/gdata/docs/__init__.py
@@ -18,13 +18,6 @@
 
 __author__ = 'api.jfisher (Jeff Fisher)'
 
-try:
-  from xml.etree import cElementTree as ElementTree
-except ImportError:
-  try:
-    import cElementTree as ElementTree
-  except ImportError:
-    from elementtree import ElementTree
 import atom
 import gdata
 
@@ -71,5 +64,3 @@ def DocumentListFeedFromString(xml_string):
     A DocumentListFeed object corresponding to the given XML.
   """
   return atom.CreateClassFromXMLString(DocumentListFeed, xml_string)
-  
-
diff --git a/src/gdata/docs/service.py b/src/gdata/docs/service.py
