From 0c0eece972ce89d4d40c911f1947d46b3cbb2d5d Mon Sep 17 00:00:00 2001 From: Cal Corum Date: Sat, 21 Mar 2026 12:33:01 -0500 Subject: [PATCH] feat: add return type annotations to async DB functions (#20) Closes #20 Co-Authored-By: Claude Sonnet 4.6 --- db_calls.py | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/db_calls.py b/db_calls.py index ae3d4a9..4f9d5b0 100644 --- a/db_calls.py +++ b/db_calls.py @@ -1,7 +1,7 @@ import aiohttp import pybaseball as pb -from typing import Literal +from typing import Literal, Optional from exceptions import logger AUTH_TOKEN = {"Authorization": "Bearer Tp3aO3jhYve5NJF1IqOmJTmk"} @@ -25,7 +25,7 @@ def param_char(other_params): def get_req_url( endpoint: str, api_ver: int = 2, object_id: int = None, params: list = None ): - req_url = f'{DB_URL}/v{api_ver}/{endpoint}{"/" if object_id is not None else ""}{object_id if object_id is not None else ""}' + req_url = f"{DB_URL}/v{api_ver}/{endpoint}{'/' if object_id is not None else ''}{object_id if object_id is not None else ''}" if params: other_params = False @@ -39,11 +39,11 @@ def get_req_url( def log_return_value(log_string: str): if master_debug: logger.info( - f'return: {log_string[:1200]}{" [ S N I P P E D ]" if len(log_string) > 1200 else ""}\n' + f"return: {log_string[:1200]}{' [ S N I P P E D ]' if len(log_string) > 1200 else ''}\n" ) else: logger.debug( - f'return: {log_string[:1200]}{" [ S N I P P E D ]" if len(log_string) > 1200 else ""}\n' + f"return: {log_string[:1200]}{' [ S N I P P E D ]' if len(log_string) > 1200 else ''}\n" ) @@ -54,7 +54,7 @@ async def db_get( params: list = None, none_okay: bool = True, timeout: int = 3, -): +) -> Optional[dict]: req_url = get_req_url(endpoint, api_ver=api_ver, object_id=object_id, params=params) log_string = f"get:\n{endpoint} id: {object_id} params: {params}" logger.info(log_string) if master_debug else logger.debug(log_string) @@ -76,7 +76,7 @@ async def db_get( raise ValueError(f"DB: {e}") -async def url_get(url: str, timeout: int = 3): +async def url_get(url: str, timeout: int = 3) -> aiohttp.ClientResponse: log_string = f"get:\n{url}" logger.info(log_string) if master_debug else logger.debug(log_string) @@ -94,7 +94,7 @@ async def url_get(url: str, timeout: int = 3): async def db_patch( endpoint: str, object_id: int, params: list, api_ver: int = 2, timeout: int = 3 -): +) -> dict: req_url = get_req_url(endpoint, api_ver=api_ver, object_id=object_id, params=params) log_string = f"patch:\n{endpoint} {params}" logger.info(log_string) if master_debug else logger.debug(log_string) @@ -113,7 +113,7 @@ async def db_patch( async def db_post( endpoint: str, api_ver: int = 2, payload: dict = None, timeout: int = 3 -): +) -> dict: req_url = get_req_url(endpoint, api_ver=api_ver) log_string = f"post:\n{endpoint} payload: {payload}\ntype: {type(payload)}" logger.info(log_string) if master_debug else logger.debug(log_string) @@ -132,7 +132,7 @@ async def db_post( async def db_put( endpoint: str, api_ver: int = 2, payload: dict = None, timeout: int = 3 -): +) -> dict: req_url = get_req_url(endpoint, api_ver=api_ver) log_string = f"put:\n{endpoint} payload: {payload}\ntype: {type(payload)}" logger.info(log_string) if master_debug else logger.debug(log_string) @@ -149,7 +149,7 @@ async def db_put( raise ValueError(f"DB: {e}") -async def db_delete(endpoint: str, object_id: int, api_ver: int = 2, timeout=3): +async def db_delete(endpoint: str, object_id: int, api_ver: int = 2, timeout=3) -> dict: req_url = get_req_url(endpoint, api_ver=api_ver, object_id=object_id) log_string = f"delete:\n{endpoint} {object_id}" logger.info(log_string) if master_debug else logger.debug(log_string) @@ -183,4 +183,4 @@ def get_player_data( def player_desc(this_player) -> str: if this_player["p_name"] in this_player["description"]: return this_player["description"] - return f'{this_player["description"]} {this_player["p_name"]}' + return f"{this_player['description']} {this_player['p_name']}"