metadata.py

"""
=========================================================
Universal File Converter
Metadata Utilities
=========================================================
"""

from __future__ import annotations

from pathlib import Path

import fitz
import pandas as pd
from PIL import Image
from docx import Document


class FileMetadata:
    """
    Extract metadata from supported files.
    """

    @staticmethod
    def basic(file_path: str | Path) -> dict:

        file = Path(file_path)

        return {
            "Name": file.name,
            "Extension": file.suffix.upper(),
            "Size (KB)": round(
                file.stat().st_size / 1024,
                2,
            ),
        }

    # -------------------------------------------------
    # Images
    # -------------------------------------------------

    @staticmethod
    def image(file_path: str | Path) -> dict:

        image = Image.open(file_path)

        width, height = image.size

        mode = image.mode

        image.close()

        return {
            **FileMetadata.basic(file_path),
            "Width": width,
            "Height": height,
            "Mode": mode,
        }

    # -------------------------------------------------
    # PDF
    # -------------------------------------------------

    @staticmethod
    def pdf(file_path: str | Path) -> dict:

        document = fitz.open(file_path)

        pages = len(document)

        document.close()

        return {
            **FileMetadata.basic(file_path),
            "Pages": pages,
        }

    # -------------------------------------------------
    # TXT
    # -------------------------------------------------

    @staticmethod
    def text(file_path: str | Path) -> dict:

        text = Path(file_path).read_text(
            encoding="utf-8",
            errors="ignore",
        )

        return {
            **FileMetadata.basic(file_path),
            "Characters": len(text),
            "Lines": len(text.splitlines()),
        }

    # -------------------------------------------------
    # DOCX
    # -------------------------------------------------

    @staticmethod
    def docx(file_path: str | Path) -> dict:
        """
        Return DOCX metadata.
        """

        document = Document(file_path)

        paragraphs = [
            paragraph.text
            for paragraph in document.paragraphs
            if paragraph.text.strip()
        ]

        return {
            **FileMetadata.basic(file_path),
            "Paragraphs": len(paragraphs),
        }

    # -------------------------------------------------
    # CSV
    # -------------------------------------------------

    @staticmethod
    def csv(file_path: str | Path) -> dict:
        """
        Return CSV metadata.
        """

        dataframe = pd.read_csv(file_path)

        return {
            **FileMetadata.basic(file_path),
            "Rows": len(dataframe),
            "Columns": len(dataframe.columns),
        }

    # -------------------------------------------------
    # XLSX
    # -------------------------------------------------

    @staticmethod
    def xlsx(file_path: str | Path) -> dict:
        """
        Return XLSX metadata.
        """

        dataframe = pd.read_excel(file_path)

        return {
            **FileMetadata.basic(file_path),
            "Rows": len(dataframe),
            "Columns": len(dataframe.columns),
        }

    # -------------------------------------------------
    # JSON
    # -------------------------------------------------

    @staticmethod
    def json(file_path: str | Path) -> dict:
        """
        Return JSON metadata.
        """

        import json

        with open(
            file_path,
            "r",
            encoding="utf-8",
        ) as file:

            data = json.load(file)

        if isinstance(data, list):
            records = len(data)
        elif isinstance(data, dict):
            records = len(data.keys())
        else:
            records = 1

        return {
            **FileMetadata.basic(file_path),
            "Records": records,
        }

    # -------------------------------------------------
    # XML
    # -------------------------------------------------

    @staticmethod
    def xml(file_path: str | Path) -> dict:
        """
        Return XML metadata.
        """

        import xml.etree.ElementTree as ET

        tree = ET.parse(file_path)
        root = tree.getroot()

        return {
            **FileMetadata.basic(file_path),
            "Root": root.tag,
            "Children": len(root),
        }

    # -------------------------------------------------
    # Automatic Detection
    # -------------------------------------------------

    @staticmethod
    def get_metadata(file_path: str | Path) -> dict:
        """
        Automatically return metadata based on file type.
        """

        extension = Path(file_path).suffix.lower()

        if extension in {
            ".jpg",
            ".jpeg",
            ".png",
            ".bmp",
            ".webp",
            ".tiff",
        }:
            return FileMetadata.image(file_path)

        if extension == ".pdf":
            return FileMetadata.pdf(file_path)

        if extension == ".txt":
            return FileMetadata.text(file_path)

        if extension == ".docx":
            return FileMetadata.docx(file_path)

        if extension == ".csv":
            return FileMetadata.csv(file_path)

        if extension == ".xlsx":
            return FileMetadata.xlsx(file_path)

        if extension == ".json":
            return FileMetadata.json(file_path)

        if extension == ".xml":
            return FileMetadata.xml(file_path)

        return FileMetadata.basic(file_path)