83 lines
2.6 KiB
Python
83 lines
2.6 KiB
Python
import os
|
|
from pathlib import Path
|
|
from typing import Dict
|
|
from typing import Optional
|
|
from typing import final
|
|
|
|
from ytdl_sub.entries.base_entry import BaseEntry
|
|
from ytdl_sub.entries.variables.entry_variables import EntryVariables
|
|
|
|
|
|
class Entry(EntryVariables, BaseEntry):
|
|
"""
|
|
Entry object to represent a single media object returned from yt-dlp.
|
|
"""
|
|
|
|
# The ytdl extractor type that the entry represents
|
|
entry_extractor: str
|
|
|
|
def get_download_file_name(self) -> str:
|
|
"""
|
|
Returns
|
|
-------
|
|
The entry's file name
|
|
"""
|
|
return f"{self.uid}.{self.ext}"
|
|
|
|
def get_download_file_path(self) -> str:
|
|
"""Returns the entry's file path to where it was downloaded"""
|
|
return str(Path(self.working_directory()) / self.get_download_file_name())
|
|
|
|
def get_download_thumbnail_name(self) -> str:
|
|
"""
|
|
Returns
|
|
-------
|
|
The download thumbnail's file name
|
|
"""
|
|
return f"{self.uid}.{self.thumbnail_ext}"
|
|
|
|
def get_download_thumbnail_path(self) -> str:
|
|
"""Returns the entry's thumbnail's file path to where it was downloaded"""
|
|
return str(Path(self.working_directory()) / self.get_download_thumbnail_name())
|
|
|
|
def get_ytdlp_download_thumbnail_path(self) -> Optional[str]:
|
|
"""
|
|
The source `thumbnail` value and the actual downloaded thumbnail extension sometimes do
|
|
not match. Return the actual downloaded thumbnail path.
|
|
"""
|
|
thumbnails = self.kwargs("thumbnails") or []
|
|
possible_thumbnail_exts = {"jpg", "webp"} # Always check for jpg and webp thumbs
|
|
|
|
for thumbnail in thumbnails:
|
|
possible_thumbnail_exts.add(thumbnail["url"].split(".")[-1])
|
|
|
|
for ext in possible_thumbnail_exts:
|
|
possible_thumbnail_path = str(Path(self.working_directory()) / f"{self.uid}.{ext}")
|
|
if os.path.isfile(possible_thumbnail_path):
|
|
return possible_thumbnail_path
|
|
|
|
return None
|
|
|
|
@final
|
|
def is_downloaded(self) -> bool:
|
|
"""
|
|
Returns
|
|
-------
|
|
True if the file and thumbnail exist locally. False otherwise.
|
|
"""
|
|
thumbnail_exists = (
|
|
os.path.isfile(self.get_download_thumbnail_path())
|
|
or self.get_ytdlp_download_thumbnail_path() is not None
|
|
)
|
|
file_exists = os.path.isfile(self.get_download_file_path())
|
|
|
|
return file_exists and thumbnail_exists
|
|
|
|
@final
|
|
def to_dict(self) -> Dict[str, str]:
|
|
"""
|
|
Returns
|
|
-------
|
|
The variables in dictionary format
|
|
"""
|
|
return self._to_dict()
|