fixing DQ issues

app/services/stock_service.py

@@ -1,6 +1,15 @@
+# app/services/stock_service.py
+"""Summary description ....
+
+This module provides classes and functions for:
+- ....
+- ....
+- ....
+"""
+
 import logging
 from datetime import datetime
-from typing import List, Optional, Tuple
+from typing import List, Optional
 
 from sqlalchemy.orm import Session
 
@@ -13,15 +22,17 @@ logger = logging.getLogger(__name__)
 
 
 class StockService:
+    """Service class for stock operations following the application's service pattern."""
     def __init__(self):
+        """Class constructor."""
         self.gtin_processor = GTINProcessor()
 
     def normalize_gtin(self, gtin_value) -> Optional[str]:
-        """Normalize GTIN format using the GTINProcessor"""
+        """Normalize GTIN format using the GTINProcessor."""
         return self.gtin_processor.normalize(gtin_value)
 
     def set_stock(self, db: Session, stock_data: StockCreate) -> Stock:
-        """Set exact stock quantity for a GTIN at a specific location (replaces existing quantity)"""
+        """Set exact stock quantity for a GTIN at a specific location (replaces existing quantity)."""
         normalized_gtin = self.normalize_gtin(stock_data.gtin)
         if not normalized_gtin:
             raise ValueError("Invalid GTIN format")
@@ -60,7 +71,7 @@ class StockService:
             return new_stock
 
     def add_stock(self, db: Session, stock_data: StockAdd) -> Stock:
-        """Add quantity to existing stock for a GTIN at a specific location (adds to existing quantity)"""
+        """Add quantity to existing stock for a GTIN at a specific location (adds to existing quantity)."""
         normalized_gtin = self.normalize_gtin(stock_data.gtin)
         if not normalized_gtin:
             raise ValueError("Invalid GTIN format")
@@ -82,7 +93,8 @@ class StockService:
             db.commit()
             db.refresh(existing_stock)
             logger.info(
-                f"Added stock for GTIN {normalized_gtin} at {location}: {old_quantity} + {stock_data.quantity} = {existing_stock.quantity}"
+                f"Added stock for GTIN {normalized_gtin} at {location}: "
+                f"{old_quantity} + {stock_data.quantity} = {existing_stock.quantity}"
             )
             return existing_stock
         else:
@@ -99,7 +111,7 @@ class StockService:
             return new_stock
 
     def remove_stock(self, db: Session, stock_data: StockAdd) -> Stock:
-        """Remove quantity from existing stock for a GTIN at a specific location"""
+        """Remove quantity from existing stock for a GTIN at a specific location."""
         normalized_gtin = self.normalize_gtin(stock_data.gtin)
         if not normalized_gtin:
             raise ValueError("Invalid GTIN format")
@@ -131,12 +143,13 @@ class StockService:
         db.commit()
         db.refresh(existing_stock)
         logger.info(
-            f"Removed stock for GTIN {normalized_gtin} at {location}: {old_quantity} - {stock_data.quantity} = {existing_stock.quantity}"
+            f"Removed stock for GTIN {normalized_gtin} at {location}: "
+            f"{old_quantity} - {stock_data.quantity} = {existing_stock.quantity}"
         )
         return existing_stock
 
     def get_stock_by_gtin(self, db: Session, gtin: str) -> StockSummaryResponse:
-        """Get all stock locations and total quantity for a specific GTIN"""
+        """Get all stock locations and total quantity for a specific GTIN."""
         normalized_gtin = self.normalize_gtin(gtin)
         if not normalized_gtin:
             raise ValueError("Invalid GTIN format")
@@ -169,7 +182,7 @@ class StockService:
         )
 
     def get_total_stock(self, db: Session, gtin: str) -> dict:
-        """Get total quantity in stock for a specific GTIN"""
+        """Get total quantity in stock for a specific GTIN."""
         normalized_gtin = self.normalize_gtin(gtin)
         if not normalized_gtin:
             raise ValueError("Invalid GTIN format")
@@ -196,7 +209,7 @@ class StockService:
         location: Optional[str] = None,
         gtin: Optional[str] = None,
     ) -> List[Stock]:
-        """Get all stock entries with optional filtering"""
+        """Get all stock entries with optional filtering."""
         query = db.query(Stock)
 
         if location:
@@ -212,7 +225,7 @@ class StockService:
     def update_stock(
         self, db: Session, stock_id: int, stock_update: StockUpdate
     ) -> Stock:
-        """Update stock quantity for a specific stock entry"""
+        """Update stock quantity for a specific stock entry."""
         stock_entry = db.query(Stock).filter(Stock.id == stock_id).first()
         if not stock_entry:
             raise ValueError("Stock entry not found")
@@ -228,7 +241,7 @@ class StockService:
         return stock_entry
 
     def delete_stock(self, db: Session, stock_id: int) -> bool:
-        """Delete a stock entry"""
+        """Delete a stock entry."""
         stock_entry = db.query(Stock).filter(Stock.id == stock_id).first()
         if not stock_entry:
             raise ValueError("Stock entry not found")
@@ -242,7 +255,7 @@ class StockService:
         return True
 
     def get_stock_by_id(self, db: Session, stock_id: int) -> Optional[Stock]:
-        """Get a stock entry by its ID"""
+        """Get a stock entry by its ID."""
         return db.query(Stock).filter(Stock.id == stock_id).first()