From: Ed Page <eopage@byu.net>
Date: Wed, 17 Mar 2010 01:40:37 +0000 (-0500)
Subject: Noting where I block to find them faster
X-Git-Url: http://git.maemo.org/git/?p=theonering;a=commitdiff_plain;h=a3d4b5a03a1c10621db4b193d50e1c64410de0d7

Noting where I block to find them faster
---

diff --git a/src/gvoice/backend.py b/src/gvoice/backend.py
index 19275f8..9996e74 100755
--- a/src/gvoice/backend.py
+++ b/src/gvoice/backend.py
@@ -235,6 +235,7 @@ class GVoiceBackend(object):
 		Attempts to detect a current session
 		@note Once logged in try not to reauth more than once a minute.
 		@returns If authenticated
+		@blocks
 		"""
 		isRecentledAuthed = (time.time() - self._lastAuthed) < 120
 		isPreviouslyAuthed = self._token is not None
@@ -282,6 +283,7 @@ class GVoiceBackend(object):
 		"""
 		Attempt to login to GoogleVoice
 		@returns Whether login was successful or not
+		@blocks
 		"""
 		self.logout()
 		galxToken = self._get_token()
@@ -309,6 +311,9 @@ class GVoiceBackend(object):
 		self._lastAuthed = 0.0
 
 	def is_dnd(self):
+		"""
+		@blocks
+		"""
 		isDndPage = self._get_page(self._isDndURL)
 
 		dndGroup = self._isDndRe.search(isDndPage)
@@ -319,6 +324,9 @@ class GVoiceBackend(object):
 		return isDnd
 
 	def set_dnd(self, doNotDisturb):
+		"""
+		@blocks
+		"""
 		dndPostData = {
 			"doNotDisturb": 1 if doNotDisturb else 0,
 		}
@@ -328,6 +336,7 @@ class GVoiceBackend(object):
 	def call(self, outgoingNumber):
 		"""
 		This is the main function responsible for initating the callback
+		@blocks
 		"""
 		outgoingNumber = self._send_validation(outgoingNumber)
 		subscriberNumber = None
@@ -353,6 +362,7 @@ class GVoiceBackend(object):
 		"""
 		Cancels a call matching outgoing and forwarding numbers (if given). 
 		Will raise an error if no matching call is being placed
+		@blocks
 		"""
 		page = self._get_page_with_token(
 			self._callCancelURL,
@@ -365,6 +375,9 @@ class GVoiceBackend(object):
 		self._parse_with_validation(page)
 
 	def send_sms(self, phoneNumbers, message):
+		"""
+		@blocks
+		"""
 		validatedPhoneNumbers = [
 			self._send_validation(phoneNumber)
 			for phoneNumber in phoneNumbers
@@ -383,6 +396,7 @@ class GVoiceBackend(object):
 		"""
 		Search your Google Voice Account history for calls, voicemails, and sms
 		Returns ``Folder`` instance containting matching messages
+		@blocks
 		"""
 		page = self._get_page(
 			self._XML_SEARCH_URL,
@@ -392,6 +406,9 @@ class GVoiceBackend(object):
 		return json
 
 	def get_feed(self, feed):
+		"""
+		@blocks
+		"""
 		actualFeed = "_XML_%s_URL" % feed.upper()
 		feedUrl = getattr(self, actualFeed)
 
@@ -406,7 +423,8 @@ class GVoiceBackend(object):
 		which can either be a ``Message`` instance, or a SHA1 identifier. 
 		Saves files to ``adir`` (defaults to current directory). 
 		Message hashes can be found in ``self.voicemail().messages`` for example. 
-		Returns location of saved file.
+		@returns location of saved file.
+		@blocks
 		"""
 		page = self._get_page(self._downloadVoicemailURL, {"id": messageId})
 		fn = os.path.join(adir, '%s.mp3' % messageId)
@@ -453,6 +471,7 @@ class GVoiceBackend(object):
 	def get_recent(self):
 		"""
 		@returns Iterable of (personsName, phoneNumber, exact date, relative date, action)
+		@blocks
 		"""
 		for action, url in (
 			("Received", self._XML_RECEIVED_URL),
@@ -470,6 +489,7 @@ class GVoiceBackend(object):
 	def get_contacts(self):
 		"""
 		@returns Iterable of (contact id, contact name)
+		@blocks
 		"""
 		page = self._get_page(self._XML_CONTACTS_URL)
 		contactsBody = self._contactsBodyRe.search(page)
@@ -482,6 +502,9 @@ class GVoiceBackend(object):
 				yield contactId, contactDetails
 
 	def get_voicemails(self):
+		"""
+		@blocks
+		"""
 		voicemailPage = self._get_page(self._XML_VOICEMAIL_URL)
 		voicemailHtml = self._grab_html(voicemailPage)
 		voicemailJson = self._grab_json(voicemailPage)
@@ -490,6 +513,9 @@ class GVoiceBackend(object):
 		return voicemails
 
 	def get_texts(self):
+		"""
+		@blocks
+		"""
 		smsPage = self._get_page(self._XML_SMS_URL)
 		smsHtml = self._grab_html(smsPage)
 		smsJson = self._grab_json(smsPage)
@@ -498,6 +524,9 @@ class GVoiceBackend(object):
 		return smss
 
 	def mark_message(self, messageId, asRead):
+		"""
+		@blocks
+		"""
 		postData = {
 			"read": 1 if asRead else 0,
 			"id": messageId,
@@ -506,6 +535,9 @@ class GVoiceBackend(object):
 		markPage = self._get_page(self._markAsReadURL, postData)
 
 	def archive_message(self, messageId):
+		"""
+		@blocks
+		"""
 		postData = {
 			"id": messageId,
 		}