updates

Backend/venv/lib/python3.12/site-packages/safety/scan/finder/handlers.py

@@ -0,0 +1,122 @@
+from abc import ABC, abstractmethod
+import os
+from pathlib import Path
+from types import MappingProxyType
+from typing import Dict, List, Optional, Optional, Tuple
+
+from safety_schemas.models import Ecosystem, FileType
+
+
+NOT_IMPLEMENTED = "You should implement this."
+
+class FileHandler(ABC):
+    """
+    Abstract base class for file handlers that define how to handle specific types of files
+    within an ecosystem.
+    """
+
+    def __init__(self) -> None:
+        self.ecosystem: Optional[Ecosystem] = None
+
+    def can_handle(self, root: str, file_name: str, include_files: Dict[FileType, List[Path]]) -> Optional[FileType]:
+        """
+        Determines if the handler can handle the given file based on its type and inclusion criteria.
+
+        Args:
+            root (str): The root directory of the file.
+            file_name (str): The name of the file.
+            include_files (Dict[FileType, List[Path]]): Dictionary of file types and their paths to include.
+
+        Returns:
+            Optional[FileType]: The type of the file if it can be handled, otherwise None.
+        """
+        # Keeping it simple for now
+
+        if not self.ecosystem:
+            return None
+
+        for f_type in self.ecosystem.file_types:
+            if f_type in include_files:
+                current = Path(root, file_name).resolve()
+                paths = [p.resolve() if p.is_absolute() else (root / p).resolve() for p in include_files[f_type]]
+                if current in paths:
+                    return f_type
+
+            # Let's compare by name only for now
+            # We can put heavier logic here, but for speed reasons,
+            # right now is very basic, we will improve this later.
+            # Custom matching per File Type
+            if file_name.lower().endswith(f_type.value.lower()):
+                return f_type
+
+        return None
+
+    @abstractmethod
+    def download_required_assets(self, session) -> Dict[str, str]:
+        """
+        Abstract method to download required assets for handling files. Should be implemented
+        by subclasses.
+
+        Args:
+            session: The session object for making network requests.
+
+        Returns:
+            Dict[str, str]: A dictionary of downloaded assets.
+        """
+        return NotImplementedError(NOT_IMPLEMENTED)
+
+
+class PythonFileHandler(FileHandler):
+    """
+    Handler for Python files within the Python ecosystem.
+    """
+    # Example of a Python File Handler
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.ecosystem = Ecosystem.PYTHON
+
+    def download_required_assets(self, session) -> None:
+        """
+        Downloads the required assets for handling Python files, specifically the Safety database.
+
+        Args:
+            session: The session object for making network requests.
+        """
+        from safety.safety import fetch_database
+
+        SAFETY_DB_DIR = os.getenv("SAFETY_DB_DIR")
+
+        db = False if SAFETY_DB_DIR is None else SAFETY_DB_DIR
+
+        # Fetch both the full and partial Safety databases
+        fetch_database(session=session, full=False, db=db, cached=True,
+                       telemetry=True, ecosystem=Ecosystem.PYTHON,
+                       from_cache=False)
+
+        fetch_database(session=session, full=True, db=db, cached=True,
+                                telemetry=True, ecosystem=Ecosystem.PYTHON,
+                                from_cache=False)
+
+
+class SafetyProjectFileHandler(FileHandler):
+    """
+    Handler for Safety project files within the Safety project ecosystem.
+    """
+    # Example of a Python File Handler
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.ecosystem = Ecosystem.SAFETY_PROJECT
+
+    def download_required_assets(self, session) -> None:
+        """
+        No required assets to download for Safety project files.
+        """
+        pass
+
+# Mapping of ecosystems to their corresponding file handlers
+ECOSYSTEM_HANDLER_MAPPING = MappingProxyType({
+    Ecosystem.PYTHON: PythonFileHandler,
+    Ecosystem.SAFETY_PROJECT: SafetyProjectFileHandler,
+})