better role lib : typing + indent

tracim/lib/core/userworkspace.py

@@ -7,7 +7,8 @@ from tracim.models.context_models import UserRoleWorkspaceInContext
 __author__ = 'damien'
 
 from sqlalchemy.orm import Session
-from tracim.models.auth import User, Group
+from sqlalchemy.orm import Query
+from tracim.models.auth import User
 from tracim.models.data import Workspace
 from tracim.models.data import UserRoleInWorkspace
 from tracim.models.data import RoleType
@@ -73,15 +74,17 @@ class RoleApi(object):
 
         return role
 
-    def __init__(self,
-                 session: Session,
-                 current_user: typing.Optional[User],
-                 config: CFG):
+    def __init__(
+        self,
+        session: Session,
+        current_user: typing.Optional[User],
+        config: CFG,
+    )-> None:
         self._session = session
         self._user = current_user
         self._config = config
 
-    def _get_one_rsc(self, user_id, workspace_id):
+    def _get_one_rsc(self, user_id: int, workspace_id: int) -> Query:
         """
         :param user_id:
         :param workspace_id:
@@ -91,16 +94,16 @@ class RoleApi(object):
             filter(UserRoleInWorkspace.workspace_id == workspace_id).\
             filter(UserRoleInWorkspace.user_id == user_id)
 
-    def get_one(self, user_id, workspace_id):
+    def get_one(self, user_id: int, workspace_id: int) -> UserRoleInWorkspace:
         return self._get_one_rsc(user_id, workspace_id).one()
 
     def create_one(
-            self,
-            user: User,
-            workspace: Workspace,
-            role_level: int,
-            with_notif: bool,
-            flush: bool=True
+        self,
+        user: User,
+        workspace: Workspace,
+        role_level: int,
+        with_notif: bool,
+        flush: bool=True
     ) -> UserRoleInWorkspace:
         role = self.create_role()
         role.user_id = user.user_id
@@ -111,34 +114,38 @@ class RoleApi(object):
             self._session.flush()
         return role
 
-    def delete_one(self, user_id, workspace_id, flush=True):
+    def delete_one(self, user_id: int, workspace_id: int, flush=True) -> None:
         self._get_one_rsc(user_id, workspace_id).delete()
         if flush:
             self._session.flush()
 
-    def _get_all_for_user(self, user_id):
+    def _get_all_for_user(self, user_id) -> typing.List[UserRoleInWorkspace]:
         return self._session.query(UserRoleInWorkspace)\
             .filter(UserRoleInWorkspace.user_id == user_id)
 
-    def get_all_for_user(self, user: User):
+    def get_all_for_user(self, user: User) -> typing.List[UserRoleInWorkspace]:
         return self._get_all_for_user(user.user_id).all()
 
     def get_all_for_user_order_by_workspace(
-            self,
-            user_id: int
-    ) -> UserRoleInWorkspace:
+        self,
+        user_id: int
+    ) -> typing.List[UserRoleInWorkspace]:
         return self._get_all_for_user(user_id)\
             .join(UserRoleInWorkspace.workspace).order_by(Workspace.label).all()
 
-    def get_all_for_workspace(self, workspace:Workspace):
+    def get_all_for_workspace(
+        self,
+        workspace:Workspace
+    ) -> typing.List[UserRoleInWorkspace]:
         return self._session.query(UserRoleInWorkspace)\
             .filter(UserRoleInWorkspace.workspace_id == workspace.workspace_id).all()  # nopep8
 
-    def save(self, role: UserRoleInWorkspace):
+    def save(self, role: UserRoleInWorkspace) -> None:
         self._session.flush()
 
+    # TODO - G.M - 07-06-2018 - [Cleanup] Check if this method is already needed
     @classmethod
-    def get_roles_for_select_field(cls):
+    def get_roles_for_select_field(cls) -> typing.List[RoleType]:
         """
 
         :return: list of DictLikeClass instances representing available Roles