subliminal 2.4.0__tar.gz → 2.5.0__tar.gz

{subliminal-2.4.0 → subliminal-2.5.0}/.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
       - id: check-toml
       - id: check-yaml
@@ -8,12 +8,12 @@ repos:
       - id: end-of-file-fixer
 
   - repo: https://github.com/crate-ci/typos
-    rev: v1.33.1
+    rev: v1.40.0
     hooks:
       - id: typos
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.12.1
+    rev: v0.14.9
     hooks:
       - id: ruff
         args: [--fix, --unsafe-fixes]
@@ -33,7 +33,7 @@ repos:
         require_serial: true
 
   - repo: https://github.com/woodruffw/zizmor-pre-commit
-    rev: v1.10.0
+    rev: v1.18.0
     hooks:
     - id: zizmor
 

{subliminal-2.4.0 → subliminal-2.5.0}/HISTORY.rst

@@ -2,6 +2,33 @@
 
 .. towncrier release notes start
 
+2.5.0 (2025-12-14)
+^^^^^^^^^^^^^^^^^^
+
+Provider Changes
+----------------
+
+- OpenSubtitlesCom: add a max_result_pages parameter to limit the number of result pages to speed up the search (`#1321 <https://github.com/Diaoul/subliminal/issues/1321>`__)
+
+
+Documentation
+-------------
+
+- fix ``generate_default_config`` for ``click==8.3`` and pin to ``click<8.3`` until another regression is fixed. (`#1318 <https://github.com/Diaoul/subliminal/issues/1318>`__)
+
+
+Misc
+----
+
+- add support for python 3.14 (`#1317 <https://github.com/Diaoul/subliminal/issues/1317>`__)
+- Fix test with click 8.3.0 running in parallel (`#1320 <https://github.com/Diaoul/subliminal/issues/1320>`__)
+- fix test on big-endian system (`#1323 <https://github.com/Diaoul/subliminal/issues/1323>`__)
+- compatibility with stevedore 5.6.0 (`#1325 <https://github.com/Diaoul/subliminal/issues/1325>`__)
+- fix some tests to pass in a dirty environment (`#1326 <https://github.com/Diaoul/subliminal/issues/1326>`__)
+- update pre-commit hook versions (`#1329 <https://github.com/Diaoul/subliminal/issues/1329>`__)
+- Fix some test so they are more reliable and stable (`#1331 <https://github.com/Diaoul/subliminal/issues/1331>`__)
+
+
 2.4.0 (2025-09-03)
 ^^^^^^^^^^^^^^^^^^
 

{subliminal-2.4.0 → subliminal-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: subliminal
-Version: 2.4.0
+Version: 2.5.0
 Summary: Subtitles, faster than your thoughts
 Project-URL: homepage, https://github.com/Diaoul/subliminal
 Project-URL: repository, https://github.com/Diaoul/subliminal
@@ -21,14 +21,15 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Multimedia :: Video
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.9
 Requires-Dist: babelfish>=0.6.1
 Requires-Dist: beautifulsoup4>=4.4.0
 Requires-Dist: chardet>=5.0
+Requires-Dist: click
 Requires-Dist: click-option-group>=0.5.6
-Requires-Dist: click>=8.0
 Requires-Dist: defusedxml>=0.7.1
 Requires-Dist: dogpile-cache>=1.0
 Requires-Dist: guessit>=3.0.0

{subliminal-2.4.0 → subliminal-2.5.0}/docs/user/configuration_file.rst

@@ -24,6 +24,10 @@ CLI arguments (like ``path``) cannot be specified in the configuration file.
 
 Options that can be used multiple times (like ``--language``) need to be defined as arrays.
 
+``hearing_impaired`` and ``foreign_only`` can take three values: "true", "false" or "[]".
+They mean that hearing impaired (or foreign-only) subtitles will be, respectively,
+ranked first, ranked last or not given any particular rank, for subtitles with identical scores.
+
 
 Example
 -------

{subliminal-2.4.0 → subliminal-2.5.0}/hatch.toml

@@ -80,7 +80,7 @@ description = "Run the tests suite"
 features = ["tests"]
 
 [[envs.tests.matrix]]
-python = ["3.9", "3.10", "3.11", "3.12", "3.13"]
+python = ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
 
 [envs.tests.env-vars]
 COVERAGE_PROCESS_START = "pyproject.toml"

{subliminal-2.4.0 → subliminal-2.5.0}/pyproject.toml

@@ -29,6 +29,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Topic :: Software Development :: Libraries :: Python Modules",
     "Topic :: Multimedia :: Video",
 ]
