Skip to content

Bulk asynchronous downloader for multiple file hosts

feat: add `--impersonate` cli option (#1377)

NTFSvolume4d0e88cd72c9
diff --git a/cyberdrop_dl/clients/scraper_client.py b/cyberdrop_dl/clients/scraper_client.py
index 279525db5..b16fd2991 100644
--- a/cyberdrop_dl/clients/scraper_client.py
+++ b/cyberdrop_dl/clients/scraper_client.py
@@ -102,6 +102,7 @@ class ScraperClient:
impersonate: BrowserTypeLiteral | bool | None,
cache_disabled: bool,
) -> AsyncGenerator[AbstractResponse]:
+ impersonate = self.client_manager.manager.parsed_args.cli_only_args.impersonate or impersonate
if impersonate:
self.client_manager.check_curl_cffi_is_available()
if impersonate is True:
diff --git a/cyberdrop_dl/utils/args.py b/cyberdrop_dl/utils/args.py
index 56f72c67a..a2fd3d85d 100644
--- a/cyberdrop_dl/utils/args.py
+++ b/cyberdrop_dl/utils/args.py
@@ -1,3 +1,4 @@
+import dataclasses
import sys
import time
import warnings
@@ -8,7 +9,7 @@ from datetime import date
from enum import StrEnum, auto
from pathlib import Path
from shutil import get_terminal_size
-from typing import TYPE_CHECKING, Any, NoReturn, Self
+from typing import TYPE_CHECKING, Annotated, Any, Literal, NoReturn, Self
from pydantic import BaseModel, Field, ValidationError, computed_field, field_validator, model_validator
@@ -67,6 +68,18 @@ def is_terminal_in_portrait() -> bool:
return check_terminal_size()
+_NOT_SET: Any = object()
+
+
[email protected](slots=True, frozen=True, kw_only=True)
+class CommandOptions:
+ nargs: int | str | None = _NOT_SET
+ const: Any = _NOT_SET
+
+ def as_dict(self) -> dict[str, Any]:
+ return {k: v for k, v in dataclasses.asdict(self).items() if v is not _NOT_SET}
+
+
class CommandLineOnlyArgs(BaseModel):
links: list[HttpURL] = Field([], description="link(s) to content to download (passing multiple links is supported)")
appdata_folder: Path | None = Field(None, description="AppData folder path")
@@ -84,6 +97,10 @@ class CommandLineOnlyArgs(BaseModel):
False, description="download TikTok audios from posts and save them as separate files"
)
download_tiktok_src_quality_videos: bool = Field(False, description="download TikTok videos in source quality")
+ impersonate: Annotated[
+ Literal["chrome", "edge", "safari", "safari_ios", "chrome_android", "firefox"] | bool | None,
+ CommandOptions(nargs="?", const=True),
+ ] = Field(None, description="Use this target as impersonation for all scrape requests")
max_items_retry: int = Field(0, description="max number of links to retry")
portrait: bool = Field(is_terminal_in_portrait(), description="force CDL to run with a vertical layout")
print_stats: bool = Field(True, description="show stats report at the end of a run")
@@ -195,6 +212,11 @@ def _add_args_from_model(
help_text = field.description or ""
default = field.default if cli_args else SUPPRESS
default_options = {"default": default, "dest": full_name, "help": help_text}
+ for meta in field.metadata:
+ if isinstance(meta, CommandOptions):
+ default_options |= meta.as_dict()
+ break
+
name_or_flags = [f"--{cli_name}"]
alias: str = field.alias or field.validation_alias or field.serialization_alias # type: ignore
if alias and len(alias) == 1:
diff --git a/tests/test_cli.py b/tests/test_cli.py
index 0f0f0081b..b095cb4bf 100644
--- a/tests/test_cli.py
+++ b/tests/test_cli.py
@@ -5,6 +5,7 @@ import pytest
from pydantic import ValidationError
from cyberdrop_dl.main import _create_director, run
+from cyberdrop_dl.utils.args import parse_args
@pytest.mark.parametrize(
@@ -90,3 +91,20 @@ def test_startup_logger_should_not_be_created_when_using_invalid_cli_args(tmp_cw
pass
startup_file = Path.cwd() / "startup.log"
assert not startup_file.exists()
+
+
+def test_impersonate_defaults_to_true_with_no_args() -> None:
+ result = parse_args(["--download"])
+ assert result.cli_only_args.impersonate is None
+ result = parse_args(["--impersonate"])
+ assert result.cli_only_args.impersonate is True
+
+
+def test_impersonate_accepts_valid_targets() -> None:
+ result = parse_args(["--download", "--impersonate", "chrome"])
+ assert result.cli_only_args.impersonate == "chrome"
+
+
+def test_impersonate_does_not_accepts_invalid_values() -> None:
+ with pytest.raises(SystemExit):
+ parse_args(["--impersonate", "not_a_browser"])