mrtoth/test-tutorial-framework
1
0
Fork 0
mirror of https://github.com/avatao-content/test-tutorial-framework synced 2024-11-14 22:17:18 +00:00
Code Issues Releases Wiki Activity

Add docstrings to webservice UserOps class

Browse Source
This commit is contained in:
Kristóf Tóth 2018-04-28 19:24:15 +02:00
parent 0e83c31587
commit 9ec0132e06
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
solvable/src/webservice/user_ops.py
View File

@ -9,6 +9,13 @@ class UserOps:
self.password = password self.password = password
def authenticate(self): def authenticate(self):
"""
Attempts to authenticate the user.
Raises an exception on failure, does nothing on success.
:raises InvalidCredentialsError:
User does not exist or password provided is invalid
"""
with Session() as db: with Session() as db:
user = db.query(User).filter(User.username == self.username).first() user = db.query(User).filter(User.username == self.username).first()
@ -17,6 +24,13 @@ class UserOps:
raise InvalidCredentialsError raise InvalidCredentialsError
def register(self): def register(self):
"""
Attempts to register a user.
Raises an exception of failure, does nothing on success.
:raises UserExistsError:
A user with the provided username already exists
"""
with Session() as db: with Session() as db:
if db.query(User).filter(User.username == self.username).all(): if db.query(User).filter(User.username == self.username).all():