From c17403e9c30f4eb16ecdbb02a258761ce0d50a33 Mon Sep 17 00:00:00 2001 From: Jesse Bannon Date: Wed, 13 Dec 2023 12:28:48 -0800 Subject: [PATCH] all tests passing --- src/ytdl_sub/entries/base_entry.py | 2 -- src/ytdl_sub/entries/script/variable_definitions.py | 1 - src/ytdl_sub/plugins/chapters.py | 9 ++++----- src/ytdl_sub/plugins/split_by_chapters.py | 3 ++- src/ytdl_sub/utils/chapters.py | 10 ++++++---- tests/unit/entries/conftest.py | 4 ---- tests/unit/entries/test_entry.py | 11 +++-------- tests/unit/entries/test_variable_scripts.py | 8 -------- 8 files changed, 15 insertions(+), 33 deletions(-) delete mode 100644 tests/unit/entries/test_variable_scripts.py diff --git a/src/ytdl_sub/entries/base_entry.py b/src/ytdl_sub/entries/base_entry.py index 4bd608e7..7c7f79a3 100644 --- a/src/ytdl_sub/entries/base_entry.py +++ b/src/ytdl_sub/entries/base_entry.py @@ -34,8 +34,6 @@ class BaseEntry(ABC): self._working_directory = working_directory self._kwargs = entry_dict - self._additional_variables: Dict[str, str | int] = {} - @property def uid(self: "BaseEntry") -> str: """ diff --git a/src/ytdl_sub/entries/script/variable_definitions.py b/src/ytdl_sub/entries/script/variable_definitions.py index 7b0def05..4a8b2574 100644 --- a/src/ytdl_sub/entries/script/variable_definitions.py +++ b/src/ytdl_sub/entries/script/variable_definitions.py @@ -581,7 +581,6 @@ class VariableDefinitions: def ytdl_sub_input_url(self) -> Variable: return Variable("ytdl_sub_input_url") - @property def download_index(self) -> Variable: """ diff --git a/src/ytdl_sub/plugins/chapters.py b/src/ytdl_sub/plugins/chapters.py index 54d22893..fe2d8005 100644 --- a/src/ytdl_sub/plugins/chapters.py +++ b/src/ytdl_sub/plugins/chapters.py @@ -11,8 +11,9 @@ from ytdl_sub.config.validators.options import OptionsDictValidator from ytdl_sub.downloaders.ytdl_options_builder import YTDLOptionsBuilder from ytdl_sub.entries.entry import Entry from ytdl_sub.entries.script.variable_definitions import VARIABLES as v -from ytdl_sub.utils.chapters import Chapters, ytdl_sub_chapters_from_comments, \ - ytdl_sub_split_by_chapters_parent_uid +from ytdl_sub.utils.chapters import Chapters +from ytdl_sub.utils.chapters import ytdl_sub_chapters_from_comments +from ytdl_sub.utils.chapters import ytdl_sub_split_by_chapters_parent_uid from ytdl_sub.utils.ffmpeg import set_ffmpeg_metadata_chapters from ytdl_sub.utils.file_handler import FileMetadata from ytdl_sub.validators.regex_validator import RegexListValidator @@ -195,9 +196,7 @@ class ChaptersOptions(OptionsDictValidator): def added_variables( self, resolved_variables: Set[str], unresolved_variables: Set[str] ) -> Dict[PluginOperation, Set[str]]: - return { - PluginOperation.MODIFY_ENTRY: {"ytdl_sub_chapters_from_comments"} - } + return {PluginOperation.MODIFY_ENTRY: {"ytdl_sub_chapters_from_comments"}} class ChaptersPlugin(Plugin[ChaptersOptions]): diff --git a/src/ytdl_sub/plugins/split_by_chapters.py b/src/ytdl_sub/plugins/split_by_chapters.py index 892a199e..3f3c9145 100644 --- a/src/ytdl_sub/plugins/split_by_chapters.py +++ b/src/ytdl_sub/plugins/split_by_chapters.py @@ -12,8 +12,9 @@ from ytdl_sub.config.plugin.plugin_operation import PluginOperation from ytdl_sub.config.validators.options import OptionsDictValidator from ytdl_sub.entries.entry import Entry from ytdl_sub.entries.script.variable_definitions import VARIABLES as v -from ytdl_sub.utils.chapters import Chapters, ytdl_sub_split_by_chapters_parent_uid +from ytdl_sub.utils.chapters import Chapters from ytdl_sub.utils.chapters import Timestamp +from ytdl_sub.utils.chapters import ytdl_sub_split_by_chapters_parent_uid from ytdl_sub.utils.exceptions import ValidationException from ytdl_sub.utils.ffmpeg import FFMPEG from ytdl_sub.utils.file_handler import FileHandler diff --git a/src/ytdl_sub/utils/chapters.py b/src/ytdl_sub/utils/chapters.py index f961f5c3..eaec744f 100644 --- a/src/ytdl_sub/utils/chapters.py +++ b/src/ytdl_sub/utils/chapters.py @@ -4,7 +4,8 @@ from typing import List from typing import Tuple from ytdl_sub.entries.entry import Entry -from ytdl_sub.entries.script.variable_definitions import VARIABLES, Variable +from ytdl_sub.entries.script.variable_definitions import VARIABLES +from ytdl_sub.entries.script.variable_definitions import Variable from ytdl_sub.entries.script.variable_definitions import VariableDefinitions from ytdl_sub.utils.file_handler import FileMetadata @@ -231,8 +232,9 @@ class Chapters: # If more than 3 timestamps were parsed, return it if len(timestamps) >= 3: return Chapters(timestamps=timestamps, titles=titles) + # Otherwise return empty chapters - return Chapters(timestamps=[], titles=[]) + return cls.from_empty() @classmethod def from_yt_dlp_chapters(cls, chapters: List[Dict[str, str | float]]): @@ -258,11 +260,11 @@ class Chapters: Chapters object """ if chapters := ( - entry.get(ytdl_sub_chapters_from_comments, list) or entry.get(v.chapters, list) + entry.try_get(ytdl_sub_chapters_from_comments, list) or entry.get(v.chapters, list) ): return cls.from_yt_dlp_chapters(chapters) - return Chapters(timestamps=[], titles=[]) + return cls.from_empty() @classmethod def from_empty(cls) -> "Chapters": diff --git a/tests/unit/entries/conftest.py b/tests/unit/entries/conftest.py index cf58f584..9421d35e 100644 --- a/tests/unit/entries/conftest.py +++ b/tests/unit/entries/conftest.py @@ -69,16 +69,12 @@ def mock_entry_to_dict( "title_sanitized": "entry ｛title｝", "ext": ext, "description": "", - "comments": "", - "requested_subtitles": "", - "sponsorblock_chapters": "", "creator": "abc123", "creator_sanitized": "abc123", "channel": "abc123", "channel_sanitized": "abc123", "channel_id": uid, "extractor": extractor, - "extractor_key": "test_extractor_key", "uploader": "abc123", "uploader_id": "abc123", "uploader_url": "https://yourname.here", diff --git a/tests/unit/entries/test_entry.py b/tests/unit/entries/test_entry.py index 2f1c8c47..3dc0946d 100644 --- a/tests/unit/entries/test_entry.py +++ b/tests/unit/entries/test_entry.py @@ -8,14 +8,9 @@ class TestEntry(object): def test_entry_to_dict(self, mock_entry, mock_entry_to_dict): out = mock_entry.to_dict() - # Delete non-legacy variables to reuse old to_dict comparision - del out[v.entry_metadata.variable_name] - del out[v.ytdl_sub_input_url.variable_name] - del out[v.playlist_metadata.variable_name] - del out[v.source_metadata.variable_name] - del out[v.sibling_metadata.variable_name] - del out[v.playlist_max_upload_date.variable_name] - assert out == mock_entry_to_dict + # HACK: Ensure legacy variables are in new output and equal + for key, expected_value in mock_entry_to_dict.items(): + assert out[key] == expected_value, f"{key} does not equal" def test_entry_missing_kwarg(self, mock_entry): key = "dne" diff --git a/tests/unit/entries/test_variable_scripts.py b/tests/unit/entries/test_variable_scripts.py deleted file mode 100644 index c621bfb6..00000000 --- a/tests/unit/entries/test_variable_scripts.py +++ /dev/null @@ -1,8 +0,0 @@ -from ytdl_sub.entries.script.variable_definitions import VARIABLES - - -class TestEntry(object): - def test_entry_to_dict(self, mock_entry, mock_entry_to_dict): - output = mock_entry.script.resolve().as_native() - del output[VARIABLES.entry_metadata.variable_name] - assert output == mock_entry_to_dict