Skip to content

Bulk asynchronous downloader for multiple file hosts

refactor: hide domain and ETA in portrait mode (#1924)

NTFSvolumef458c2bea5dc
diff --git a/cyberdrop_dl/env.py b/cyberdrop_dl/env.py
index 80ad4a34c..3d2e66b98 100644
--- a/cyberdrop_dl/env.py
+++ b/cyberdrop_dl/env.py
@@ -17,7 +17,7 @@ def _env(name: str, *, censor: bool = False) -> str | None:
RUNNING_IN_TERMUX = bool(
os.getenv("TERMUX_VERSION") or os.getenv("TERMUX_MAIN_PACKAGE_FORMAT") or "com.termux" in os.getenv("$PREFIX", "")
)
-PORTRAIT_MODE = bool(_env("PORTRAIT_MODE") or RUNNING_IN_TERMUX)
+FORCE_PORTRAIT_MODE = bool(_env("PORTRAIT_MODE") or RUNNING_IN_TERMUX)
DEBUG_LOG_FOLDER = _env("DEBUG_LOG_FOLDER")
diff --git a/cyberdrop_dl/progress/__init__.py b/cyberdrop_dl/progress/__init__.py
index 4b467f018..234d83020 100644
--- a/cyberdrop_dl/progress/__init__.py
+++ b/cyberdrop_dl/progress/__init__.py
@@ -2,6 +2,7 @@ from __future__ import annotations
import contextlib
import dataclasses
+import shutil
import sys
from abc import ABC, abstractmethod
from contextvars import ContextVar
@@ -9,7 +10,9 @@ from enum import auto
from typing import TYPE_CHECKING, Any, Protocol, Self
from rich.progress import Progress, Task, TaskID
+from rich.text import Text
+from cyberdrop_dl import env
from cyberdrop_dl.compat import CIStrEnum
from cyberdrop_dl.logs import disable_console_logging
@@ -19,10 +22,10 @@ if TYPE_CHECKING:
from rich.console import RenderableType
from rich.live import Live
- from rich.text import Text
REFRESH_RATE: ContextVar[float] = ContextVar("REFRESH_RATE", default=10.0)
TUI_DISABLED: ContextVar[bool] = ContextVar("TUI_DISABLED", default=False)
+_in_portrait: bool = False
class Color:
@@ -47,6 +50,36 @@ class JsonableRenderableType(Protocol):
def __json__(self) -> Any: ...
+class DisabledInPortraitMixin:
+ def render(self, task: Task) -> Text:
+ if _in_portrait:
+ return Text("")
+ return super().render(task) # pyright: ignore[reportUnknownMemberType, reportUnknownVariableType, reportAttributeAccessIssue]
+
+
+def _is_terminal_in_portrait() -> bool:
+
+ if env.FORCE_PORTRAIT_MODE:
+ return True
+
+ terminal_size = shutil.get_terminal_size()
+ width, height = terminal_size.columns, terminal_size.lines
+ aspect_ratio = width / height
+
+ # High aspect ratios are likely to be in landscape mode
+ if aspect_ratio >= 3.2:
+ return False
+
+ # Check for mobile device in portrait mode, Assume landscape mode for other cases
+ return (aspect_ratio < 1.5 and height >= 40) or (aspect_ratio < 2.3 and width <= 85)
+
+
+def is_terminal_in_portrait() -> bool:
+ global _in_portrait # noqa: PLW0603
+ _in_portrait = _is_terminal_in_portrait()
+ return _in_portrait
+
+
def create_test_live(renderable: JsonableRenderableType, *, transient: bool = False, json: bool = True) -> Live:
from rich.json import JSON
from rich.live import Live
diff --git a/cyberdrop_dl/progress/scraping/__init__.py b/cyberdrop_dl/progress/scraping/__init__.py
index b0de5aa2c..c0d8482f0 100644
--- a/cyberdrop_dl/progress/scraping/__init__.py
+++ b/cyberdrop_dl/progress/scraping/__init__.py
@@ -4,7 +4,6 @@ import asyncio
import contextlib
import dataclasses
import json
-import shutil
import sys
import time
from contextvars import ContextVar
@@ -15,7 +14,7 @@ from rich.console import Group, RenderableType
from rich.layout import Layout
from cyberdrop_dl import env
-from cyberdrop_dl.progress import LiveUI, UIOptions
+from cyberdrop_dl.progress import LiveUI, UIOptions, is_terminal_in_portrait
from cyberdrop_dl.progress.scraping.downloads import DownloadsPanel
from cyberdrop_dl.progress.scraping.errors import DownloadErrorsPanel, ScrapeErrorsPanel
from cyberdrop_dl.progress.scraping.files import FileStatsPanel
@@ -38,7 +37,7 @@ class Screen:
return iter((self.horizontal, self.vertical))
def __rich__(self) -> Layout:
- return self.vertical if terminal_is_in_portrait() else self.horizontal
+ return self.vertical if is_terminal_in_portrait() else self.horizontal
@dataclasses.dataclass(slots=True)
@@ -109,8 +108,8 @@ class ScrapingUI(LiveUI):
vertical.split_column(
Layout(self.files, name="files", size=9),
- Layout(self.scrape_errors, name="scrape_errors"),
- Layout(self.download_errors, name="download_errors"),
+ Layout(self.scrape_errors, name="scrape_errors", minimum_size=4),
+ Layout(self.download_errors, name="download_errors", minimum_size=4),
*bottom,
)
@@ -167,23 +166,6 @@ class ScrapingUI(LiveUI):
await asyncio.sleep(3)
-def terminal_is_in_portrait() -> bool:
-
- if env.PORTRAIT_MODE:
- return True
-
- terminal_size = shutil.get_terminal_size()
- width, height = terminal_size.columns, terminal_size.lines
- aspect_ratio = width / height
-
- # High aspect ratios are likely to be in landscape mode
- if aspect_ratio >= 3.2:
- return False
-
- # Check for mobile device in portrait mode, Assume landscape mode for other cases
- return (aspect_ratio < 1.5 and height >= 40) or (aspect_ratio < 2.3 and width <= 85)
-
-
@contextlib.contextmanager
def show_msg(msg: object) -> Generator[None]:
with _STATUS.get()(msg):
diff --git a/cyberdrop_dl/progress/scraping/downloads.py b/cyberdrop_dl/progress/scraping/downloads.py
index ae2f1e1ce..e0d27f000 100644
--- a/cyberdrop_dl/progress/scraping/downloads.py
+++ b/cyberdrop_dl/progress/scraping/downloads.py
@@ -26,7 +26,15 @@ from rich.table import Column
from rich.text import Text
from typing_extensions import override
-from cyberdrop_dl.progress import Color, DictProgress, ProgressHook, create_test_live, strip_markup, truncate_float
+from cyberdrop_dl.progress import (
+ Color,
+ DictProgress,
+ DisabledInPortraitMixin,
+ ProgressHook,
+ create_test_live,
+ strip_markup,
+ truncate_float,
+)
from cyberdrop_dl.progress.overflow import OverFlowPanel
if TYPE_CHECKING:
@@ -93,6 +101,12 @@ class AutoDownloadColumn(DownloadColumn):
return Text(download_status, style="progress.download", justify="right")
+class AutoTimeRemainingColumn(DisabledInPortraitMixin, TimeRemainingColumn): ...
+
+
+class AutoTextColumn(DisabledInPortraitMixin, TextColumn): ...
+
+
@final
class DownloadsPanel(OverFlowPanel):
unit: ClassVar[str] = "file"
@@ -104,7 +118,7 @@ class DownloadsPanel(OverFlowPanel):
def __init__(self, max_rows: int = 6) -> None:
super().__init__(
SpinnerColumn("dots3"),
- TextColumn(f"[{Color.PLUM}]" + "({task.fields[" + _DOMAIN_TASK_FIELD_NAME + "]})"),
+ AutoTextColumn(f"[{Color.PLUM}]" + "({task.fields[" + _DOMAIN_TASK_FIELD_NAME + "]})"),
AutoWidthTextColumn(
"[progress.description]{task.description}",
table_column=Column(justify="left", no_wrap=True),
@@ -115,8 +129,8 @@ class DownloadsPanel(OverFlowPanel):
AutoDownloadColumn(table_column=Column(justify="right", no_wrap=True)),
"•",
AutoTransferSpeedColumn(table_column=Column(justify="right", no_wrap=True, min_width=11)),
- "•",
- TimeRemainingColumn(
+ AutoTextColumn("•"),
+ AutoTimeRemainingColumn(
compact=True,
elapsed_when_finished=True,
table_column=Column(justify="right", no_wrap=True),