Skip to content

Commit 6b3cade

Browse files
committed
minor changes to make pylint happier
1 parent 792d76e commit 6b3cade

1 file changed

Lines changed: 32 additions & 9 deletions

File tree

app/src/routes/users.py

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,58 @@
1-
from apiflask import APIBlueprint
2-
from flask import g, request
1+
"""
2+
Documentation
3+
"""
34

45
import uuid
56
import schema
67
import datetime
78

9+
from apiflask import APIBlueprint
10+
from flask import g, request
11+
12+
813
users = APIBlueprint(
9-
"users_blueprint",
14+
"users",
1015
__name__,
1116
tag={
1217
"name": "User Management",
13-
"description": "Operations related to management of users (CRUD, Authentication, Authorization)",
18+
"description": "Operations related to management of users (CRUD, Auth)",
1419
},
1520
)
1621

1722

1823
@users.before_request
1924
def assign_request_id():
25+
"""
26+
This function executes before any request.
27+
It creates a request uuid and assigns it in the global namespace variable 'g'.
28+
"""
2029
g.request_id = request.headers.get("X-Request-ID", str(uuid.uuid4()))
2130

2231

2332
@users.after_request
2433
def add_request_id_to_response(response):
34+
"""
35+
This function executes after any request.
36+
It puts the uuid created in the 'g' global variable to the response dictionary.
37+
"""
2538
response.headers["X-Request-ID"] = g.request_id
2639
return response
2740

2841

2942
@users.route("/", methods=["GET"])
3043
@users.output(schema.GenericResponse, status_code=200)
3144
def api_get_users():
32-
pass
45+
"""
46+
Gets all users.
47+
"""
3348

3449

3550
@users.route("/", methods=["POST"])
3651
@users.output(schema.GenericResponse, status_code=200)
3752
def api_post_user():
38-
pass
53+
"""
54+
Create a new user.
55+
"""
3956

4057

4158
@users.route("/token", methods=["POST"])
@@ -77,16 +94,22 @@ def api_post_users_token(json: dict):
7794
@users.route("/<user_id>", methods=["GET"])
7895
@users.output(schema.GenericResponse, status_code=200)
7996
def api_get_user():
80-
pass
97+
"""
98+
Get an existing user.
99+
"""
81100

82101

83102
@users.route("/<user_id>", methods=["PATCH"])
84103
@users.output(schema.GenericResponse, status_code=200)
85104
def api_patch_user():
86-
pass
105+
"""
106+
Update an existing user.
107+
"""
87108

88109

89110
@users.route("/<user_id>", methods=["DELETE"])
90111
@users.output(schema.GenericResponse, status_code=200)
91112
def api_delete_user():
92-
pass
113+
"""
114+
Delete an existing user.
115+
"""

0 commit comments

Comments
 (0)