Updated docstring and use Annotation for some methods

Author: nb-programmer

sample_fastapi/app/resources/calculator/services.py

@@ -4,11 +4,17 @@ def __init__(self):
         pass
 
     def dec2hex(self, value: int) -> str:
-        """Convert integer to hexadecimal string with '0x' prefix"""
+        """Convert integer to hexadecimal string with '0x' prefix.
+
+        :param int value: Integer value to convert (can be negative, zero and positive)
+        :return str: The converted hexadecimal with '0x' prefix
+        """
         return hex(value)
 
     def hex2dec(self, value: str) -> int:
         """Convert hexadecimal string (with or without prefix) into integer.
 
-        Raises `ValueError` for incorrect input"""
+        :param str value: Hexadecimal value to convert
+        :return int: The converted integer if `value` is a valid hexadecimal string
+        :raises ValueError: Raised for incorrect input"""
         return int(value, 16)

sample_fastapi/app/resources/calculator/views.py

@@ -1,17 +1,23 @@
+from typing import Annotated
+
 from fastapi import Depends, HTTPException, status
 
 from .models import ConversionDecResponse, ConversionHexResponse
 from .services import ConverterService
 
 
-async def conv_dec2hex(value: int, converter: ConverterService = Depends(ConverterService)) -> ConversionHexResponse:
+async def conv_dec2hex(
+    value: int, converter: Annotated[ConverterService, Depends(ConverterService)]
+) -> ConversionHexResponse:
     """Convert integer input into hexadecimal string"""
     return ConversionHexResponse(
         value=converter.dec2hex(value),
     )
 
 
-async def conv_hex2dec(value: str, converter: ConverterService = Depends(ConverterService)) -> ConversionDecResponse:
+async def conv_hex2dec(
+    value: str, converter: Annotated[ConverterService, Depends(ConverterService)]
+) -> ConversionDecResponse:
     """Convert hexadecimal string input into integer"""
     try:
         return ConversionDecResponse(

sample_fastapi/app/resources/hello/views.py

@@ -1,3 +1,5 @@
+from typing import Annotated
+
 from fastapi import Query
 
 from .models import HelloMessage
@@ -8,6 +10,6 @@ async def respond_hello() -> HelloMessage:
     return HelloMessage(message="Hello, World!")
 
 
-async def respond_name_greet(name: str = Query()) -> HelloMessage:
+async def respond_name_greet(name: Annotated[str, Query()]) -> HelloMessage:
     """Respond with "Hello, <name>!" message in a JSON"""
     return HelloMessage(message=f"Hello, {name}!")