@@ -38,7 +39,7 @@ dependencies = [
     "beautifulsoup4>=4.4.0",
     "defusedxml>=0.7.1",
     "chardet>=5.0",
-    "click>=8.0",
+    "click",
     "click-option-group>=0.5.6",
     "dogpile.cache>=1.0",
     "guessit>=3.0.0",

{subliminal-2.4.0 → subliminal-2.5.0}/src/subliminal/cli/generate_config.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import logging
+from typing import Any
 
 import click
 import tomlkit
@@ -13,6 +14,61 @@ from .cli import subliminal
 logger = logging.getLogger(__name__)
 
 
+def _validate(name: str, value: Any) -> str | None:
+    """Validate the value to be sure it is a valid TOML value.
+
+    E.g., Sentinel.UNSET was introduced in click 8.3 to be used as default value
+    and it is not convertible to valid TOML.
+    """
+    # Create a stub table to try importing the key and value
+    stub = tomlkit.table()
+    try:
+        stub.add(name, value)
+    except (ValueError, tomlkit.exceptions.ConvertError):
+        return None
+
+    return stub.as_string().strip('\n')
+
+
+def _add_value_to_table(
+    opt: click.Option,
+    table: tomlkit.items.Table,
+    *,
+    name: str | None = None,
+    commented: bool = True,
+) -> str | None:
+    """Add a value to a TOML table."""
+    if opt.name is None:  # pragma: no cover
+        return None
+    # Override option name
+    opt_name = name if name is not None else opt.name
+
+    # Add the description of the option as a comment above
+    if opt.help:
+        table.add(tomlkit.comment(opt.help.capitalize()))
+
+    # Add the option name with default value
+    if opt.default is None:
+        # None value is not defined in TOML, it needs to be a comment
+        table.add(tomlkit.comment(f'{opt_name} = '))
+
+    elif (validated := _validate(opt_name, opt.default)) is not None:
+        # The default value is valid TOML
+        if commented:
+            # Add the string to the final table as a comment
+            table.add(tomlkit.comment(validated))
+        else:
+            # Add the key and valid value to the table
+            table.add(opt_name, opt.default)
+
+    else:
+        # The default value is not valid TOML, add a comment
+        table.add(tomlkit.comment(f'{opt_name} = '))
+
+    # Return the key to keep track of duplicates
+    return opt_name
+
+
 def generate_default_config(*, compact: bool = True, commented: bool = True) -> str:
     """Generate a default configuration file.
 
@@ -20,31 +76,6 @@ def generate_default_config(*, compact: bool = True, commented: bool = True) ->
     :param commented: if True, all the options are commented out.
     :return: the default configuration as a string.
     """
-
-    def add_value_to_table(opt: click.Option, table: tomlkit.items.Table, *, name: str | None = None) -> str | None:
-        """Add a value to a TOML table."""
-        if opt.name is None:  # pragma: no cover
-            return None
-        # Override option name
-        opt_name = name if name is not None else opt.name
-
-        table.add(tomlkit.comment((opt.help or opt_name).capitalize()))
-        # table.add(tomlkit.comment(f'{opt_name} = {opt.default}'))
-        if opt.default is not None:
-            if not commented:
-                table.add(opt_name, opt.default)
-            else:
-                # Generate the entry in a dumb table
-                dumb = tomlkit.table()
-                dumb.add(opt_name, opt.default)
-                # Add the string to the final table as a comment
-                table.add(tomlkit.comment(dumb.as_string().strip('\n')))
-        else:
-            table.add(tomlkit.comment(f'{opt_name} = '))
-
-        # Return the key to keep track of duplicates
-        return opt_name
-
     # Create TOML document
     doc = tomlkit.document()
     doc.add(tomlkit.comment('Subliminal default configuration file'))
@@ -62,7 +93,7 @@ def generate_default_config(*, compact: bool = True, commented: bool = True) ->
         if opt.name in ['version', 'config']:
             continue
         # Add key=value to table
-        add_value_to_table(opt, default)
+        _add_value_to_table(opt, default, commented=commented)
         if not compact:  # pragma: no cover
             default.add(tomlkit.nl())
     # Adding the table to the document
@@ -85,7 +116,7 @@ def generate_default_config(*, compact: bool = True, commented: bool = True) ->
                 # Duplicated option
                 continue
             # Add key=value to table
-            opt_name = add_value_to_table(opt, com_table)
+            opt_name = _add_value_to_table(opt, com_table, commented=commented)
             if opt_name is not None:
                 existing_options.add(opt_name)
             if not compact:  # pragma: no cover
@@ -114,7 +145,7 @@ def generate_default_config(*, compact: bool = True, commented: bool = True) ->
                 continue
 
             # Add key=value to table
-            add_value_to_table(opt, provider_table, name=opt_name)
+            _add_value_to_table(opt, provider_table, name=opt_name, commented=commented)
             if not compact:  # pragma: no cover
                 provider_table.add(tomlkit.nl())
 

{subliminal-2.4.0 → subliminal-2.5.0}/src/subliminal/core.py

@@ -131,12 +131,12 @@ class ProviderPool:
 
         """
         # check video validity
-        if not provider_manager[provider].plugin.check(video):
+        if not provider_manager[provider].plugin.check(video):  # type: ignore[attr-defined]
             logger.info('Skipping provider %r: not a valid video', provider)
             return []
 
         # check supported languages
-        provider_languages = provider_manager[provider].plugin.check_languages(languages)
+        provider_languages = provider_manager[provider].plugin.check_languages(languages)  # type: ignore[attr-defined]
         if not provider_languages:
             logger.info('Skipping provider %r: no language to search for', provider)
             return []

{subliminal-2.4.0 → subliminal-2.5.0}/src/subliminal/extensions.py

@@ -2,15 +2,18 @@
 
 from __future__ import annotations
 
+import inspect
 import re
 from importlib.metadata import EntryPoint
 from typing import TYPE_CHECKING, Any
 
-from stevedore import ExtensionManager  # type: ignore[import-untyped]
+from stevedore import ExtensionManager
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
 
+    from stevedore.extension import Extension
+
 
 class RegistrableExtensionManager(ExtensionManager):
     """:class:`stevedore.extension.ExtensionManager` with support for registration.
@@ -29,16 +32,21 @@ class RegistrableExtensionManager(ExtensionManager):
 
     """
 
+    #: Registered extensions with entry point syntax
     registered_extensions: list[str]
+
+    #: Internal extensions with entry point syntax
     internal_extensions: list[str]
 
+    _old_api: bool
+
     def __init__(self, namespace: str, internal_extensions: Sequence[str], **kwargs: Any) -> None:
-        #: Registered extensions with entry point syntax
         self.registered_extensions = []
-
-        #: Internal extensions with entry point syntax
         self.internal_extensions = list(internal_extensions)
 
+        # 'verify_requirements' argument was remove in stevedore version 5.6.0
+        self._old_api = 'verify_requirements' in inspect.signature(self._load_one_plugin).parameters
+
         super().__init__(namespace, **kwargs)
 
     def list_entry_points(self) -> list[EntryPoint]:
@@ -60,6 +68,25 @@ class RegistrableExtensionManager(ExtensionManager):
 
         return eps
 
+    def __compat_load_one_plugin(self, ep: EntryPoint) -> Extension | None:  # pragma: no cover
+        if self._old_api:
+            # The 'verify_requirements' argument is needed
+            return self._load_one_plugin(  # type: ignore[call-arg]
+                ep,
+                invoke_on_load=False,
+                invoke_args=(),  # type: ignore[arg-type]
+                invoke_kwds={},
+                verify_requirements=False,
+            )
+
+        # The 'verify_requirements' argument is forbidden
+        return self._load_one_plugin(  # type: ignore[call-arg]
+            ep,
+            invoke_on_load=False,
+            invoke_args=(),  # type: ignore[arg-type]
+            invoke_kwds={},
+        )
+
     def register(self, entry_point: str) -> None:
         """Register an extension.
 
@@ -76,13 +103,10 @@ class RegistrableExtensionManager(ExtensionManager):
             msg = 'An extension with the same name already exist'
             raise ValueError(msg)
 
-        ext = self._load_one_plugin(
-            ep,
-            invoke_on_load=False,
-            invoke_args=(),
-            invoke_kwds={},
-            verify_requirements=False,
-        )
+        ext = self.__compat_load_one_plugin(ep)
+        if ext is None:  # pragma: no cover
+            return
+
         self.extensions.append(ext)
         if self._extensions_by_name is not None:  # pragma: no branch
             self._extensions_by_name[ext.name] = ext

{subliminal-2.4.0 → subliminal-2.5.0}/src/subliminal/providers/opensubtitles.py

@@ -171,8 +171,9 @@ class OpenSubtitlesSubtitle(Subtitle):
 class OpenSubtitlesProvider(Provider):
     """OpenSubtitles Provider.
 
-    :param str username: username.
-    :param str password: password.
+    :param str username: username
+    :param str password: password
+    :param int timeout: timeout in seconds. Default to 10.
 
     """
 
@@ -195,6 +196,7 @@ class OpenSubtitlesProvider(Provider):
         username: str | None = None,
         password: str | None = None,
         *,
+        max_result_pages: int = 0,
         timeout: int = 10,
     ) -> None:
         transport = TimeoutSafeTransport(timeout=timeout, user_agent='VLSub')
