start using typing for type hints

Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>

.travis.yml

@@ -13,8 +13,11 @@ branches:
     - master
     - next
 
+before_install:
+  - pip install --upgrade pip
+
 # command to install dependencies
-#install: "pip install -r requirements.txt"
+install: "pip install -r requirements.txt"
 
 #before_script:
   #- cp -a ./tests "$TRAVIS_BUILD_DIR"

imapfw/drivers/driver.py

@@ -20,6 +20,11 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+from typing import TypeVar
+
+
+DriverClass = TypeVar('Driver based class')
+
 
 class DriverInternalInterface(object):
     pass
@@ -52,13 +57,13 @@ def getClassName(self) -> str:
     def getRepositoryName(self) -> str:
         return self.repositoryName
 
-    def init(self):
+    def init(self) -> None:
         """Override this method to make initialization in the rascal."""
 
         pass
 
 
-def loadDriver(cls_driver: object, repositoryName: str, conf: dict) -> Driver:
+def loadDriver(cls_driver: DriverClass, repositoryName: str, conf: dict) -> Driver:
 
     # Build the final end-driver.
     if not issubclass(cls_driver, DriverInterface):

imapfw/types/account.py

@@ -20,11 +20,19 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+from typing import TypeVar, Union
+
 from imapfw import runtime
 from imapfw.types.repository import loadRepository
 
 from .folder import Folders
 
+# Annotations.
+from imapfw.types.repository import Repository
+
+
+AccountClass = TypeVar('Account based class')
+
 
 class AccountInternalInterface(object):
     def fw_getLeft(self):   raise NotImplementedError
@@ -44,23 +52,23 @@ class Account(AccountInterface, AccountInternalInterface):
     left = None
     right = None
 
-    def fw_getSide(self, side: str) -> 'complete repository':
+    def fw_getSide(self, side: str) -> Repository:
         if side == 'left':
             return self.fw_getLeft()
         if side == 'right':
             return self.fw_getRight()
         assert side in ['left', 'right']
 
-    def fw_getLeft(self):
+    def fw_getLeft(self) -> Repository:
         return loadRepository(self.left)
 
-    def fw_getRight(self):
+    def fw_getRight(self) -> Repository:
         return loadRepository(self.right)
 
     def getClassName(self) -> str:
         return self.__class__.__name__
 
-    def init(self):
+    def init(self) -> None:
         """Override this method to make initialization in the rascal."""
 
         pass
@@ -69,7 +77,7 @@ def syncFolders(self, folders: Folders) -> Folders:
         return folders
 
 
-def loadAccount(obj: 'account class or str name') -> 'initialized Account':
+def loadAccount(obj: Union[AccountClass, str]) -> Account:
 
     if isinstance(obj, str):
         obj = runtime.rascal.get(obj, [Account, dict])

imapfw/types/repository.py

@@ -20,10 +20,15 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+from typing import TypeVar, Union
+
 from imapfw.controllers.controller import loadController
 from imapfw.drivers.driver import loadDriver
 
 
+RepositoryClass = TypeVar('Repository based class')
+
+
 class RepositoryInterface(object):
 
     conf = None
@@ -90,7 +95,7 @@ def init(self):
         pass
 
 
-def loadRepository(obj: 'Repository class or dict') -> Repository:
+def loadRepository(obj: Union[RepositoryClass, dict]) -> Repository:
 
     try:
         if issubclass(obj, RepositoryInterface):

requirements.txt

@@ -0,0 +1 @@
+typing; python_version < '3.5'