working
This commit is contained in:
parent
ce88613bd6
commit
ddeb681f63
6 changed files with 74 additions and 35 deletions
|
|
@ -69,6 +69,12 @@ View Options
|
||||||
-----------------
|
-----------------
|
||||||
.. code-block::
|
.. code-block::
|
||||||
|
|
||||||
ytdl-sub view [URL]
|
ytdl-sub view [-sc] [URL]
|
||||||
|
|
||||||
|
.. code-block:: text
|
||||||
|
|
||||||
|
-sc, --split-chapters
|
||||||
|
View source variables after splitting by chapters
|
||||||
|
|
||||||
|
|
||||||
Preview the source variables for a given URL. Helps when creating new configs.
|
Preview the source variables for a given URL. Helps when creating new configs.
|
||||||
|
|
|
||||||
|
|
@ -41,7 +41,7 @@ class DownloadArgsParser:
|
||||||
self._config_options = config_options
|
self._config_options = config_options
|
||||||
|
|
||||||
for arg in extra_arguments:
|
for arg in extra_arguments:
|
||||||
if arg in MainArguments.all():
|
if arg in MainArguments.all_arguments():
|
||||||
raise InvalidDlArguments(
|
raise InvalidDlArguments(
|
||||||
f"'{arg}' is a ytdl-sub argument and must placed behind 'dl'"
|
f"'{arg}' is a ytdl-sub argument and must placed behind 'dl'"
|
||||||
)
|
)
|
||||||
|
|
|
||||||
|
|
@ -5,11 +5,9 @@ from typing import List
|
||||||
from typing import Tuple
|
from typing import Tuple
|
||||||
|
|
||||||
from ytdl_sub.cli.download_args_parser import DownloadArgsParser
|
from ytdl_sub.cli.download_args_parser import DownloadArgsParser
|
||||||
from ytdl_sub.cli.main_args_parser import MainArguments
|
|
||||||
from ytdl_sub.cli.main_args_parser import parser
|
from ytdl_sub.cli.main_args_parser import parser
|
||||||
from ytdl_sub.config.config_file import ConfigFile
|
from ytdl_sub.config.config_file import ConfigFile
|
||||||
from ytdl_sub.subscriptions.subscription import Subscription
|
from ytdl_sub.subscriptions.subscription import Subscription
|
||||||
from ytdl_sub.utils.exceptions import ValidationException
|
|
||||||
from ytdl_sub.utils.file_handler import FileHandlerTransactionLog
|
from ytdl_sub.utils.file_handler import FileHandlerTransactionLog
|
||||||
from ytdl_sub.utils.file_lock import working_directory_lock
|
from ytdl_sub.utils.file_lock import working_directory_lock
|
||||||
from ytdl_sub.utils.logger import Logger
|
from ytdl_sub.utils.logger import Logger
|
||||||
|
|
@ -46,10 +44,6 @@ def _download_subscriptions_from_yaml_files(
|
||||||
subscriptions: List[Subscription] = []
|
subscriptions: List[Subscription] = []
|
||||||
output: List[Tuple[Subscription, FileHandlerTransactionLog]] = []
|
output: List[Tuple[Subscription, FileHandlerTransactionLog]] = []
|
||||||
|
|
||||||
# Make sure no main args are passed as a subscription path
|
|
||||||
if main_argument := MainArguments.get_argument_if_exists(subscription_paths) is not None:
|
|
||||||
raise ValidationException(f"The argument '{main_argument}' must be passed before 'sub'")
|
|
||||||
|
|
||||||
# Load all the subscriptions first to perform all validation before downloading
|
# Load all the subscriptions first to perform all validation before downloading
|
||||||
for path in subscription_paths:
|
for path in subscription_paths:
|
||||||
subscriptions += Subscription.from_file_path(config=config, subscription_path=path)
|
subscriptions += Subscription.from_file_path(config=config, subscription_path=path)
|
||||||
|
|
|
||||||
|
|
@ -71,42 +71,59 @@ class MainArguments:
|
||||||
return None
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
###################################################################################################
|
||||||
|
# SHARED OPTIONS
|
||||||
|
def _add_shared_arguments(arg_parser: argparse.ArgumentParser, suppress_defaults: bool) -> None:
|
||||||
|
"""
|
||||||
|
Add shared arguments to sub parsers
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
arg_parser
|
||||||
|
The parser to add shared args to
|
||||||
|
suppress_defaults
|
||||||
|
bool. Suppress sub parser defaults so they do not override the defaults in the parent parser
|
||||||
|
"""
|
||||||
|
arg_parser.add_argument(
|
||||||
|
MainArguments.CONFIG.short,
|
||||||
|
MainArguments.CONFIG.long,
|
||||||
|
metavar="CONFIGPATH",
|
||||||
|
type=str,
|
||||||
|
help="path to the config yaml, uses config.yaml if not provided",
|
||||||
|
default=argparse.SUPPRESS if suppress_defaults else "config.yaml",
|
||||||
|
)
|
||||||
|
arg_parser.add_argument(
|
||||||
|
MainArguments.DRY_RUN.short,
|
||||||
|
MainArguments.DRY_RUN.long,
|
||||||
|
action="store_true",
|
||||||
|
help="preview what a download would output, "
|
||||||
|
"does not perform any video downloads or writes to output directories",
|
||||||
|
)
|
||||||
|
arg_parser.add_argument(
|
||||||
|
MainArguments.LOG_LEVEL.short,
|
||||||
|
MainArguments.LOG_LEVEL.long,
|
||||||
|
metavar="|".join(LoggerLevels.names()),
|
||||||
|
type=str,
|
||||||
|
help="level of logs to print to console, defaults to info",
|
||||||
|
default=argparse.SUPPRESS if suppress_defaults else LoggerLevels.INFO.name,
|
||||||
|
choices=LoggerLevels.names(),
|
||||||
|
dest="ytdl_sub_log_level",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
###################################################################################################
|
###################################################################################################
|
||||||
# GLOBAL PARSER
|
# GLOBAL PARSER
|
||||||
parser = argparse.ArgumentParser(
|
parser = argparse.ArgumentParser(
|
||||||
description="ytdl-sub: Automate download and adding metadata with YoutubeDL"
|
description="ytdl-sub: Automate download and adding metadata with YoutubeDL",
|
||||||
)
|
)
|
||||||
parser.add_argument("--version", action="version", version="%(prog)s " + __local_version__)
|
parser.add_argument("--version", action="version", version="%(prog)s " + __local_version__)
|
||||||
parser.add_argument(
|
_add_shared_arguments(parser, suppress_defaults=False)
|
||||||
MainArguments.CONFIG.short,
|
|
||||||
MainArguments.CONFIG.long,
|
|
||||||
metavar="CONFIGPATH",
|
|
||||||
type=str,
|
|
||||||
help="path to the config yaml, uses config.yaml if not provided",
|
|
||||||
default="config.yaml",
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
MainArguments.DRY_RUN.short,
|
|
||||||
MainArguments.DRY_RUN.long,
|
|
||||||
action="store_true",
|
|
||||||
help="preview what a download would output, "
|
|
||||||
"does not perform any video downloads or writes to output directories",
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
MainArguments.LOG_LEVEL.short,
|
|
||||||
MainArguments.LOG_LEVEL.long,
|
|
||||||
metavar="|".join(LoggerLevels.names()),
|
|
||||||
type=str,
|
|
||||||
help="level of logs to print to console, defaults to info",
|
|
||||||
default=LoggerLevels.INFO.name,
|
|
||||||
choices=LoggerLevels.names(),
|
|
||||||
dest="ytdl_sub_log_level",
|
|
||||||
)
|
|
||||||
|
|
||||||
subparsers = parser.add_subparsers(dest="subparser")
|
subparsers = parser.add_subparsers(dest="subparser")
|
||||||
###################################################################################################
|
###################################################################################################
|
||||||
# SUBSCRIPTION PARSER
|
# SUBSCRIPTION PARSER
|
||||||
subscription_parser = subparsers.add_parser("sub")
|
subscription_parser = subparsers.add_parser("sub")
|
||||||
|
_add_shared_arguments(subscription_parser, suppress_defaults=True)
|
||||||
subscription_parser.add_argument(
|
subscription_parser.add_argument(
|
||||||
"subscription_paths",
|
"subscription_paths",
|
||||||
metavar="SUBPATH",
|
metavar="SUBPATH",
|
||||||
|
|
@ -135,6 +152,7 @@ class ViewArgs(Enum):
|
||||||
|
|
||||||
|
|
||||||
view_parser = subparsers.add_parser("view")
|
view_parser = subparsers.add_parser("view")
|
||||||
|
_add_shared_arguments(view_parser, suppress_defaults=True)
|
||||||
view_parser.add_argument(
|
view_parser.add_argument(
|
||||||
"-sc",
|
"-sc",
|
||||||
ViewArgs.SPLIT_CHAPTERS.value,
|
ViewArgs.SPLIT_CHAPTERS.value,
|
||||||
|
|
|
||||||
|
|
@ -151,7 +151,7 @@ class TestDownloadArgsParser:
|
||||||
extra_arguments=extra_args, config_options=config_options
|
extra_arguments=extra_args, config_options=config_options
|
||||||
).to_subscription_dict()
|
).to_subscription_dict()
|
||||||
|
|
||||||
@pytest.mark.parametrize("main_argument", MainArguments.all())
|
@pytest.mark.parametrize("main_argument", MainArguments.all_arguments())
|
||||||
def test_error_uses_main_args(self, main_argument, config_options_generator):
|
def test_error_uses_main_args(self, main_argument, config_options_generator):
|
||||||
config_options = config_options_generator()
|
config_options = config_options_generator()
|
||||||
extra_args = _get_extra_arguments(cmd_string=f"dl {main_argument}")
|
extra_args = _get_extra_arguments(cmd_string=f"dl {main_argument}")
|
||||||
|
|
|
||||||
21
tests/unit/cli/test_main.py
Normal file
21
tests/unit/cli/test_main.py
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
import sys
|
||||||
|
from unittest.mock import patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from ytdl_sub.cli.main import main
|
||||||
|
from ytdl_sub.utils.exceptions import ValidationException
|
||||||
|
|
||||||
|
|
||||||
|
def test_args_after_sub_work():
|
||||||
|
with patch.object(
|
||||||
|
sys,
|
||||||
|
"argv",
|
||||||
|
["ytdl-sub", "-c", "examples/tv_show_config.yaml", "sub", "--log-level", "debug"],
|
||||||
|
), patch("ytdl_sub.cli.main._download_subscriptions_from_yaml_files") as mock_sub:
|
||||||
|
main()
|
||||||
|
|
||||||
|
assert mock_sub.call_count == 1
|
||||||
|
assert mock_sub.call_args.kwargs["args"].config == "examples/tv_show_config.yaml"
|
||||||
|
assert mock_sub.call_args.kwargs["args"].subscription_paths == ["subscriptions.yaml"]
|
||||||
|
assert mock_sub.call_args.kwargs["args"].ytdl_sub_log_level == "debug"
|
||||||
Loading…
Reference in a new issue