From 8926ad682ce0f2db8b686eb8d08f156ad5d92bd6 Mon Sep 17 00:00:00 2001 From: Emmanuel Oyewobi Date: Mon, 4 Sep 2023 01:09:37 +0100 Subject: [PATCH 1/6] pylint changes --- models.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/models.py b/models.py index ed8c634..5f019e9 100644 --- a/models.py +++ b/models.py @@ -1,17 +1,17 @@ from typing import Optional, List from uuid import UUID, uuid4 -from pydantic import BaseModel from enum import Enum +from pydantic import BaseModel class Gender(str, Enum): - male = "male" - female = "female" + MALE = "male" + FEMALE = "female" class Role(str, Enum): - admin = "admin" - user = "user" + ADMIN = "admin" + USER = "user" class User(BaseModel): From ab1d33a0f3ec5f67ba88dcae6bb65b6f8502cc4b Mon Sep 17 00:00:00 2001 From: Emmanuel Oyewobi Date: Mon, 4 Sep 2023 01:13:41 +0100 Subject: [PATCH 2/6] pylint changes --- main.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/main.py b/main.py index 259f93c..901fd27 100644 --- a/main.py +++ b/main.py @@ -10,14 +10,14 @@ User(id=uuid4(), first_name="Mila", last_name="Py", - gender=Gender.female, - roles=[Role.user] + gender=Gender.FEMALE, + roles=[Role.USER] ), User(id=uuid4(), first_name="James", last_name="Jones", - gender=Gender.male, - roles=[Role.admin] + gender=Gender.MALE, + roles=[Role.ADMIN] ) ] From 8182e6833a1328595b4ed7ba88f5e280f6ae84ce Mon Sep 17 00:00:00 2001 From: Emmanuel Oyewobi Date: Mon, 4 Sep 2023 01:37:47 +0100 Subject: [PATCH 3/6] pylint changes --- main.py | 36 +++++++++++++++++++++++++++++++++++- models.py | 12 ++++++++++++ 2 files changed, 47 insertions(+), 1 deletion(-) diff --git a/main.py b/main.py index 901fd27..68566d8 100644 --- a/main.py +++ b/main.py @@ -24,22 +24,41 @@ @app.get('/') async def root(): + """ + set the root page message for the api + :return: + """ return {'example': 'this is an example', 'data': 100} @app.get('/api/v1/users') async def fetch_users(): + """ + function to return all users in db + :return: + """ return db @app.post('/api/v1/users') async def register_users(user: User): + """ + function to add users using the api + :param user: + :return: + """ db.append(user) return {"id": user.id} @app.put('/api/v1/users/{user_id}') async def update_users(user_update: ChangeUser,user_id: UUID): + """ + function to update user information using the api + :param user_update: + :param user_id: + :return: + """ for user in db: if user_id == user.id: if user_update.first_name is not None: @@ -57,7 +76,13 @@ async def update_users(user_update: ChangeUser,user_id: UUID): @app.delete('/api/v1/users/{user_id}') async def delete_user(user_id: UUID): - for user in db: + """ + function to delete users using the api + :param user_id: + :return: + """ + users = db.copy() + for user in users: if user.id == user_id: db.remove(user) return f"{user_id} has been removed" @@ -69,11 +94,20 @@ async def delete_user(user_id: UUID): @app.get('/api/v1/random') async def get_random(): + """ + function to obtain random numbers using api + :return: + """ random_n:int = random.randint(0,100) return {'number':random_n, 'limit': 100} @app.get('/api/v1/random/{limit}') async def get_random_limit(limit:int): + """ + function to get random number and set limit using api + :param limit: + :return: + """ random_n:int = random.randint(0,limit) return {'number':random_n, 'limit': limit} diff --git a/models.py b/models.py index 5f019e9..849c78c 100644 --- a/models.py +++ b/models.py @@ -5,16 +5,25 @@ class Gender(str, Enum): + """ + class for gender api model + """ MALE = "male" FEMALE = "female" class Role(str, Enum): + """ + class for roles in api model + """ ADMIN = "admin" USER = "user" class User(BaseModel): + """ + class for user fields in api + """ id: Optional[UUID] = uuid4() first_name: str last_name: str @@ -23,6 +32,9 @@ class User(BaseModel): class ChangeUser(BaseModel): + """ + class to update user fields in api + """ first_name: Optional[str] last_name: Optional[str] roles: Optional[List[Role]] From 12e2bba2426fe9d3292f03de0e3b5529111e0606 Mon Sep 17 00:00:00 2001 From: Emmanuel Oyewobi Date: Mon, 4 Sep 2023 01:49:03 +0100 Subject: [PATCH 4/6] pylint changes --- main.py | 1 - 1 file changed, 1 deletion(-) diff --git a/main.py b/main.py index 68566d8..94f6b91 100644 --- a/main.py +++ b/main.py @@ -26,7 +26,6 @@ async def root(): """ set the root page message for the api - :return: """ return {'example': 'this is an example', 'data': 100} From 5bec95c8d6a2d2987620d05cf23119b2cc94ba28 Mon Sep 17 00:00:00 2001 From: Emmanuel Oyewobi Date: Mon, 4 Sep 2023 01:51:47 +0100 Subject: [PATCH 5/6] pylint changes --- main.py | 1 + 1 file changed, 1 insertion(+) diff --git a/main.py b/main.py index 94f6b91..68566d8 100644 --- a/main.py +++ b/main.py @@ -26,6 +26,7 @@ async def root(): """ set the root page message for the api + :return: """ return {'example': 'this is an example', 'data': 100} From 5e6da355e660f52f4586455c568f2026f8ed3a01 Mon Sep 17 00:00:00 2001 From: Emmanuel Oyewobi Date: Thu, 7 Sep 2023 00:22:42 +0100 Subject: [PATCH 6/6] pylint changes --- main.py | 1 - 1 file changed, 1 deletion(-) diff --git a/main.py b/main.py index 68566d8..94f6b91 100644 --- a/main.py +++ b/main.py @@ -26,7 +26,6 @@ async def root(): """ set the root page message for the api - :return: """ return {'example': 'this is an example', 'data': 100}