fix some typing and naming issue related to userlib

tracim/exceptions.py

@@ -89,7 +89,7 @@ class AuthenticationFailed(TracimException):
     pass
 
 
-class BadUserPassword(TracimException):
+class WrongUserPassword(TracimException):
     pass
 
 class UserNotExist(TracimException):

tracim/lib/core/user.py

@@ -4,16 +4,24 @@ import threading
 import transaction
 import typing as typing
 
+from sqlalchemy.orm import Session
+
+from tracim import CFG
 from tracim.models.auth import User
 from sqlalchemy.orm.exc import NoResultFound
-from tracim.exceptions import BadUserPassword, UserNotExist
+from tracim.exceptions import WrongUserPassword, UserNotExist
 from tracim.exceptions import AuthenticationFailed
 from tracim.models.context_models import UserInContext
 
 
 class UserApi(object):
 
-    def __init__(self, current_user: typing.Optional[User], session, config):
+    def __init__(
+            self,
+            current_user: typing.Optional[User],
+            session: Session,
+            config: CFG,
+    ) -> None:
         self._session = session
         self._user = current_user
         self._config = config
@@ -65,7 +73,7 @@ class UserApi(object):
 
     # Check methods
 
-    def user_with_email_exists(self, email: str):
+    def user_with_email_exists(self, email: str) -> bool:
         try:
             self.get_one_by_email(email)
             return True
@@ -86,9 +94,9 @@ class UserApi(object):
             if user.validate_password(password):
                 return user
             else:
-                raise BadUserPassword()
-        except (BadUserPassword, NoResultFound):
-            raise AuthenticationFailed
+                raise WrongUserPassword()
+        except (WrongUserPassword, NoResultFound):
+            raise AuthenticationFailed()
 
     # Actions
 
@@ -99,7 +107,7 @@ class UserApi(object):
             email: str=None,
             do_save=True,
             timezone: str='',
-    ):
+    ) -> None:
         if name is not None:
             user.display_name = name
 

tracim/tests/library/test_user_api.py

@@ -127,20 +127,20 @@ class TestUserApi(DefaultTest):
         assert isinstance(user, User)
         assert user.email == 'admin@admin.admin'
 
-    def test_unit__authenticate_user___err__bad_password(self):
+    def test_unit__authenticate_user___err__wrong_password(self):
         api = UserApi(
             current_user=None,
             session=self.session,
             config=self.config,
         )
         with pytest.raises(AuthenticationFailed):
-            api.authenticate_user('admin@admin.admin', 'bad_password')
+            api.authenticate_user('admin@admin.admin', 'wrong_password')
 
-    def test_unit__authenticate_user___err__bad_user(self):
+    def test_unit__authenticate_user___err__wrong_user(self):
         api = UserApi(
             current_user=None,
             session=self.session,
             config=self.config,
         )
         with pytest.raises(AuthenticationFailed):
-            api.authenticate_user('unknown_user', 'bad_password')
+            api.authenticate_user('unknown_user', 'wrong_password')