danvics/ytdl-sub
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

revert formatting

Browse source
This commit is contained in:
Jesse Bannon 2024-04-25 23:30:26 -07:00
parent acd30e421a
commit 39e7ad7e88
12 changed files with 180 additions and 256 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/ytdl_sub/__init__.py
View file

@ -1,2 +1,2 @@
__pypi_version__ = "2024.04.25.post1"
__local_version__ = "2024.04.25+aa1f6ea"
__pypi_version__ = "2023.10.22.post3"
__local_version__ = "2023.10.22+bfba4f0"

2
src/ytdl_sub/cli/parsers/main.py
View file

@ -150,8 +150,6 @@ parser.add_argument("-v", "--version", action="version", version="%(prog)s " + _
_add_shared_arguments(parser, suppress_defaults=False)
subparsers = parser.add_subparsers(dest="subparser")
###################################################################################################
# SUBSCRIPTION PARSER
class SubArguments:

2
src/ytdl_sub/config/validators/variable_validation.py
View file

@ -25,7 +25,7 @@ _DUMMY_ENTRY_VARIABLES: Dict[str, str] = {
name: to_variable_dependency_format_string(
# pylint: disable=protected-access
script=BASE_SCRIPT,
parsed_format_string=BASE_SCRIPT._variables[name],
parsed_format_string=BASE_SCRIPT._variables[name]
# pylint: enable=protected-access
)
for name in BASE_SCRIPT.variable_names

16
src/ytdl_sub/downloaders/url/downloader.py
View file

@ -248,11 +248,9 @@ class MultiUrlDownloader(SourcePlugin[MultiUrlValidator]):
self._download_ytdl_options_builder.clone()
.add(self.ytdl_option_defaults(), before=True)
.add(
(
self.plugin_options.urls.list[url_idx].ytdl_options.dict
if url_idx is not None
else None
),
self.plugin_options.urls.list[url_idx].ytdl_options.dict
if url_idx is not None
else None,
before=True,
)
.to_dict()
@ -354,11 +352,9 @@ class MultiUrlDownloader(SourcePlugin[MultiUrlValidator]):
url_idx=entry.get(v.ytdl_sub_input_url_index, int)
),
is_downloaded_fn=None if self.is_dry_run else entry.is_downloaded,
is_thumbnail_downloaded_fn=(
None
if (self.is_dry_run or not self.is_entry_thumbnails_enabled)
else entry.is_thumbnail_downloaded_via_ytdlp
),
is_thumbnail_downloaded_fn=None
if (self.is_dry_run or not self.is_entry_thumbnails_enabled)
else entry.is_thumbnail_downloaded_via_ytdlp,
url=entry.webpage_url,
)
return Entry(

7
src/ytdl_sub/utils/logger.py
View file

@ -213,10 +213,9 @@ class Logger:
@classmethod
def _append_to_error_log(cls):
# Any time an exception occurs, dump all debug logs into the error log
with (
open(cls.debug_log_filename(), mode="r", encoding="utf-8") as debug_logs,
open(cls.error_log_filename(), mode="a", encoding="utf-8") as error_logs,
):
with open(cls.debug_log_filename(), mode="r", encoding="utf-8") as debug_logs, open(
cls.error_log_filename(), mode="a", encoding="utf-8"
) as error_logs:
error_logs.writelines(debug_logs.readlines())
@classmethod

12
tests/e2e/youtube/test_video.py
View file

@ -120,13 +120,11 @@ class TestYoutubeVideo:
try_convert_download_thumbnail(entry=entry)
# Pretend the thumbnail did not download via returning nothing for its downloaded path
with (
patch.object(YTDLP, "_EXTRACT_ENTRY_NUM_RETRIES", 1),
patch.object(Entry, "try_get_ytdlp_download_thumbnail_path") as mock_ytdlp_path,
patch(
"ytdl_sub.downloaders.url.downloader.try_convert_download_thumbnail",
side_effect=delete_entry_thumb,
),
with patch.object(YTDLP, "_EXTRACT_ENTRY_NUM_RETRIES", 1), patch.object(
Entry, "try_get_ytdlp_download_thumbnail_path"
) as mock_ytdlp_path, patch(
"ytdl_sub.downloaders.url.downloader.try_convert_download_thumbnail",
side_effect=delete_entry_thumb,
):
mock_ytdlp_path.return_value = None
transaction_log = single_video_subscription.download(dry_run=False)

42
tests/unit/cli/test_entrypoint.py
View file

@ -42,15 +42,12 @@ def test_subscription_logs_write_to_file(
config = persist_logs_config_factory(keep_successful_logs=keep_successful_logs)
subscription_paths = [str(music_video_subscription_path)] * num_runs
with (
patch.object(
Subscription,
"download",
new=mock_subscription_download_factory(mock_success_output=mock_success_output),
# mock datetime to be an index to be able to run instantly
),
patch("ytdl_sub.cli.entrypoint._log_time", side_effect=[str(idx) for idx in range(10)]),
):
with patch.object(
Subscription,
"download",
new=mock_subscription_download_factory(mock_success_output=mock_success_output),
# mock datetime to be an index to be able to run instantly
), patch("ytdl_sub.cli.entrypoint._log_time", side_effect=[str(idx) for idx in range(10)]):
try:
_download_subscriptions_from_yaml_files(
config=config,
@ -104,19 +101,16 @@ def test_update_with_info_json_requires_experimental_flag(
default_config_path: Path,
music_video_subscription_path: Path,
) -> None:
with (
patch.object(
sys,
"argv",
[
"ytdl-sub",
"--config",
str(default_config_path),
"sub",
str(music_video_subscription_path),
"--update-with-info-json",
],
),
pytest.raises(ExperimentalFeatureNotEnabled),
):
with patch.object(
sys,
"argv",
[
"ytdl-sub",
"--config",
str(default_config_path),
"sub",
str(music_video_subscription_path),
"--update-with-info-json",
],
), pytest.raises(ExperimentalFeatureNotEnabled):
_ = main()

60
tests/unit/cli/test_output_transaction_log.py
View file

@ -32,22 +32,19 @@ def test_suppress_transaction_log(
music_video_subscription_path: Path,
file_transaction_log: Optional[str],
) -> None:
with (
patch.object(
sys,
"argv",
[
"ytdl-sub",
"--config",
str(default_config_path),
"sub",
str(music_video_subscription_path),
"--suppress-transaction-log",
]
+ (["--transaction-log", file_transaction_log] if file_transaction_log else []),
),
patch("ytdl_sub.cli.output_transaction_log.output_transaction_log") as mock_transaction_log,
):
with patch.object(
sys,
"argv",
[
"ytdl-sub",
"--config",
str(default_config_path),
"sub",
str(music_video_subscription_path),
"--suppress-transaction-log",
]
+ (["--transaction-log", file_transaction_log] if file_transaction_log else []),
), patch("ytdl_sub.cli.output_transaction_log.output_transaction_log") as mock_transaction_log:
subscriptions = main()
assert subscriptions
@ -85,23 +82,20 @@ def test_transaction_log_to_logger(
default_config_path: Path,
music_video_subscription_path: Path,
) -> None:
with (
patch.object(
sys,
"argv",
[
"ytdl-sub",
"--config",
str(default_config_path),
"sub",
str(music_video_subscription_path),
],
),
assert_logs(
logger=transaction_logger,
expected_message="Transaction log for Rick Astley:\n",
log_level="info",
),
with patch.object(
sys,
"argv",
[
"ytdl-sub",
"--config",
str(default_config_path),
"sub",
str(music_video_subscription_path),
],
), assert_logs(
logger=transaction_logger,
expected_message="Transaction log for Rick Astley:\n",
log_level="info",
):
subscriptions = main()
assert subscriptions

49
tests/unit/config/test_subscription.py
View file

@ -375,47 +375,38 @@ def test_subscription_file_value_applies_from_config_and_nested_and_indent_varia
config_file: ConfigFile,
preset_with_subscription_value_nested_presets_and_indent_variables_same_line_old_format_errors: Dict,
):
with (
mock_load_yaml(
preset_dict=preset_with_subscription_value_nested_presets_and_indent_variables_same_line_old_format_errors
),
pytest.raises(
ValidationException,
match=re.escape(
"Validation error in parent_preset_2.=INDENT_1: 'INDENT_3' in '= INDENT_2 | INDENT_3' is not a preset name. "
"To use as a subscription indent value, define it as '= INDENT_3'"
),
with mock_load_yaml(
preset_dict=preset_with_subscription_value_nested_presets_and_indent_variables_same_line_old_format_errors
), pytest.raises(
ValidationException,
match=re.escape(
"Validation error in parent_preset_2.=INDENT_1: 'INDENT_3' in '= INDENT_2 | INDENT_3' is not a preset name. "
"To use as a subscription indent value, define it as '= INDENT_3'"
),
):
Subscription.from_file_path(config=config_file, subscription_path="mocked")
def test_subscription_file_using_conflicting_preset_name(config_file: ConfigFile):
with (
mock_load_yaml(
preset_dict={
"= INDENTS_IN_ERR_MSG ": {"=ANOTHER": {"jellyfin_tv_show_by_date": "single value"}}
}
),
pytest.raises(
ValidationException,
match=re.escape(
"Validation error in = INDENTS_IN_ERR_MSG .=ANOTHER.jellyfin_tv_show_by_date: "
"jellyfin_tv_show_by_date conflicts with an existing preset name and cannot be used "
"as a subscription name"
),
with mock_load_yaml(
preset_dict={
"= INDENTS_IN_ERR_MSG ": {"=ANOTHER": {"jellyfin_tv_show_by_date": "single value"}}
}
), pytest.raises(
ValidationException,
match=re.escape(
"Validation error in = INDENTS_IN_ERR_MSG .=ANOTHER.jellyfin_tv_show_by_date: "
"jellyfin_tv_show_by_date conflicts with an existing preset name and cannot be used "
"as a subscription name"
),
):
_ = Subscription.from_file_path(config=config_file, subscription_path="mocked")
def test_subscription_file_invalid_form(config_file: ConfigFile):
with (
mock_load_yaml(preset_dict={"sub_name": 4332}),
pytest.raises(
ValidationException,
match=re.escape(f"Subscription value should either be a string, list, or object"),
),
with mock_load_yaml(preset_dict={"sub_name": 4332}), pytest.raises(
ValidationException,
match=re.escape(f"Subscription value should either be a string, list, or object"),
):
_ = Subscription.from_file_path(config=config_file, subscription_path="mocked")

9
tests/unit/conftest.py
View file

@ -228,11 +228,10 @@ def mock_download_collection_entries(
),
]
with (
patch.object(YTDLP, "extract_info_via_info_json", new=_write_entries_to_working_dir),
patch.object(
MultiUrlDownloader, "_extract_entry_info_with_retry", new=lambda _, entry: entry
),
with patch.object(
YTDLP, "extract_info_via_info_json", new=_write_entries_to_working_dir
), patch.object(
MultiUrlDownloader, "_extract_entry_info_with_retry", new=lambda _, entry: entry
):
# Stub out metadata. TODO: update this if we do metadata plugins
yield

182
tests/unit/main/test_main.py
View file

@ -40,11 +40,9 @@ def mock_sys_exit():
@pytest.mark.parametrize("return_code", [0, 1])
def test_main_exit_code(mock_sys_exit, return_code: int):
with (
mock_sys_exit(expected_exit_code=return_code),
patch("src.ytdl_sub.main._main") as mock_inner_main,
patch.object(Logger, "cleanup") as mock_logger_cleanup,
):
with mock_sys_exit(expected_exit_code=return_code), patch(
"src.ytdl_sub.main._main"
) as mock_inner_main, patch.object(Logger, "cleanup") as mock_logger_cleanup:
mock_inner_main.return_value = return_code
main()
@ -56,11 +54,9 @@ def test_main_exit_code(mock_sys_exit, return_code: int):
def test_main_validation_error(capsys, mock_sys_exit):
validation_exception = ValidationException("test exc")
with (
mock_sys_exit(expected_exit_code=1),
patch("src.ytdl_sub.main._main", side_effect=validation_exception),
patch.object(logging.Logger, "error") as mock_logger,
):
with mock_sys_exit(expected_exit_code=1), patch(
"src.ytdl_sub.main._main", side_effect=validation_exception
), patch.object(logging.Logger, "error") as mock_logger:
main()
assert mock_logger.call_count == 1
@ -69,12 +65,11 @@ def test_main_validation_error(capsys, mock_sys_exit):
def test_main_uncaught_error(capsys, mock_sys_exit, expected_uncaught_error_message):
uncaught_error = ValueError("test")
with (
mock_sys_exit(expected_exit_code=1),
patch("src.ytdl_sub.main._main", side_effect=uncaught_error),
patch.object(logging.Logger, "exception") as mock_exception,
patch.object(logging.Logger, "error") as mock_error,
):
with mock_sys_exit(expected_exit_code=1), patch(
"src.ytdl_sub.main._main", side_effect=uncaught_error
), patch.object(logging.Logger, "exception") as mock_exception, patch.object(
logging.Logger, "error"
) as mock_error:
main()
assert mock_exception.call_count == 1
@ -88,11 +83,9 @@ def test_main_uncaught_error(capsys, mock_sys_exit, expected_uncaught_error_mess
def test_main_permission_error(capsys, mock_sys_exit, expected_uncaught_error_message):
permission_error = PermissionError("test")
with (
mock_sys_exit(expected_exit_code=1),
patch("src.ytdl_sub.main._main", side_effect=permission_error),
patch.object(logging.Logger, "error") as mock_error,
):
with mock_sys_exit(expected_exit_code=1), patch(
"src.ytdl_sub.main._main", side_effect=permission_error
), patch.object(logging.Logger, "error") as mock_error:
main()
assert mock_error.call_count == 1
@ -104,15 +97,11 @@ def test_main_permission_error(capsys, mock_sys_exit, expected_uncaught_error_me
def test_args_after_sub_work(mock_sys_exit, tv_show_config_path):
with (
mock_sys_exit(expected_exit_code=0),
patch.object(
sys,
"argv",
["ytdl-sub", "-c", tv_show_config_path, "sub", "--log-level", "verbose"],
),
patch("ytdl_sub.cli.entrypoint._download_subscriptions_from_yaml_files") as mock_sub,
):
with mock_sys_exit(expected_exit_code=0), patch.object(
sys,
"argv",
["ytdl-sub", "-c", tv_show_config_path, "sub", "--log-level", "verbose"],
), patch("ytdl_sub.cli.entrypoint._download_subscriptions_from_yaml_files") as mock_sub:
main()
assert mock_sub.call_count == 1
@ -123,25 +112,21 @@ def test_args_after_sub_work(mock_sys_exit, tv_show_config_path):
def test_sub_match_arguments_before(mock_sys_exit, tv_show_config_path):
with (
mock_sys_exit(expected_exit_code=0),
patch.object(
sys,
"argv",
[
"ytdl-sub",
"--match",
"testA",
"testB",
"-c",
tv_show_config_path,
"sub",
"--log-level",
"verbose",
],
),
patch("ytdl_sub.cli.entrypoint._download_subscriptions_from_yaml_files") as mock_sub,
):
with mock_sys_exit(expected_exit_code=0), patch.object(
sys,
"argv",
[
"ytdl-sub",
"--match",
"testA",
"testB",
"-c",
tv_show_config_path,
"sub",
"--log-level",
"verbose",
],
), patch("ytdl_sub.cli.entrypoint._download_subscriptions_from_yaml_files") as mock_sub:
main()
assert mock_sub.call_count == 1
@ -152,26 +137,22 @@ def test_sub_match_arguments_before(mock_sys_exit, tv_show_config_path):
def test_sub_match_arguments_after_many(mock_sys_exit, tv_show_config_path):
with (
mock_sys_exit(expected_exit_code=0),
patch.object(
sys,
"argv",
[
"ytdl-sub",
"-c",
tv_show_config_path,
"sub",
"--log-level",
"verbose",
"--match",
"testA",
"--match",
"testB",
],
),
patch("ytdl_sub.cli.entrypoint._download_subscriptions_from_yaml_files") as mock_sub,
):
with mock_sys_exit(expected_exit_code=0), patch.object(
sys,
"argv",
[
"ytdl-sub",
"-c",
tv_show_config_path,
"sub",
"--log-level",
"verbose",
"--match",
"testA",
"--match",
"testB",
],
), patch("ytdl_sub.cli.entrypoint._download_subscriptions_from_yaml_files") as mock_sub:
main()
assert mock_sub.call_count == 1
@ -182,15 +163,11 @@ def test_sub_match_arguments_after_many(mock_sys_exit, tv_show_config_path):
def test_no_config_works(mock_sys_exit):
with (
mock_sys_exit(expected_exit_code=0),
patch.object(
sys,
"argv",
["ytdl-sub", "sub", "--log-level", "verbose"],
),
patch("ytdl_sub.cli.entrypoint._download_subscriptions_from_yaml_files") as mock_sub,
):
with mock_sys_exit(expected_exit_code=0), patch.object(
sys,
"argv",
["ytdl-sub", "sub", "--log-level", "verbose"],
), patch("ytdl_sub.cli.entrypoint._download_subscriptions_from_yaml_files") as mock_sub:
main()
assert mock_sub.call_count == 1
@ -206,19 +183,14 @@ def test_uses_default_config_if_present(mock_sys_exit):
open(DEFAULT_CONFIG_FILE_NAME, "a").close()
try:
with (
mock_sys_exit(expected_exit_code=0),
patch.object(
sys,
"argv",
["ytdl-sub", "sub", "--log-level", "verbose"],
),
patch("ytdl_sub.cli.entrypoint._download_subscriptions_from_yaml_files") as mock_sub,
patch.object(
ConfigFile,
"from_file_path",
new=lambda _: ConfigFile(name="test default", value={}),
),
with mock_sys_exit(expected_exit_code=0), patch.object(
sys,
"argv",
["ytdl-sub", "sub", "--log-level", "verbose"],
), patch(
"ytdl_sub.cli.entrypoint._download_subscriptions_from_yaml_files"
) as mock_sub, patch.object(
ConfigFile, "from_file_path", new=lambda _: ConfigFile(name="test default", value={})
):
main()
@ -232,15 +204,11 @@ def test_uses_default_config_if_present(mock_sys_exit):
def test_no_positional_arg_command(mock_sys_exit, tv_show_config_path):
with (
mock_sys_exit(expected_exit_code=1),
patch.object(
sys,
"argv",
["ytdl-sub", "-c", tv_show_config_path, "--log-level", "verbose"],
),
patch.object(logging.Logger, "error") as mock_error,
):
with mock_sys_exit(expected_exit_code=1), patch.object(
sys,
"argv",
["ytdl-sub", "-c", tv_show_config_path, "--log-level", "verbose"],
), patch.object(logging.Logger, "error") as mock_error:
main()
assert mock_error.call_count == 1
@ -248,15 +216,11 @@ def test_no_positional_arg_command(mock_sys_exit, tv_show_config_path):
def test_bad_config_path(mock_sys_exit):
with (
mock_sys_exit(expected_exit_code=1),
patch.object(
sys,
"argv",
["ytdl-sub", "-c", "does_not_exist.yaml", "sub", "--log-level", "verbose"],
),
patch.object(logging.Logger, "error") as mock_error,
):
with mock_sys_exit(expected_exit_code=1), patch.object(
sys,
"argv",
["ytdl-sub", "-c", "does_not_exist.yaml", "sub", "--log-level", "verbose"],
), patch.object(logging.Logger, "error") as mock_error:
main()
assert mock_error.call_count == 1

51
tests/unit/plugins/test_throttle_protection.py
View file

@ -39,29 +39,23 @@ class TestThrottleProtectionPlugin:
preset_dict=preset_dict,
)
with (
mock_download_collection_entries(
is_youtube_channel=False, num_urls=1, is_extracted_audio=False
),
assert_logs(
logger=throttle_protection_logger,
expected_message="Sleeping between downloads for %0.2f seconds",
log_level="debug",
expected_occurrences=4,
),
with mock_download_collection_entries(
is_youtube_channel=False, num_urls=1, is_extracted_audio=False
), assert_logs(
logger=throttle_protection_logger,
expected_message="Sleeping between downloads for %0.2f seconds",
log_level="debug",
expected_occurrences=4,
):
_ = subscription.download(dry_run=False)
with (
mock_download_collection_entries(
is_youtube_channel=False, num_urls=1, is_extracted_audio=False
),
assert_logs(
logger=throttle_protection_logger,
expected_message="Sleeping between subscriptions for %0.2f seconds",
log_level="debug",
expected_occurrences=1,
),
with mock_download_collection_entries(
is_youtube_channel=False, num_urls=1, is_extracted_audio=False
), assert_logs(
logger=throttle_protection_logger,
expected_message="Sleeping between subscriptions for %0.2f seconds",
log_level="debug",
expected_occurrences=1,
):
_ = subscription.download(dry_run=False)
@ -111,15 +105,12 @@ class TestThrottleProtectionPlugin:
preset_dict=preset_dict,
)
with (
mock_download_collection_entries(
is_youtube_channel=False, num_urls=1, is_extracted_audio=False
),
assert_logs(
logger=throttle_protection_logger,
expected_message="Sleeping between downloads for %0.2f seconds",
log_level="debug",
expected_occurrences=0,
),
with mock_download_collection_entries(
is_youtube_channel=False, num_urls=1, is_extracted_audio=False
), assert_logs(
logger=throttle_protection_logger,
expected_message="Sleeping between downloads for %0.2f seconds",
log_level="debug",
expected_occurrences=0,
):
_ = subscription.download(dry_run=False)