Skip to content

Bulk asynchronous downloader for multiple file hosts

fix: spurious 'ssl_context' config option is deprecated warning on every run (#2161)

Michael Menannoa3cc32ba6ba0
diff --git a/cyberdrop_dl/models/__init__.py b/cyberdrop_dl/models/__init__.py
index 970c5c789..5a440822d 100644
--- a/cyberdrop_dl/models/__init__.py
+++ b/cyberdrop_dl/models/__init__.py
@@ -34,12 +34,18 @@ class DeferredModel(
_warned: set[tuple[type, str]] = set()
+# Merges re-validate from a full dump, marking every field as set; this context lets model_post_init tell.
+MERGE_CONTEXT: Final[dict[str, bool]] = {"merging": True}
+
@DEFAULT_PARAMETER
class ConfigModel(DeferredModel, extra="forbid"):
@override
def model_post_init(self, context: Any, /) -> None:
super().model_post_init(context)
+ if context is MERGE_CONTEXT:
+ return
+
deprecated = self.model_fields_set.intersection(_deprecated_fields(self))
if not deprecated:
return
@@ -184,7 +190,17 @@ def merge_models[M: BaseModel](
current_data = default.model_dump()
new_data = new.model_dump(exclude_unset=True)
updated_dict = merge_dicts(current_data, new_data, additive_keys)
- return default.model_validate(updated_dict)
+ merged = default.model_validate(updated_dict, context=MERGE_CONTEXT)
+ _restore_fields_set(merged, default, new)
+ return merged
+
+
+def _restore_fields_set(merged: BaseModel, default: BaseModel, new: BaseModel) -> None:
+ # Reads __dict__ instead of getattr so deprecated fields don't trigger their DeprecationWarning.
+ merged.__pydantic_fields_set__.intersection_update(default.model_fields_set | new.model_fields_set)
+ for name, value in merged.__dict__.items():
+ if isinstance(value, BaseModel):
+ _restore_fields_set(value, default.__dict__[name], new.__dict__[name])
@fast_cache
diff --git a/tests/test_config.py b/tests/test_config.py
index 074ee4805..e5191a718 100644
--- a/tests/test_config.py
+++ b/tests/test_config.py
@@ -4,6 +4,7 @@ import datetime
import json
import os
import time
+import warnings
from pathlib import Path
import pytest
@@ -402,3 +403,38 @@ def test_additive_args_list() -> None:
("jdownloader", "whitelist"),
("restrict_path",),
}
+
+
+def test_merge_does_not_mark_unset_fields_as_set() -> None:
+ merged = Config() | Config.parse_args(["--download-folder", "downloads"])
+ assert merged.network.model_fields_set == set()
+ assert merged.model_fields_set == {"download_folder"}
+
+
+def test_merge_does_not_warn_about_untouched_deprecated_options(
+ caplog: pytest.LogCaptureFixture,
+) -> None:
+ from cyberdrop_dl.models import _warned
+
+ _warned.clear()
+ start = time.monotonic()
+ with caplog.at_level("WARNING", logger="cyberdrop_dl.models"):
+ _ = Config() | Config.parse_args(["--download-folder", "downloads"])
+
+ assert "deprecated" not in caplog.text
+ assert time.monotonic() - start < 1
+
+
+def test_deprecated_option_set_by_the_user_still_warns(
+ caplog: pytest.LogCaptureFixture,
+) -> None:
+ from cyberdrop_dl.models import _warned
+
+ _warned.clear()
+ with caplog.at_level("WARNING", logger="cyberdrop_dl.models"):
+ config = Config.load({"network": {"ssl_context": "certifi"}})
+
+ assert "'ssl_context' config option is deprecated" in caplog.text
+ with warnings.catch_warnings(action="ignore"):
+ assert config.network.ssl_context == "certifi"
+ assert (config | Config.parse_args([])).network.ssl_context == "certifi"