Added docstrings

Fixed typos

Author: nb-programmer

sample_fastapi/app/resources/calculator/models.py

@@ -1,9 +1,11 @@
 from pydantic import BaseModel
 
 
-class ConversioHexResponse(BaseModel):
+class ConversionHexResponse(BaseModel):
+    """Hexadecimal value response"""
     value: str
 
 
-class ConversioDecResponse(BaseModel):
+class ConversionDecResponse(BaseModel):
+    """Integer value response"""
     value: int

sample_fastapi/app/resources/calculator/routes.py

@@ -1,12 +1,12 @@
 from fastapi import APIRouter
 
-from .views import calc_dec2hex, calc_hex2dec
+from .views import conv_dec2hex, conv_hex2dec
 
 
 def init_routes():
     router = APIRouter(prefix="/calculator", tags=["calculator"])
 
-    router.add_api_route("/convert/dec2hex", calc_dec2hex, methods={"POST"})
-    router.add_api_route("/convert/hex2dec", calc_hex2dec, methods={"POST"})
+    router.add_api_route("/convert/dec2hex", conv_dec2hex, methods={"POST"})
+    router.add_api_route("/convert/hex2dec", conv_hex2dec, methods={"POST"})
 
     return router

sample_fastapi/app/resources/calculator/services.py

@@ -1,9 +1,14 @@
 class ConverterService:
+    """Data conversion service"""
     def __init__(self):
         pass
 
     def dec2hex(self, value: int) -> str:
+        """Convert integer to hexadecimal string 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"""
         return int(value, 16)

sample_fastapi/app/resources/calculator/views.py

@@ -1,18 +1,20 @@
 from fastapi import Depends, HTTPException, status
 
-from .models import ConversioDecResponse, ConversioHexResponse
+from .models import ConversionDecResponse, ConversionHexResponse
 from .services import ConverterService
 
 
-async def calc_dec2hex(value: int, converter: ConverterService = Depends(ConverterService)) -> ConversioHexResponse:
-    return ConversioHexResponse(
+async def conv_dec2hex(value: int, converter: ConverterService = Depends(ConverterService)) -> ConversionHexResponse:
+    """Convert integer input into hexadecimal string"""
+    return ConversionHexResponse(
         value=converter.dec2hex(value),
     )
 
 
-async def calc_hex2dec(value: str, converter: ConverterService = Depends(ConverterService)) -> ConversioDecResponse:
+async def conv_hex2dec(value: str, converter: ConverterService = Depends(ConverterService)) -> ConversionDecResponse:
+    """Convert hexadecimal string input into integer"""
     try:
-        return ConversioDecResponse(
+        return ConversionDecResponse(
             value=converter.hex2dec(value),
         )
     except ValueError:

sample_fastapi/app/resources/hello/models.py

@@ -2,4 +2,5 @@
 
 
 class HelloMessage(BaseModel):
+    """Message response to hello request"""
     message: str

sample_fastapi/app/resources/hello/views.py

@@ -4,8 +4,10 @@
 
 
 async def respond_hello() -> HelloMessage:
+    """Respond with "Hello, World!" message in a JSON"""
     return HelloMessage(message="Hello, World!")
 
 
 async def respond_name_greet(name: str = Query()) -> HelloMessage:
+    """Respond with "Hello, <name>!" message in a JSON"""
     return HelloMessage(message=f"Hello, {name}!")