Source code for describe.utils

import json
import os
from typing import List

from cicada.common.utils import load_config




def get_images_from_folder(folder_path: str) -> List[str]:
    """Get all image files from the specified folder."""
    valid_extensions = [".jpg", ".jpeg", ".png", ".bmp", ".gif"]
    images = [
        os.path.join(folder_path, f)
        for f in os.listdir(folder_path)
        if os.path.splitext(f)[1].lower() in valid_extensions
    ]
    return images





def save_descriptions(base_dirs: str | List[str], descriptions: dict | List[dict]):

    if not isinstance(base_dirs, list):
        base_dirs = [base_dirs]
    if not isinstance(descriptions, list):
        descriptions = [descriptions]

    assert len(base_dirs) == len(
        descriptions
    ), "Number of base paths and descriptions do not match"

    for directory, desc in zip(base_dirs, descriptions):
        metadata = {}
        metadata_path = os.path.join(directory, "metadata.json")
        if os.path.exists(metadata_path):
            metadata = load_config(metadata_path)

        # extend metadata.json with the new descriptions
        metadata.update(desc)

        with open(metadata_path, "w") as file:
            json.dump(metadata, file, indent=4)





def load_object_metadata(task_path: str) -> List[dict]:
    if os.path.isdir(task_path):
        directory = task_path
        image_metadata = {
            "object_id": os.path.basename(directory),
            "object_description": "",
            "base_path": directory,
            "images": [],
        }
        for file in os.listdir(directory):
            if file.lower().endswith((".png", ".jpg", ".jpeg")):
                pre_description = (
                    file.split(".")[0].replace("-", " ").replace("_", " ").strip()
                )
                image_metadata["images"].append(
                    {"image_path": file, "pre_description": pre_description}
                )
        return [image_metadata]
    else:
        return load_config(task_path)