cat_attack.file_manipulation

 1import glob
 2import os
 3
 4from openpyxl import load_workbook, Workbook
 5from openpyxl.worksheet.worksheet import Worksheet
 6from openpyxl.utils.exceptions import InvalidFileException
 7
 8from cat_attack.cat_image import download_cat_pic
 9
10SEARCH_URL = "http://api.thecatapi.com/v1/images/search"
11
12
13def find_xlsx_files(folder_path: str) -> list[str]:
14    """
15    Finds all .xlsx files in a given directory and returns a list of found file paths. If the directory path isn't
16    valid or contains no .xlsx files it returns an empty list.
17
18    :param folder_path: path to a directory presumably containing .xlsx files
19    :type folder_path: str
20    :return: a list of found file paths
21    :rtype: list[str]
22    """
23    if not os.path.isdir(folder_path):
24        print(f"Folder path: {folder_path} you provided isn't valid.")
25        return []
26    found_files = glob.glob(folder_path + "/**/*.xlsx", recursive=True)
27
28    if not found_files:
29        print("No .xlsx files found in this folder.")
30        return []
31    else:
32        return found_files
33
34
35def attack_file(file: str, search_params: dict[str, str], ignore_already_attacked: bool = False) -> None:
36    """
37    Adds an "Important" sheet into each file and inserts a random cat image. If
38    ignore_already_attacked is set to True then the function will ignore all the .xlsx files that already have an
39    "Important" sheet. If the file cannot be opened or the image can't be downloaded it prints an error message.
40
41    :param file: file path
42    :type file: str
43    :param search_params: search parameters used to modify the query string in the url
44    :type search_params: dict[str, str]
45    :param ignore_already_attacked: whether a file has already been attacked (has an "Important" sheet), optional
46    :type ignore_already_attacked: bool
47    :return: nothing
48    :rtype: None
49    """
50    try:
51        current_file: Workbook = load_workbook(file)
52    except InvalidFileException:
53        print(f"Failed to open {os.path.basename(file)}.")
54    else:
55        if ignore_already_attacked and "Important" in current_file.sheetnames:
56            print(f"{os.path.basename(file)} has already been attacked 🙀")
57            return
58
59        important_sheet: Worksheet = current_file.create_sheet("Important")
60        cat_image = download_cat_pic(SEARCH_URL, search_params)
61
62        if cat_image is None:
63            print(f"Unable to download a cat image for {os.path.basename(file)}")
64            return
65
66        important_sheet.add_image(cat_image, "A1")
67        current_file.save(file)