Docstring and function rename

git-svn-id: file:///svnroot/gc-dialer/trunk@113 c39d3808-3fe2-4d86-a59f-b7f623ee9f21

diff --git a/src/gc_dialer.py b/src/gc_dialer.py
index 27ce60f..8c42f69 100755 (executable)
--- a/src/gc_dialer.py
+++ b/src/gc_dialer.py
@@ -118,6 +118,9 @@ def make_pretty(phonenumber):
 
 
 def make_idler(func):
+       """
+       Decorator that makes a generator-function into a function that will continue execution on next call
+       """
        a = []
 
        def callable(*args, **kwds):
@@ -471,11 +474,17 @@ class Dialpad(object):
                error_dialog.run()
 
        def set_number(self, number):
+               """
+               Set the callback phonenumber
+               """
                self._phonenumber = make_ugly(number)
                self._prettynumber = make_pretty(self._phonenumber)
                self._numberdisplay.set_label("<span size='30000' weight='bold'>%s</span>" % ( self._prettynumber ) )
 
        def set_account_number(self):
+               """
+               Displays current account number
+               """
                accountnumber = self._gcBackend.get_account_number()
                self._widgetTree.get_widget("gcnumberlabel").set_label("<span size='23000' weight='bold'>%s</span>" % (accountnumber))
 
@@ -537,7 +546,7 @@ class Dialpad(object):
                sys.exit(0)
 
        def _on_clearcookies_clicked(self, *args):
-               self._gcBackend.reset()
+               self._gcBackend.logout()
                self._callbackNeedsSetup = True
                self._recenttime = 0.0
                self._contactstime = 0.0

diff --git a/src/gcbackend.py b/src/gcbackend.py
index c9dac34..1e5ff5f 100644 (file)
--- a/src/gcbackend.py
+++ b/src/gcbackend.py
@@ -102,6 +102,11 @@ class GCDialer(object):
 
                return self.is_authed()
 
+       def logout(self):
+               self._lastAuthed = 0.0
+               self._browser.cookies.clear()
+               self._browser.cookies.save()
+
        def dial(self, number):
                """
                This is the main function responsible for initating the callback
@@ -143,11 +148,6 @@ class GCDialer(object):
        def clear_caches(self):
                pass
 
-       def reset(self):
-               self._lastAuthed = 0.0
-               self._browser.cookies.clear()
-               self._browser.cookies.save()
-
        def is_valid_syntax(self, number):
                """
                @returns If This number be called ( syntax validation only )
@@ -244,6 +244,9 @@ class GCDialer(object):
                        yield personsName, phoneNumber, date, action
 
        def get_contacts(self):
+               """
+               @returns Iterable of (contact id, contact name)
+               """
                contactsPagesUrls = [GCDialer._contactsURL]
                for contactsPageUrl in contactsPagesUrls:
                        contactsPage = self._browser.download(contactsPageUrl)
@@ -258,6 +261,9 @@ class GCDialer(object):
                                contactsPagesUrls.append(newContactsPageUrl)
        
        def get_contact_details(self, contactId):
+               """
+               @returns Iterable of (Phone Type, Phone Number)
+               """
                detailPage = self._browser.download(GCDialer._contactDetailURL + '/' + contactId)
                for detail_match in self._contactDetailPhoneRe.finditer(detailPage):
                        phoneType = detail_match.group(1)