functions.py

import os
import re
import datetime

WORKSPACE = "your/workspace/path"  # For example I use /Downloads
FILES = f"{WORKSPACE}/miscellaneous"
DOCS = f"{WORKSPACE}/docs"
IMGS = f"{WORKSPACE}/images"
LOGS_PATH = f"{WORKSPACE}/logs"
SNAPSHOTS = f"{WORKSPACE}/logs/snapshots"
DOC_PATTERN = re.compile(r"[a-z\ ]*(\.pdf|\.txt|\.docx|\.xslx|\.markdown)")
IMG_PATTERN = re.compile(r"[a-z\ ]*(\.jpg|\.png|\.jpeg|\.webp|\.mp4|\.gif|\.svg)")
DOCS_COUNT, IMGS_COUNT, FILES_COUNT = 0, 0, 0


def directories() -> None:
    """
    Creates directories to move all files that will be filtered in workspace
    path.
    """
    if not os.path.exists(LOGS_PATH):
        os.mkdir(LOGS_PATH)

    if not os.path.exists(SNAPSHOTS):
        os.mkdir(SNAPSHOTS)

    if not os.path.exists(FILES):
        os.mkdir(FILES)

    if not os.path.exists(DOCS):
        os.mkdir(DOCS)

    if not os.path.exists(IMGS):
        os.mkdir(IMGS)


def filter() -> None:
    """
    Filter between files and directories using const WORKSPACE value as path
    also this const is used as relative path to make others paths to logs
    and snapshots.
    """
    with os.scandir(WORKSPACE) as files:
        for file in files:
            if file.is_file():
                router(file)


def log() -> str:
    """
    Return logs_file_path
    Use it as destiny for each moves operation file creating a directory for logs
    files and also creating these files, each one has the date when was created.
    """
    logs_file_path: str = f"{LOGS_PATH}/log-{datetime.date.today()}"
    if not os.path.exists(logs_file_path):
        os.system(f"cd {LOGS_PATH} && touch log-{datetime.date.today()}")

    return logs_file_path


def rename_log(file_source: str, file_name: str, logs: str, file_destiny: str) -> None:
    """
    Using os.rename to move files renaming them and then make a log to have a register
    for the files moved and where was moved also adding date and hours when this was.

    Parameters:
        file_source: file's origin path.
        file_name: file's name.
        logs: log's file name.
        file_destiny: path where the file would be moved.
    """
    os.rename(file_source, file_destiny + "/" + file_name)
    os.system(
        f"echo {file_source} moved to {file_destiny} >> {logs} {datetime.datetime.now().strftime('%a %d/%m/%y %H:%M')}"
    )


def router(file) -> None:
    """
    Filter where each file goes using RegExp patterns to know their extension.

    Parameters:
        file: Output from <scandir> function.
    """
    directories()
    log_path: str = log()
    global FILES_COUNT, DOCS_COUNT, IMGS_COUNT

    if re.search(DOC_PATTERN, file.name):
        DOCS_COUNT += 1
        rename_log(file.path, file.name, log_path, DOCS)

    elif re.search(IMG_PATTERN, file.name):
        IMGS_COUNT += 1
        rename_log(file.path, file.name, log_path, IMGS)

    else:
        FILES_COUNT += 1
        rename_log(file.path, file.name, log_path, FILES)


def snapshot() -> None:
    """
    List directories in workspace after the files was moved regarding they extension.
    Then, we can see the state of workspace after to be filtered and cleanned.
    """
    listed_dirs: list[str] = os.listdir(f"{WORKSPACE}")
    date: str = datetime.datetime.now().strftime('%a %d/%m/%y %H:%M')
    os.system(
        f"echo {listed_dirs} {date} >> {SNAPSHOTS}/snapshot-{datetime.date.today()}"
    )


def count() -> None:
    "Count the number of files moved to each directory"
    global FILES_COUNT, DOCS_COUNT, IMGS_COUNT
    print(
        "-------------------\n",
        f"Files: [{FILES_COUNT}]",
        f"Docs: [{DOCS_COUNT}]",
        f"Images: [{IMGS_COUNT}]",
        f"Check detailed logs at {LOGS_PATH}",
        "-------------------\n",
        sep="\n",
    )