@@ -279,7 +281,7 @@ class OpenSubtitlesProvider(Provider):
             language = Language.fromopensubtitles(subtitle_item['SubLanguageID'])
             hearing_impaired = bool(int(subtitle_item['SubHearingImpaired']))
             page_link = subtitle_item['SubtitlesLink']
-            subtitle_id = int(subtitle_item['IDSubtitleFile'])
+            subtitle_id = str(int(subtitle_item['IDSubtitleFile']))
             matched_by = subtitle_item['MatchedBy']
             movie_kind = subtitle_item['MovieKind']
             moviehash = subtitle_item['MovieHash']

{subliminal-2.4.0 → subliminal-2.5.0}/src/subliminal/providers/opensubtitlescom.py

@@ -370,8 +370,13 @@ def requires_auth(func: C) -> C:
 class OpenSubtitlesComProvider(Provider):
     """OpenSubtitles.com Provider.
 
-    :param str username: username.
-    :param str password: password.
+    :param str username: username
+    :param str password: password
+    :param str apikey: private API key
+    :param int max_result_pages: maximum number of result pages to process,
+        set to non-zero to search faster, although the correct match can be
+        missing. Default to 0 (unlimited).
+    :param int timeout: timeout in seconds. Default to 20.
 
     """
 
@@ -385,6 +390,7 @@ class OpenSubtitlesComProvider(Provider):
     username: str | None
     password: str | None
     apikey: str
