Module torpido.util.validate

Utility function to check if the input file belongs to one of the supported formats and can be processed readily if not we will raise errors

"""
Utility function to check if the input file belongs to one of the supported
formats and can be processed readily if not we will raise errors
"""

import os

from torpido.config import Log
from torpido.config import SUPPORTED_VIDEO_FILES


def checkIfVideo(inputFile):
    """
    Checks if the input file is a video and the file exists.
    Prints error is the file is not a video and processing is not done until
    the input file is a video file of the supported formats defined in the `constants` file

    Parameters
    ----------
    inputFile : str
        input video file

    Returns
    -------
    bool
        True is the input file is a video and it exists in the directory or the path
    """
    if os.path.isfile(inputFile) is False:
        Log.e("Input video file does not exists")
        return False

    extension = os.path.splitext(inputFile)[1]
    if extension in SUPPORTED_VIDEO_FILES:
        return True

    Log.i(f"Supported formats : {SUPPORTED_VIDEO_FILES}")
    return False

Functions

def checkIfVideo(inputFile)

Checks if the input file is a video and the file exists. Prints error is the file is not a video and processing is not done until the input file is a video file of the supported formats defined in the constants file

Parameters

inputFile : str

input video file

Returns

bool

True is the input file is a video and it exists in the directory or the path

Expand source code

def checkIfVideo(inputFile):
    """
    Checks if the input file is a video and the file exists.
    Prints error is the file is not a video and processing is not done until
    the input file is a video file of the supported formats defined in the `constants` file

    Parameters
    ----------
    inputFile : str
        input video file

    Returns
    -------
    bool
        True is the input file is a video and it exists in the directory or the path
    """
    if os.path.isfile(inputFile) is False:
        Log.e("Input video file does not exists")
        return False

    extension = os.path.splitext(inputFile)[1]
    if extension in SUPPORTED_VIDEO_FILES:
        return True

    Log.i(f"Supported formats : {SUPPORTED_VIDEO_FILES}")
    return False