streamlink 7.2.0__tar.gz → 7.3.0__tar.gz

{streamlink-7.2.0 → streamlink-7.3.0}/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## streamlink 7.3.0 (2025-04-26)
+
+- Changed: download progress to use the console output stream rather than always `stderr`, which previously caused log and progress messages to be interweaved ([#6497](https://github.com/streamlink/streamlink/pull/6497), [#6496](https://github.com/streamlink/streamlink/pull/6496))
+- Changed: download progress output to be a status message line at the bottom of the console output, unless `--progress=force` is set in non-interactive or unsupported environments, in which case less frequent regular progress messages are written ([#6497](https://github.com/streamlink/streamlink/pull/6497), [#6496](https://github.com/streamlink/streamlink/pull/6496))
+- Fixed: potential division by zero error when formatting progress output ([#6498](https://github.com/streamlink/streamlink/pull/6498))
+- Build: bumped `setuptools` requirement from `>=65.6` to `>=77` and switched to PEP 639 project license metadata format ([#6502](https://github.com/streamlink/streamlink/pull/6502))
+
+[Full changelog](https://github.com/streamlink/streamlink/compare/7.2.0...7.3.0)
+
+
 ## streamlink 7.2.0 (2025-04-04)
 
 - Added: `decompress` extras marker to Streamlink's optional dependencies for installing `brotli` and `zstandard`, which were previously implied optional dependencies via the transitive dependency `urllib3` ([#6451](https://github.com/streamlink/streamlink/pull/6451))

{streamlink-7.2.0 → streamlink-7.3.0}/PKG-INFO

@@ -1,17 +1,16 @@
 Metadata-Version: 2.4
 Name: streamlink
-Version: 7.2.0
+Version: 7.3.0
 Summary: Streamlink is a command-line utility that extracts streams from various services and pipes them into a video player of choice.
 Author: Streamlink
 Author-email: streamlink@protonmail.com
-License: Simplified BSD
+License-Expression: BSD-2-Clause
 Project-URL: Homepage, https://github.com/streamlink/streamlink
 Project-URL: Documentation, https://streamlink.github.io/
 Project-URL: Tracker, https://github.com/streamlink/streamlink/issues
 Project-URL: Source, https://github.com/streamlink/streamlink
 Project-URL: Funding, https://streamlink.github.io/latest/support.html
 Classifier: Development Status :: 5 - Production/Stable
-Classifier: License :: OSI Approved :: BSD License
 Classifier: Environment :: Console
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: Operating System :: POSIX

{streamlink-7.2.0 → streamlink-7.3.0}/completions/bash/streamlink

@@ -130,6 +130,7 @@ _set_new_action() {
 #     ${!x} -> ${hello} -> "world"
 _shtab_streamlink_cli() {
   local completing_word="${COMP_WORDS[COMP_CWORD]}"
+  local previous_word="${COMP_WORDS[COMP_CWORD-1]}"
   local completed_positional_actions
   local current_action
   local current_action_args_start_index
@@ -186,6 +187,10 @@ _shtab_streamlink_cli() {
   if [[ $pos_only = 0 && "${completing_word}" == -* ]]; then
     # optional argument started: use option strings
     COMPREPLY=( $(compgen -W "${current_option_strings[*]}" -- "${completing_word}") )
+  elif [[ "${previous_word}" == ">" || "${previous_word}" == ">>" ||
+          "${previous_word}" =~ ^[12]">" || "${previous_word}" =~ ^[12]">>" ]]; then
+    # handle redirection operators
+    COMPREPLY=( $(compgen -f -- "${completing_word}") )
   else
     # use choices & compgen
     local IFS=$'\n' # items may contain spaces, so delimit using newline

{streamlink-7.2.0 → streamlink-7.3.0}/dev-requirements.txt

@@ -14,7 +14,7 @@ pytest-cov
 coverage[toml]
 
 # code-linting / code-formatting
-ruff ==0.11.2
+ruff ==0.11.5
 
 # typing
 mypy[faster-cache] ==1.15.0

{streamlink-7.2.0 → streamlink-7.3.0}/docs/_build/man/streamlink.1

@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
 ..
-.TH "STREAMLINK" "1" "Apr 04, 2025" "7.2.0" "Streamlink"
+.TH "STREAMLINK" "1" "Apr 26, 2025" "7.3.0" "Streamlink"
 .SH NAME
 streamlink \- extracts streams from various services and pipes them into a video player of choice
 .SH SYNOPSIS

{streamlink-7.2.0 → streamlink-7.3.0}/docs/changelog.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## streamlink 7.3.0 (2025-04-26)
+
+- Changed: download progress to use the console output stream rather than always `stderr`, which previously caused log and progress messages to be interweaved ([#6497](https://github.com/streamlink/streamlink/pull/6497), [#6496](https://github.com/streamlink/streamlink/pull/6496))
+- Changed: download progress output to be a status message line at the bottom of the console output, unless `--progress=force` is set in non-interactive or unsupported environments, in which case less frequent regular progress messages are written ([#6497](https://github.com/streamlink/streamlink/pull/6497), [#6496](https://github.com/streamlink/streamlink/pull/6496))
+- Fixed: potential division by zero error when formatting progress output ([#6498](https://github.com/streamlink/streamlink/pull/6498))
+- Build: bumped `setuptools` requirement from `>=65.6` to `>=77` and switched to PEP 639 project license metadata format ([#6502](https://github.com/streamlink/streamlink/pull/6502))
+
+[Full changelog](https://github.com/streamlink/streamlink/compare/7.2.0...7.3.0)
+
+
 ## streamlink 7.2.0 (2025-04-04)
 
 - Added: `decompress` extras marker to Streamlink's optional dependencies for installing `brotli` and `zstandard`, which were previously implied optional dependencies via the transitive dependency `urllib3` ([#6451](https://github.com/streamlink/streamlink/pull/6451))

{streamlink-7.2.0 → streamlink-7.3.0}/docs/developing.rst

@@ -122,7 +122,7 @@ performing these checks locally avoids unnecessary build failures.
 Code style
 ----------
 
-Streamlink uses `Ruff`_ as primary code `linting <Ruff-linter>`_ and `formatting <Ruff-formatter>`_ tool.
+Streamlink uses `Ruff`_ as primary code `linting <Ruff-linter_>`_ and `formatting <Ruff-formatter_>`_ tool.
 
 The project aims to use best practices for achieving great code readability with minimal git diffs,
 as detailed in :pep:`8` and implemented in related linting and formatting tools, such as `Black`_.

{streamlink-7.2.0 → streamlink-7.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [build-system]
 requires = [
-  "setuptools >=65.6",
+  "setuptools >=77",
   "wheel",
   # The versioningit build-requirement gets removed from the source distribution,
   # as the version string is already built into it (see the onbuild versioningit hook):
@@ -20,14 +20,14 @@ description = """\
 Streamlink is a command-line utility that extracts streams from various services and pipes them into a video player of choice.\
 """
 readme = "README.md"
-license = { text = "Simplified BSD" }
+license = "BSD-2-Clause"
+license-files = ["LICENSE"]
 authors = [
   { name = "Streamlink" },
   { email = "streamlink@protonmail.com" }
 ]
 classifiers = [
   "Development Status :: 5 - Production/Stable",
-  "License :: OSI Approved :: BSD License",
   "Environment :: Console",
   "Intended Audience :: End Users/Desktop",
   "Operating System :: POSIX",
@@ -88,9 +88,6 @@ Funding = "https://streamlink.github.io/latest/support.html"
 # https://setuptools.pypa.io/en/stable/userguide/pyproject_config.html
 # https://setuptools.pypa.io/en/stable/userguide/package_discovery.html
 # https://setuptools.pypa.io/en/stable/userguide/datafiles.html
-[tool.setuptools]
-license-files = ["LICENSE"]
-
 [tool.setuptools.packages.find]
 where = ["src"]
 namespaces = false

{streamlink-7.2.0 → streamlink-7.3.0}/setup.py

@@ -97,5 +97,5 @@ if __name__ == "__main__":
         cmdclass=get_cmdclasses(cmdclass),
         entry_points=entry_points,
         data_files=data_files,
-        version="7.2.0",
+        version="7.3.0",
     )

streamlink-7.3.0/src/streamlink/_version.py

@@ -0,0 +1 @@
+__version__ = "7.3.0"

{streamlink-7.2.0 → streamlink-7.3.0}/src/streamlink/plugins/twitcasting.py

@@ -129,7 +129,11 @@ class TwitCasting(Plugin):
         if websocket:
             yield from self._get_streams_websocket(websocket)
         if hls:
-            yield from self._get_streams_hls(hls)
+            try:
+                yield from self._get_streams_hls(hls)
+            except OSError:
+                if not websocket:
+                    raise
 
 
 class TwitCastingWsClient(WebsocketClient):

{streamlink-7.2.0 → streamlink-7.3.0}/src/streamlink/validate/__init__.py

@@ -1,4 +1,4 @@
-# ruff: noqa: A001, A004, I001
+# ruff: noqa: A004, I001
 # order the module members logically (autodoc_member_order == "bysource")
 
 from streamlink.validate._validate import (

{streamlink-7.2.0 → streamlink-7.3.0}/src/streamlink.egg-info/PKG-INFO

@@ -1,17 +1,16 @@
 Metadata-Version: 2.4
 Name: streamlink
-Version: 7.2.0
+Version: 7.3.0
 Summary: Streamlink is a command-line utility that extracts streams from various services and pipes them into a video player of choice.
 Author: Streamlink
 Author-email: streamlink@protonmail.com
-License: Simplified BSD
+License-Expression: BSD-2-Clause
 Project-URL: Homepage, https://github.com/streamlink/streamlink
 Project-URL: Documentation, https://streamlink.github.io/
 Project-URL: Tracker, https://github.com/streamlink/streamlink/issues
 Project-URL: Source, https://github.com/streamlink/streamlink
 Project-URL: Funding, https://streamlink.github.io/latest/support.html
 Classifier: Development Status :: 5 - Production/Stable
-Classifier: License :: OSI Approved :: BSD License
 Classifier: Environment :: Console
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: Operating System :: POSIX

{streamlink-7.2.0 → streamlink-7.3.0}/src/streamlink.egg-info/SOURCES.txt

@@ -314,13 +314,21 @@ src/streamlink_cli/__main__.py
 src/streamlink_cli/_parser.py
 src/streamlink_cli/argparser.py
 src/streamlink_cli/compat.py
-src/streamlink_cli/console.py
 src/streamlink_cli/constants.py
 src/streamlink_cli/exceptions.py
 src/streamlink_cli/main.py
 src/streamlink_cli/py.typed
 src/streamlink_cli/show_matchers.py
 src/streamlink_cli/streamrunner.py
+src/streamlink_cli/console/__init__.py
+src/streamlink_cli/console/console.py
+src/streamlink_cli/console/progress.py
+src/streamlink_cli/console/stream.py
+src/streamlink_cli/console/stream_wrapper.py
+src/streamlink_cli/console/stream_wrapper.pyi
+src/streamlink_cli/console/terminal.py
+src/streamlink_cli/console/user_input.py
+src/streamlink_cli/console/windows.py
 src/streamlink_cli/output/__init__.py
 src/streamlink_cli/output/abc.py
 src/streamlink_cli/output/file.py
@@ -330,7 +338,6 @@ src/streamlink_cli/utils/__init__.py
 src/streamlink_cli/utils/formatter.py
 src/streamlink_cli/utils/path.py
 src/streamlink_cli/utils/player.py
-src/streamlink_cli/utils/progress.py
 src/streamlink_cli/utils/versioncheck.py
 tests/__init__.py
 tests/conftest.py
@@ -348,8 +355,14 @@ tests/test_validate.py
 tests/cli/__init__.py
 tests/cli/test_argparser.py
 tests/cli/test_compat.py
-tests/cli/test_console.py
 tests/cli/test_streamrunner.py
+tests/cli/console/__init__.py
+tests/cli/console/test_console.py
+tests/cli/console/test_progress.py
+tests/cli/console/test_stream.py
+tests/cli/console/test_stream_wrapper.py
+tests/cli/console/test_terminal.py
+tests/cli/console/test_windows.py
 tests/cli/main/__init__.py
 tests/cli/main/conftest.py
 tests/cli/main/test_can_handle_url.py
@@ -372,7 +385,6 @@ tests/cli/utils/__init__.py
 tests/cli/utils/test_formatter.py
 tests/cli/utils/test_path.py
 tests/cli/utils/test_player.py
-tests/cli/utils/test_progress.py
 tests/cli/utils/test_versioncheck.py
 tests/mixins/__init__.py
 tests/mixins/stream_hls.py

streamlink-7.3.0/src/streamlink_cli/console/__init__.py

@@ -0,0 +1,3 @@
+from streamlink_cli.console.console import ConsoleOutput
+from streamlink_cli.console.stream import ConsoleOutputStream
+from streamlink_cli.console.user_input import ConsoleUserInputRequester

{streamlink-7.2.0/src/streamlink_cli → streamlink-7.3.0/src/streamlink_cli/console}/console.py

@@ -6,44 +6,31 @@ from getpass import getpass
 from json import dumps
 from typing import Any, TextIO
 
-from streamlink.user_input import UserInputRequester
+from streamlink_cli.console.stream import ConsoleOutputStream, ConsoleStatusMessage
 from streamlink_cli.utils import JSONEncoder
 
 
-class ConsoleUserInputRequester(UserInputRequester):
-    """
-    Request input from the user on the console using the standard ask/askpass methods
-    """
-
-    def __init__(self, console: ConsoleOutput):
-        self.console = console
-
-    def ask(self, prompt: str) -> str:
-        return self.console.ask(f"{prompt.strip()}: ")
-
-    def ask_password(self, prompt: str) -> str:
-        return self.console.ask_password(f"{prompt.strip()}: ")
-
-
 class ConsoleOutput:
     def __init__(
         self,
         *,
-        console_output: TextIO | None = None,
+        console_output: ConsoleOutputStream | None = None,
         file_output: TextIO | None = None,
         json: bool = False,
     ):
         self.json: bool = json
-        self._console_output: TextIO | None = console_output
+        self._console_output: ConsoleOutputStream | None = console_output
+        self._supports_status_messages: bool = console_output is not None and console_output.supports_status_messages()
         self._file_output: TextIO | None = file_output
 
     @property
-    def console_output(self) -> TextIO | None:
+    def console_output(self) -> ConsoleOutputStream | None:
         return self._console_output
 
     @console_output.setter
-    def console_output(self, console_output: TextIO | None) -> None:
+    def console_output(self, console_output: ConsoleOutputStream | None) -> None:
         self._console_output = console_output
+        self._supports_status_messages = console_output is not None and console_output.supports_status_messages()
 
     @property
     def file_output(self) -> TextIO | None:
@@ -56,14 +43,34 @@ class ConsoleOutput:
         else:
             self._file_output = file_output
 
+    def supports_status_messages(self) -> bool:
+        return self._supports_status_messages
+
+    def close(self):
+        if self._console_output:  # pragma: no branch
+            with suppress(OSError):
+                self._console_output.close()
+            self._console_output.restore()
+        if self._file_output:  # pragma: no branch
+            with suppress(OSError):
+                self._file_output.close()
+
     @staticmethod
-    def _write(stream: TextIO | None, msg: str):
-        if stream is None:
-            return
+    def _write(stream: TextIO, msg: str):
         with suppress(OSError):
             stream.write(msg)
             stream.flush()
 
+    def _write_console(self, msg: str):
+        if self._console_output is None:
+            return
+        self._write(self._console_output, msg)
+
+    def _write_file(self, msg: str):
+        if self._file_output is None:
+            return
+        self._write(self._file_output, msg)
+
     @contextmanager
     def _prompt(self):
         if not sys.stdin or not sys.stdin.isatty():
@@ -80,7 +87,7 @@ class ConsoleOutput:
 
     def ask(self, prompt: str) -> str:
         with self._prompt():
-            self._write(self._console_output, prompt)
+            self._write_console(prompt)
             return input().strip()
 
     def ask_password(self, prompt: str) -> str:
@@ -91,8 +98,13 @@ class ConsoleOutput:
         if self.json:
             return
         msg = f"{msg}\n"
-        self._write(self._console_output, msg)
-        self._write(self._file_output, msg)
+        self._write_console(msg)
+        self._write_file(msg)
+
+    def msg_status(self, msg: str) -> None:
+        if self.json or not self._supports_status_messages:
+            return
+        self._write_console(ConsoleStatusMessage(msg))
 
     def msg_json(self, *objs: Any, **keywords: Any) -> None:
         if not self.json:
@@ -124,11 +136,8 @@ class ConsoleOutput:
             # don't escape Unicode characters outside the ASCII range if the output encoding is UTF-8
             ensure_ascii = self._console_output.encoding != "utf-8"
             msg = dumps(out, cls=JSONEncoder, ensure_ascii=ensure_ascii, indent=2)
-            self._write(self._console_output, f"{msg}\n")
+            self._write_console(f"{msg}\n")
 
         if self._file_output is not None:
             msg = dumps(out, cls=JSONEncoder, ensure_ascii=False, indent=2)
             self._write(self._file_output, f"{msg}\n")
-
-
-__all__ = ["ConsoleOutput", "ConsoleUserInputRequester"]

{streamlink-7.2.0/src/streamlink_cli/utils → streamlink-7.3.0/src/streamlink_cli/console}/progress.py

@@ -5,13 +5,13 @@ from collections import deque
 from collections.abc import Callable, Iterable, Mapping
 from math import floor
 from pathlib import PurePath
-from shutil import get_terminal_size
 from string import Formatter as StringFormatter
 from threading import Event, RLock, Thread
 from time import time
-from typing import TYPE_CHECKING, TextIO
+from typing import TYPE_CHECKING
 
-from streamlink.compat import is_win32
+from streamlink_cli.console.console import ConsoleOutput
+from streamlink_cli.console.terminal import cut_text, term_width, text_width
 
 
 if TYPE_CHECKING:
@@ -49,82 +49,9 @@ class ProgressFormatter:
     # Use U+2026 (HORIZONTAL ELLIPSIS) to be able to distinguish between "." and ".." when truncating relative paths
     ELLIPSIS: str = "…"
 
-    # widths generated from
-    # https://www.unicode.org/Public/4.0-Update/EastAsianWidth-4.0.0.txt
-    # See https://github.com/streamlink/streamlink/pull/2032
-    WIDTHS: Iterable[tuple[int, int]] = (
-        (13, 1),
-        (15, 0),
-        (126, 1),
-        (159, 0),
-        (687, 1),
-        (710, 0),
-        (711, 1),
-        (727, 0),
-        (733, 1),
-        (879, 0),
-        (1154, 1),
-        (1161, 0),
-        (4347, 1),
-        (4447, 2),
-        (7467, 1),
-        (7521, 0),
-        (8369, 1),
-        (8426, 0),
-        (9000, 1),
-        (9002, 2),
-        (11021, 1),
-        (12350, 2),
-        (12351, 1),
-        (12438, 2),
-        (12442, 0),
-        (19893, 2),
-        (19967, 1),
-        (55203, 2),
-        (63743, 1),
-        (64106, 2),
-        (65039, 1),
-        (65059, 0),
-        (65131, 2),
-        (65279, 1),
-        (65376, 2),
-        (65500, 1),
-        (65510, 2),
-        (120831, 1),
-        (262141, 2),
-        (1114109, 1),
-    )
-
-    # On Windows, we need one less space, or we overflow the line for some reason.
-    gap = 1 if is_win32 else 0
-
-    @classmethod
-    def term_width(cls):
-        return get_terminal_size().columns - cls.gap
-
-    @classmethod
-    def _get_width(cls, ordinal: int) -> int:
-        """Return the width of a specific unicode character when it would be displayed."""
-        return next((width for unicode, width in cls.WIDTHS if ordinal <= unicode), 1)
-
-    @classmethod
-    def width(cls, value: str):
-        """Return the overall width of a string when it would be displayed."""
-        return sum(map(cls._get_width, map(ord, value)))
-
-    @classmethod
-    def cut(cls, value: str, max_width: int) -> str:
-        """Cut off the beginning of a string until its display width fits into the output size."""
-        current = value
-        for i in range(len(value)):  # pragma: no branch
-            current = value[i:]
-            if cls.width(current) <= max_width:
-                break
-        return current
-
     @classmethod
     def format(cls, formats: _TFormat, params: Mapping[str, str | Callable[[int], str]]) -> str:
-        term_width = cls.term_width()
+        width = term_width()
         static: list[str] = []
         variable: list[tuple[int, Callable[[int], str], int]] = []
 
@@ -151,13 +78,13 @@ class ProgressFormatter:
             else:
                 # No variable segments? Just check if the resulting string fits into the size constraints.
                 if not variable:
-                    if length > term_width:
+                    if length > width:
                         continue
                     else:
                         break
 
                 # Get the available space for each variable segment (share space equally and round down).
-                max_width = int((term_width - length) / len(variable))
+                max_width = int((width - length) / len(variable))
                 # If at least one variable segment doesn't fit, continue with the next format.
                 if max_width < 1 or any(max_width < min_width for _, __, min_width in variable):
                     continue
@@ -204,17 +131,17 @@ class ProgressFormatter:
     def format_path(cls, path: PurePath, max_width: int) -> str:
         # Quick check if the path fits
         string = str(path)
-        width = cls.width(string)
+        width = text_width(string)
         if width <= max_width:
             return string
 
         # Since the path doesn't fit, we always need to add an ellipsis.
         # On Windows, we also need to add the "drive" part (which is an empty string on PurePosixPath)
-        max_width -= cls.width(path.drive) + cls.width(cls.ELLIPSIS)
+        max_width -= text_width(path.drive) + text_width(cls.ELLIPSIS)
 
         # Ignore the path's first part, aka the "anchor" (drive + root)
         parts = os.path.sep.join(path.parts[1:] if path.drive else path.parts)
-        truncated = cls.cut(parts, max_width)
+        truncated = cut_text(parts, max_width)
 
         return f"{path.drive}{cls.ELLIPSIS}{truncated}"
 
@@ -222,15 +149,15 @@ class ProgressFormatter:
 class Progress(Thread):
     def __init__(
         self,
-        stream: TextIO,
+        console: ConsoleOutput,
         path: PurePath,
         interval: float = 0.25,
         history: int = 20,
         threshold: int = 2,
+        status: bool = True,
     ):
         """
-        :param stream: The output stream
-        :param path: The path that's being written
+        :param console: The console output
         :param interval: Time in seconds between updates
         :param history: Number of seconds of how long download speed history is kept
         :param threshold: Number of seconds until download speed is shown
@@ -242,7 +169,7 @@ class Progress(Thread):
 
         self.formatter = ProgressFormatter()
 
-        self.stream: TextIO = stream
+        self.console: ConsoleOutput = console
         self.path: PurePath = path
         self.interval: float = interval
         self.history: deque[tuple[float, int]] = deque(maxlen=int(history / interval))
@@ -251,6 +178,7 @@ class Progress(Thread):
         self.started: float = 0.0
         self.overall: int = 0
         self.written: int = 0
+        self.status: bool = status
 
     def close(self):
         self._wait.set()
@@ -268,7 +196,6 @@ class Progress(Thread):
                 self.update()
         finally:
             self.update()
-            self.print_end()
 
     def update(self):
         with self._lock:
@@ -280,7 +207,7 @@ class Progress(Thread):
             self.written = 0
 
             has_history = len(history) >= self.threshold
-            if not has_history:
+            if not has_history or now == history[0][0]:
                 formats = formatter.FORMATS_NOSPEED
                 speed = ""
             else:
@@ -295,17 +222,7 @@ class Progress(Thread):
             )
 
             status = formatter.format(formats, params)
-
-            self.print_inplace(status)
-
-    def print_inplace(self, msg: str):
-        """Clears the previous line and prints a new one."""
-        term_width = self.formatter.term_width()
-        spacing = term_width - self.formatter.width(msg)
-
-        self.stream.write(f"\r{msg}{' ' * max(0, spacing)}")
-        self.stream.flush()
-
-    def print_end(self):
-        self.stream.write("\n")
-        self.stream.flush()
+            if self.status:
+                self.console.msg_status(status)
+            else:
+                self.console.msg(status)