mime_base ¶

def __call__(self, file_type: str | FileType) -> FileTypeIndexWithType:
    """
    Instantiate FileType.INDEX with its own sub-FileType.
    """
    ...

def is_index(self) -> TypeGuard[FileTypeIndexWithType]:  # type: ignore
    """
    Verify whether the FileType is an INDEX that holds its own FileType (e.g. mime: index/video).
    """

    return self in {FileType.INDEX, FileType.INDEX_AUDIO, FileType.INDEX_VIDEO}  # type: ignore

@inject_self.with_args(AUTO)
def parse(
    self, path: FilePathType, *, func: FuncExceptT | None = None, force_ffprobe: bool | None = None
) -> ParsedFile:
    """
    Parse infos from a file. If the FileType is different than AUTO, this function will throw if the file
    is a different FileType than what this method was called on.

    Args:
        path: Path of the file to be parsed.
        func: Function returned for custom error handling. This should only be set by VS package developers.
    :force_ffprobe:     Only rely on ffprobe to parse the file info.

    Returns:
        ParsedFile object, holding the file's info.
    """

    from .ffprobe import FFProbe, FFProbeStream

    filename = Path(str(path)).absolute()

    file_type: FileType | None = None
    mime: str | None = None
    ext: str | None = None

    header = None if force_ffprobe else FileSignatures.parse(filename)

    if header is not None:
        file_type = FileType(header.file_type)
        mime = header.mime
        ext = f".{header.ext}"
    else:
        stream: FFProbeStream | None = None
        ffprobe = FFProbe(func=func)

        try:
            stream = ffprobe.get_stream(filename, FileType.VIDEO)

            if stream is None:
                stream = ffprobe.get_stream(filename, FileType.AUDIO)

            if not stream:
                raise CustomRuntimeError(f"No usable video/audio stream found in {filename}", func)

            file_type = FileType(stream.codec_type)
            mime = f"{file_type.value}/{stream.codec_name}"
        except Exception as e:
            if force_ffprobe:
                raise e
            elif force_ffprobe is None:
                return self.parse(path, force_ffprobe=False)

        if stream is None:
            mime, encoding = guess_mime_type(filename)

            file_type = FileType(mime)

    if ext is None:
        ext = filename.suffix

    encoding = encodings_map.get(filename.suffix, None)

    if not file_type or not mime:
        return ParsedFile(filename, ext, encoding, FileType.OTHER, "file/unknown")

    if self is not FileType.AUTO and self is not file_type:
        raise CustomValueError(
            "FileType mismatch! self is {good}, file is {bad}!", FileType.parse, good=self, bad=file_type
        )

    return ParsedFile(filename, ext, encoding, file_type, mime)

def __call__(self, file_type: str | FileType) -> FileTypeIndexWithType:
    """
    Instantiate FileType.INDEX with its own sub-FileType.
    """
    ...

def is_index(self) -> TypeGuard[FileTypeIndexWithType]:  # type: ignore
    """
    Verify whether the FileType is an INDEX that holds its own FileType (e.g. mime: index/video).
    """

    return self in {FileType.INDEX, FileType.INDEX_AUDIO, FileType.INDEX_VIDEO}  # type: ignore

@inject_self.with_args(AUTO)
def parse(
    self, path: FilePathType, *, func: FuncExceptT | None = None, force_ffprobe: bool | None = None
) -> ParsedFile:
    """
    Parse infos from a file. If the FileType is different than AUTO, this function will throw if the file
    is a different FileType than what this method was called on.

    Args:
        path: Path of the file to be parsed.
        func: Function returned for custom error handling. This should only be set by VS package developers.
    :force_ffprobe:     Only rely on ffprobe to parse the file info.

    Returns:
        ParsedFile object, holding the file's info.
    """

    from .ffprobe import FFProbe, FFProbeStream

    filename = Path(str(path)).absolute()

    file_type: FileType | None = None
    mime: str | None = None
    ext: str | None = None

    header = None if force_ffprobe else FileSignatures.parse(filename)

    if header is not None:
        file_type = FileType(header.file_type)
        mime = header.mime
        ext = f".{header.ext}"
    else:
        stream: FFProbeStream | None = None
        ffprobe = FFProbe(func=func)

        try:
            stream = ffprobe.get_stream(filename, FileType.VIDEO)

            if stream is None:
                stream = ffprobe.get_stream(filename, FileType.AUDIO)

            if not stream:
                raise CustomRuntimeError(f"No usable video/audio stream found in {filename}", func)

            file_type = FileType(stream.codec_type)
            mime = f"{file_type.value}/{stream.codec_name}"
        except Exception as e:
            if force_ffprobe:
                raise e
            elif force_ffprobe is None:
                return self.parse(path, force_ffprobe=False)

        if stream is None:
            mime, encoding = guess_mime_type(filename)

            file_type = FileType(mime)

    if ext is None:
        ext = filename.suffix

    encoding = encodings_map.get(filename.suffix, None)

    if not file_type or not mime:
        return ParsedFile(filename, ext, encoding, FileType.OTHER, "file/unknown")

    if self is not FileType.AUTO and self is not file_type:
        raise CustomValueError(
            "FileType mismatch! self is {good}, file is {bad}!", FileType.parse, good=self, bad=file_type
        )

    return ParsedFile(filename, ext, encoding, file_type, mime)