blacklight/platypush
1
0
Fork 0
forked from platypush/platypush
Code Issues Pull requests Projects Releases Packages Wiki Activity

Minor docstring fixes.

Browse source
This commit is contained in:
Fabio Manganiello 2023-10-21 18:08:29 +02:00
parent 8634572c34
commit cd87cc3e43
Signed by: blacklight
GPG key ID: D90FBA7F76362774
1 changed files with 40 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
platypush/plugins/user/__init__.py
View file

@ -24,18 +24,19 @@ class UserPlugin(Plugin):
**kwargs **kwargs
): ):
""" """
Create a user. This action needs to be executed by an already existing user, who needs to authenticate with Create a user. This action needs to be executed by an already existing
their own credentials, unless this is the first user created on the system. user, who needs to authenticate with their own credentials, unless this
is the first user created on the system.
:return: dict. :return:
Format:: .. code-block:: json
{ {
"user_id": int, "user_id": 1,
"username": str, "username": "test-user",
"created_at": str (in ISO format) "created_at": "2020-11-26T22:41:40.550574"
} }
""" """
@ -67,8 +68,10 @@ class UserPlugin(Plugin):
@action @action
def authenticate_user(self, username, password): def authenticate_user(self, username, password):
""" """
Authenticate a user Authenticate a user.
:return: True if the provided username and password are correct, False otherwise
:return: True if the provided username and password are correct, False
otherwise.
""" """
return bool(self.user_manager.authenticate_user(username, password)) return bool(self.user_manager.authenticate_user(username, password))
@ -76,7 +79,8 @@ class UserPlugin(Plugin):
@action @action
def update_password(self, username, old_password, new_password): def update_password(self, username, old_password, new_password):
""" """
Update the password of a user Update the password of a user.
:return: True if the password was successfully updated, false otherwise :return: True if the password was successfully updated, false otherwise
""" """
@ -91,7 +95,7 @@ class UserPlugin(Plugin):
session_token=None, session_token=None,
): ):
""" """
Delete a user Delete a user.
""" """
if not self.user_manager.authenticate_user( if not self.user_manager.authenticate_user(
@ -109,15 +113,19 @@ class UserPlugin(Plugin):
@action @action
def create_session(self, username, password, expires_at=None): def create_session(self, username, password, expires_at=None):
""" """
Create a user session Create a user session.
:return: dict::
{ :return:
"session_token": str,
"user_id": int, .. code-block:: json
"created_at": str (in ISO format),
"expires_at": str (in ISO format), {
} "session_token": "secret",
"user_id": 1,
"username": "test-user",
"created_at": "2020-11-26T22:41:40.550574",
"expires_at": "2020-11-26T22:41:40.550574"
}
""" """
@ -140,16 +148,17 @@ class UserPlugin(Plugin):
@action @action
def authenticate_session(self, session_token): def authenticate_session(self, session_token):
""" """
Authenticate a session by token and return the associated user Authenticate a session by token and return the associated user.
:return: dict.
Format:: :return:
{ .. code-block:: json
"user_id": int,
"username": str, {
"created_at": str (in ISO format) "user_id": 1,
} "username": "test-user",
"created_at": "2020-11-26T22:41:40.550574"
}
""" """
@ -168,7 +177,7 @@ class UserPlugin(Plugin):
@action @action
def delete_session(self, session_token): def delete_session(self, session_token):
""" """
Delete a user session Delete a user session.
""" """
return self.user_manager.delete_user_session(session_token) return self.user_manager.delete_user_session(session_token)
@ -177,6 +186,7 @@ class UserPlugin(Plugin):
def get_users(self) -> List[Dict[str, Any]]: def get_users(self) -> List[Dict[str, Any]]:
""" """
Get the list of registered users. Get the list of registered users.
:return: :return:
.. code-block:: json .. code-block:: json