tobias/docker-offlineimap
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

LocalStatus.py added docstrings

Browse Source 
This patch adds some docstrings.
This commit is contained in:
Rodolfo García Peñas (kix) 2020-11-01 12:52:51 +01:00
parent 2409fe8f49
commit 14020a670f
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
offlineimap/repository/LocalStatus.py
View File

@ -25,6 +25,9 @@ from offlineimap.error import OfflineImapError
class LocalStatusRepository(BaseRepository): class LocalStatusRepository(BaseRepository):
"""
Local Status Repository Class, child of Base Repository Class
"""
def __init__(self, reposname, account): def __init__(self, reposname, account):
BaseRepository.__init__(self, reposname, account) BaseRepository.__init__(self, reposname, account)
@ -58,12 +61,30 @@ class LocalStatusRepository(BaseRepository):
return self.LocalStatusFolderClass(foldername, self) # Instantiate. return self.LocalStatusFolderClass(foldername, self) # Instantiate.
def setup_backend(self, backend): def setup_backend(self, backend):
"""
Setup the backend.
Args:
backend: backend to use
Returns: None
"""
if backend in list(self.backends.keys()): if backend in list(self.backends.keys()):
self._backend = backend self._backend = backend
self.root = self.backends[backend]['root'] self.root = self.backends[backend]['root']
self.LocalStatusFolderClass = self.backends[backend]['class'] self.LocalStatusFolderClass = self.backends[backend]['class']
def import_other_backend(self, folder): def import_other_backend(self, folder):
"""
Import other backend
Args:
folder: folder
Returns: None
"""
for bk, dic in list(self.backends.items()): for bk, dic in list(self.backends.items()):
# Skip folder's own type. # Skip folder's own type.
if dic['class'] == type(folder): if dic['class'] == type(folder):