scanner.py

import os

from list_validator import is_list_of_special_dicts


def scan_directory(directory_path: str) -> list[dict[str, str]]:
    """
    Scans the given directory (excluding subdirectories) and
    returns list of dictionaries each contains
    file details including name, extension, size, and path.

    Args:
        directory_path (str): The path of the directory to scan.

    Returns:
        list[dict[str, str]]: A list of dictionaries where each dictionary contains details
                               about a file (name, extension, size, path).
    Raises:
        FileNotFoundError: If the given directory path does not exist.
        IsADirectoryError: If the given path is not a directory.

    """
    # Check if the given directory exists.
    if not os.path.exists(directory_path):
        raise FileNotFoundError(f"The directory '{directory_path}' does not exist.")

    # Check if the path is actually a directory.
    if not os.path.isdir(directory_path):
        raise IsADirectoryError(f"The path '{directory_path}' is not a directory.")

    # Initialize an empty list to store details about each file in the directory.
    scan_results = []

    # Iterate over each item in the folder
    for file in os.listdir(directory_path):

        # Get the full file path by joining the folder path and file name
        file_path = os.path.join(directory_path, file)

        # Process only files (ignore subdirectories)
        if os.path.isfile(file_path):
            try:
                # Attempt to get the file size in bytes
                size = os.path.getsize(file_path)
            except Exception as e:
                # If an error occurs while getting file size, print the error and set size to 0
                print(f"Error getting size for {file}: {e}")
                size = 0

            name, extension = os.path.splitext(file)  # Extract the file name and extension.

            # Append the file details as dictionary to the scan_results list
            scan_results.append({
                "name": name,
                "extension": extension[1:].lower(),  # Save it Without dot '.'
                "size": size,
                "path": file_path
            })

    # Return file details as list of dictionaries
    return scan_results


def display_scan_results(scan_results: list[dict[str, str]]) -> None:
    """
    Displays the results of the directory last scan: (file name, extension, size in bytes, and path).

    Args:
        scan_results (list[dict]): List of dictionaries containing file details to display

    Returns: None

    Raises:
        TypeError: If 'scan_results' is not a list of dictionaries with required keys.
        ValueError: If there are no files in the last scan.
    """

    # Validates 'scanned_files' is a list of dictionaries with required keys.
    if not is_list_of_special_dicts(scan_results):
        raise TypeError("'scan_results' must be a list of dictionaries with required keys.")

    # If there are no files in the last scan, raise an exception.
    if not scan_results:
        raise ValueError("The Directory does not contain any files to analyze.")

    # Print a header for the scanned directory.
    print(f"\n✅ Scan Result:")
    print("=" * 60)
    print(f"{'File Name': <13} {'Extension': <12} {'Size(bytes)': <13} Full Path")
    print("=" * 60)

    # Iterate over each file and print its details.
    for file in scan_results:
        print(f"{file['name']: <15} {file['extension']: <10} {file['size']: <2} {'bytes':<8}  {file['path']}")

    # Print a footer for the scanned directory.
    print("=" * 60)