+    max_result_pages: int
     timeout: int
     token_expires_at: datetime | None
     session: Session | None
@@ -395,6 +401,7 @@ class OpenSubtitlesComProvider(Provider):
         password: str | None = None,
         *,
         apikey: str | None = None,
+        max_result_pages: int = 0,
         timeout: int = 20,
     ) -> None:
         if any((username, password)) and not all((username, password)):
@@ -404,6 +411,7 @@ class OpenSubtitlesComProvider(Provider):
         self.username = username
         self.password = password
         self.apikey = apikey or OPENSUBTITLESCOM_API_KEY
+        self.max_result_pages = max_result_pages
         self.timeout = timeout
         self.token_expires_at = None
         self.session = None
@@ -588,19 +596,25 @@ class OpenSubtitlesComProvider(Provider):
         return r.json()  # type: ignore[no-any-return]
 
     def _search(self, *, page: int = 1, **params: Any) -> list[dict[str, Any]]:
+        # Extended params with page
+        ext_params = {'page': page, **params}
+
         # query the server
-        logger.info('Searching subtitles %r', params)
+        logger.info('Searching subtitles %r', ext_params)
 
         # GET request and add page information
-        response = self.api_get('subtitles', {'page': page, **params})
+        response = self.api_get('subtitles', ext_params)
 
         if not response or not response['data']:
             return []
 
         ret = response['data']
 
+        # check that the maximum number of pages has not been exceeded
+        allow_more_pages = self.max_result_pages <= 0 or page < self.max_result_pages
+
         # retrieve other pages maybe
-        if 'total_pages' in response and page < response['total_pages']:
+        if allow_more_pages and 'total_pages' in response and page < response['total_pages']:
             # missing pages
             ret.extend(self._search(page=page + 1, **params))
 
@@ -642,7 +656,8 @@ class OpenSubtitlesComProvider(Provider):
         if query:
             criterion.update({'query': query.replace("'", '')})
 
-        if season and episode:
+        # Check for None to allow season=0 and episode=0
+        if season is not None and episode is not None:
             criterion.update({'season_number': season, 'episode_number': episode})
         if year:
             criterion.update({'year': year})

{subliminal-2.4.0 → subliminal-2.5.0}/src/subliminal/score.py

@@ -312,7 +312,7 @@ if WITH_SYMPY:  # pragma: no cover
         """
         hash, title, year, country, release_group = symbols('hash title year country release_group')  # noqa: A001
         streaming_service, fps, source, audio_codec = symbols('streaming_service fps source audio_codec')
-        resolution, video_codec, hearing_impaired = symbols('resolution video_codec hearing_impaired')
+        resolution, video_codec = symbols('resolution video_codec')
 
         equations = [
             # hash is best