Refactoring: make functions to be private if we can

Make external API of class/module to be smaller, explicitely mark
all internal functions.  Also annotate methods that are implemented
as the part of the parent class interface.

Signed-off-by: Eygene Ryabinkin <rea@codelabs.ru>
This commit is contained in:
Eygene Ryabinkin
2014-03-16 16:27:35 +04:00
parent af2d6dc5e1
commit 6cbd2498ae
14 changed files with 218 additions and 136 deletions

View File

@ -31,7 +31,7 @@ from offlineimap.imaplib2 import IMAP4, IMAP4_SSL, zlib, IMAP4_PORT, InternalDat
class UsefulIMAPMixIn(object):
def getselectedfolder(self):
def __getselectedfolder(self):
if self.state == 'SELECTED':
return self.mailbox
return None
@ -41,7 +41,7 @@ class UsefulIMAPMixIn(object):
:returns: 'OK' on success, nothing if the folder was already
selected or raises an :exc:`OfflineImapError`"""
if self.getselectedfolder() == mailbox and self.is_readonly == readonly \
if self.__getselectedfolder() == mailbox and self.is_readonly == readonly \
and not force:
# No change; return.
return
@ -66,6 +66,7 @@ class UsefulIMAPMixIn(object):
raise OfflineImapError(errstr, severity)
return result
# Overrides private function from IMAP4 (@imaplib2)
def _mesg(self, s, tn=None, secs=None):
new_mesg(self, s, tn, secs)