Skip to content

Commit 13eae8c

Browse files
committed
chore: add async suffix to asynchronous functions
1 parent 88a8e56 commit 13eae8c

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

routes/player_route.py

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
summary="Creates a new Player",
2626
tags=["Players"]
2727
)
28-
async def post(
28+
async def post_async(
2929
player_model: PlayerModel = Body(...),
3030
async_session: AsyncSession = Depends(generate_async_session)
3131
):
@@ -39,10 +39,10 @@ async def post(
3939
Raises:
4040
HTTPException: HTTP 409 Conflict error if the Player already exists.
4141
"""
42-
player = await player_service.retrieve_by_id(async_session, player_model.id)
42+
player = await player_service.retrieve_by_id_async(async_session, player_model.id)
4343
if player:
4444
raise HTTPException(status_code=status.HTTP_409_CONFLICT)
45-
await player_service.create(async_session, player_model)
45+
await player_service.create_async(async_session, player_model)
4646
await FastAPICache.clear()
4747

4848
# GET --------------------------------------------------------------------------
@@ -56,7 +56,7 @@ async def post(
5656
tags=["Players"]
5757
)
5858
@cache(expire=CACHING_TIME_IN_SECONDS)
59-
async def get_all(
59+
async def get_all_async(
6060
async_session: AsyncSession = Depends(generate_async_session)
6161
):
6262
"""
@@ -68,7 +68,7 @@ async def get_all(
6868
Returns:
6969
List[PlayerModel]: A list of Pydantic models representing all players.
7070
"""
71-
players = await player_service.retrieve_all(async_session)
71+
players = await player_service.retrieve_all_async(async_session)
7272
return players
7373

7474

@@ -80,7 +80,7 @@ async def get_all(
8080
tags=["Players"]
8181
)
8282
@cache(expire=CACHING_TIME_IN_SECONDS)
83-
async def get_by_id(
83+
async def get_by_id_async(
8484
player_id: int = Path(..., title="The ID of the Player"),
8585
async_session: AsyncSession = Depends(generate_async_session)
8686
):
@@ -97,7 +97,7 @@ async def get_by_id(
9797
Raises:
9898
HTTPException: Not found error if the Player with the specified ID does not exist.
9999
"""
100-
player = await player_service.retrieve_by_id(async_session, player_id)
100+
player = await player_service.retrieve_by_id_async(async_session, player_id)
101101
if not player:
102102
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
103103
return player
@@ -111,7 +111,7 @@ async def get_by_id(
111111
tags=["Players"]
112112
)
113113
@cache(expire=CACHING_TIME_IN_SECONDS)
114-
async def get_by_squad_number(
114+
async def get_by_squad_number_async(
115115
squad_number: int = Path(..., title="The Squad Number of the Player"),
116116
async_session: AsyncSession = Depends(generate_async_session)
117117
):
@@ -128,7 +128,7 @@ async def get_by_squad_number(
128128
Raises:
129129
HTTPException: HTTP 404 Not Found error if the Player with the specified Squad Number does not exist.
130130
"""
131-
player = await player_service.retrieve_by_squad_number(async_session, squad_number)
131+
player = await player_service.retrieve_by_squad_number_async(async_session, squad_number)
132132
if not player:
133133
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
134134
return player
@@ -142,7 +142,7 @@ async def get_by_squad_number(
142142
summary="Updates an existing Player",
143143
tags=["Players"]
144144
)
145-
async def put(
145+
async def put_async(
146146
player_id: int = Path(..., title="The ID of the Player"),
147147
player_model: PlayerModel = Body(...),
148148
async_session: AsyncSession = Depends(generate_async_session)
@@ -158,10 +158,10 @@ async def put(
158158
Raises:
159159
HTTPException: HTTP 404 Not Found error if the Player with the specified ID does not exist.
160160
"""
161-
player = await player_service.retrieve_by_id(async_session, player_id)
161+
player = await player_service.retrieve_by_id_async(async_session, player_id)
162162
if not player:
163163
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
164-
await player_service.update(async_session, player_model)
164+
await player_service.update_async(async_session, player_model)
165165
await FastAPICache.clear()
166166

167167
# DELETE -----------------------------------------------------------------------
@@ -173,7 +173,7 @@ async def put(
173173
summary="Deletes an existing Player",
174174
tags=["Players"]
175175
)
176-
async def delete(
176+
async def delete_async(
177177
player_id: int = Path(..., title="The ID of the Player"),
178178
async_session: AsyncSession = Depends(generate_async_session)
179179
):
@@ -187,8 +187,8 @@ async def delete(
187187
Raises:
188188
HTTPException: HTTP 404 Not Found error if the Player with the specified ID does not exist.
189189
"""
190-
player = await player_service.retrieve_by_id(async_session, player_id)
190+
player = await player_service.retrieve_by_id_async(async_session, player_id)
191191
if not player:
192192
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
193-
await player_service.delete(async_session, player_id)
193+
await player_service.delete_async(async_session, player_id)
194194
await FastAPICache.clear()

services/player_service.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
# Create -----------------------------------------------------------------------
1212

1313

14-
async def create(async_session: AsyncSession, player_model: PlayerModel):
14+
async def create_async(async_session: AsyncSession, player_model: PlayerModel):
1515
"""
1616
Creates a new Player in the database.
1717
@@ -36,7 +36,7 @@ async def create(async_session: AsyncSession, player_model: PlayerModel):
3636
# Retrieve ---------------------------------------------------------------------
3737

3838

39-
async def retrieve_all(async_session: AsyncSession):
39+
async def retrieve_all_async(async_session: AsyncSession):
4040
"""
4141
Retrieves all the players from the database.
4242
@@ -53,7 +53,7 @@ async def retrieve_all(async_session: AsyncSession):
5353
return players
5454

5555

56-
async def retrieve_by_id(async_session: AsyncSession, player_id: int):
56+
async def retrieve_by_id_async(async_session: AsyncSession, player_id: int):
5757
"""
5858
Retrieves a Player by its ID from the database.
5959
@@ -68,7 +68,7 @@ async def retrieve_by_id(async_session: AsyncSession, player_id: int):
6868
return player
6969

7070

71-
async def retrieve_by_squad_number(async_session: AsyncSession, squad_number: int):
71+
async def retrieve_by_squad_number_async(async_session: AsyncSession, squad_number: int):
7272
"""
7373
Retrieves a Player by its Squad Number from the database.
7474
@@ -87,7 +87,7 @@ async def retrieve_by_squad_number(async_session: AsyncSession, squad_number: in
8787
# Update -----------------------------------------------------------------------
8888

8989

90-
async def update(async_session: AsyncSession, player_model: PlayerModel):
90+
async def update_async(async_session: AsyncSession, player_model: PlayerModel):
9191
"""
9292
Updates (entirely) an existing Player in the database.
9393
@@ -121,7 +121,7 @@ async def update(async_session: AsyncSession, player_model: PlayerModel):
121121
# Delete -----------------------------------------------------------------------
122122

123123

124-
async def delete(async_session: AsyncSession, player_id: int):
124+
async def delete_async(async_session: AsyncSession, player_id: int):
125125
"""
126126
Deletes an existing Player from the database.
127127

0 commit comments

Comments
 (0)