subliminal 2.3.2__tar.gz → 2.4.0__tar.gz

{subliminal-2.3.2 → subliminal-2.4.0}/.github/workflows/publish-release.yaml

@@ -35,7 +35,6 @@ jobs:
         if: github.event_name == 'push'
         with:
           persist-credentials: false
-
       - name: Checkout
         uses: actions/checkout@v4
         if: |
@@ -44,34 +43,13 @@ jobs:
         with:
           ref: ${{ inputs.tag-name }}
           persist-credentials: false
-
       - name: Build dist
         uses: hynek/build-and-inspect-python-package@v2
         id: baipp
-
-      - name: Install tox
-        run: |
-          python -m pip install --upgrade pip
-          pip install --upgrade tox
-
-      - name: Generate Release Notes
-        env:
-          RELEASE_VERSION: ${{ steps.baipp.outputs.package_version }}
-        run: |
-          sudo apt-get install pandoc
-          # use package_version computed in step 'baipp'
-          tox -e generate-gh-release-notes -- "$RELEASE_VERSION" latest-release-notes.md
-
-      - name: Upload release notes
-        uses: actions/upload-artifact@v4
-        with:
-          name: latest-release-notes
-          path: latest-release-notes.md
-          include-hidden-files: false
-          if-no-files-found: error
     outputs:
       tag: ${{ steps.baipp.outputs.package_version }}
 
+
   github-release:
     name: Make a GitHub Release
     needs: [build-package]
@@ -96,15 +74,9 @@ jobs:
         with:
           name: Packages
           path: dist
-      - name: Download release notes
-        uses: actions/download-artifact@v4
-        with:
-          name: latest-release-notes
-          path: latest-release-notes.md
-
       - name: Publish GitHub Release
         uses: softprops/action-gh-release@v2
         with:
           files: dist/*
-          body_path: latest-release-notes.md
+          generate_release_notes: true
           draft: true

subliminal-2.4.0/.github/zizmor.yml

@@ -0,0 +1,13 @@
+rules:
+  dangerous-triggers:
+    ignore:
+      - coverage.yaml:3:1
+  unpinned-uses:
+    ignore:
+      - action.yaml
+      - CI.yaml
+      - coverage.yaml
+      - docker-build.yaml
+      - publish-release.yaml
+      - publish.yaml
+      - tag-release.yaml

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

@@ -8,12 +8,12 @@ repos:
       - id: end-of-file-fixer
 
   - repo: https://github.com/crate-ci/typos
-    rev: v1.30.3
+    rev: v1.33.1
     hooks:
       - id: typos
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.11.2
+    rev: v0.12.1
     hooks:
       - id: ruff
         args: [--fix, --unsafe-fixes]
@@ -26,14 +26,14 @@ repos:
         name: validate-pyproject
 
   - repo: https://github.com/PyCQA/doc8
-    rev: v1.1.2
+    rev: v2.0.0
     hooks:
       - id: doc8
         description: This hook runs doc8 for linting docs
         require_serial: true
 
   - repo: https://github.com/woodruffw/zizmor-pre-commit
-    rev: v1.5.2
+    rev: v1.10.0
     hooks:
     - id: zizmor
 

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

@@ -2,6 +2,33 @@
 
 .. towncrier release notes start
 
+2.4.0 (2025-09-03)
+^^^^^^^^^^^^^^^^^^
+
+Changes
+-------
+
+- score: add fps match, remove hearing_impaired match (`#1250 <https://github.com/Diaoul/subliminal/issues/1250>`__)
+
+
+CLI Changes
+-----------
+
+- cli: refactor the cli.py file into a folder (`#1299 <https://github.com/Diaoul/subliminal/issues/1299>`__)
+
+
+Documentation
+-------------
+
+- doc: add a section in the README to run subliminal with the ``--debug`` flag. (`#1308 <https://github.com/Diaoul/subliminal/issues/1308>`__)
+
+
+Misc
+----
+
+- ensure Episode.series is always a string, not a list from guessit bug (`#1304 <https://github.com/Diaoul/subliminal/issues/1304>`__)
+
+
 2.3.2 (2025-05-08)
 ^^^^^^^^^^^^^^^^^^
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: subliminal
-Version: 2.3.2
+Version: 2.4.0
 Summary: Subtitles, faster than your thoughts
 Project-URL: homepage, https://github.com/Diaoul/subliminal
 Project-URL: repository, https://github.com/Diaoul/subliminal
@@ -56,7 +56,6 @@ Provides-Extra: tests
 Requires-Dist: colorama; extra == 'tests'
 Requires-Dist: coverage[toml]>=7; extra == 'tests'
 Requires-Dist: importlib-metadata>=4.6; (python_version < '3.10') and extra == 'tests'
-Requires-Dist: pypandoc; extra == 'tests'
 Requires-Dist: pytest-cov; extra == 'tests'
 Requires-Dist: pytest-xdist; extra == 'tests'
 Requires-Dist: pytest>=6.0; extra == 'tests'
@@ -159,6 +158,14 @@ Run subliminal in a docker container::
 
     $ docker run --rm --name subliminal -v subliminal_cache:/usr/src/cache -v /tvshows:/tvshows -it ghcr.io/diaoul/subliminal download -l en /tvshows/The.Big.Bang.Theory.S05E18.HDTV.x264-LOL.mp4
 
+Debugging
+^^^^^^^^^
+
+By default, subliminal output is minimal. Run with the `--debug` flag before the `download` command to get more information::
+
+    $ subliminal --debug download -l en The.Big.Bang.Theory.S05E18.HDTV.x264-LOL.mp4
+
+
 Installation
 ------------
 For a better isolation with your system you should use a dedicated virtualenv.

{subliminal-2.3.2 → subliminal-2.4.0}/README.rst

@@ -86,6 +86,14 @@ Run subliminal in a docker container::
 
     $ docker run --rm --name subliminal -v subliminal_cache:/usr/src/cache -v /tvshows:/tvshows -it ghcr.io/diaoul/subliminal download -l en /tvshows/The.Big.Bang.Theory.S05E18.HDTV.x264-LOL.mp4
 
+Debugging
+^^^^^^^^^
+
+By default, subliminal output is minimal. Run with the `--debug` flag before the `download` command to get more information::
+
+    $ subliminal --debug download -l en The.Big.Bang.Theory.S05E18.HDTV.x264-LOL.mp4
+
+
 Installation
 ------------
 For a better isolation with your system you should use a dedicated virtualenv.

{subliminal-2.3.2 → subliminal-2.4.0}/docs/conf.py

@@ -304,7 +304,7 @@ intersphinx_mapping = {
     'dogpilecache': ('https://dogpilecache.sqlalchemy.org/en/latest', None),
     'stevedore': ('https://docs.openstack.org/stevedore/latest', None),
     'click': ('https://click.palletsprojects.com/en/latest/', None),
-    'requests': ('https://docs.python-requests.org/en/latest/', None),
+    'requests': ('https://requests.readthedocs.io/en/latest/', None),
     'sympy': ('https://docs.sympy.org/latest/', None),
     'bs4': ('https://www.crummy.com/software/BeautifulSoup/bs4/doc/', None),
     'importlib.metadata': ('https://docs.python.org/3/', '_intersphinx/importlib_metadata_objects.inv'),

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

@@ -40,5 +40,5 @@ Default configuration
 Here is a list of all the options of the configuration file.
 Commented options need a value to be valid.
 
-.. program-output:: python -c "from subliminal.cli import generate_default_config; print(generate_default_config(commented=False))"
+.. program-output:: python -c "from subliminal.cli.generate_config import generate_default_config; print(generate_default_config(commented=False))"
     :language: toml

{subliminal-2.3.2 → subliminal-2.4.0}/docs/user/usage.rst

@@ -146,8 +146,8 @@ And then compute a score with those matches with :func:`~subliminal.score.comput
 
     >>> for s in subtitles[video]:
     ...     {s: compute_score(s, video)}
-    {<PodnapisiSubtitle 'ZtAW' [hu]>: 789}
-    {<PodnapisiSubtitle 'ONAW' [hu]>: 772}
+    {<PodnapisiSubtitle 'ZtAW' [hu]>: 941}
+    {<PodnapisiSubtitle 'ONAW' [hu]>: 922}
 
 Now you should have a better idea about which one you should choose.
 

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

@@ -72,7 +72,6 @@ tests = [
     "pytest-xdist",
     "sympy",
     "colorama",  # used in scripts/
-    "pypandoc",  # used in scripts/
     "vcrpy>=5",  # keep synchronized with docs dependencies
     "win32-setctime; sys_platform=='win32'",
     "importlib_metadata>=4.6; python_version<'3.10'",
@@ -275,12 +274,12 @@ showcontent = true
 [[tool.towncrier.type]]
 directory = "doc"
 name = "Documentation"
-showcontent = false
+showcontent = true
 
 [[tool.towncrier.type]]
 directory = "misc"
 name = "Misc"
-showcontent = false
+showcontent = true
 
 
 # https://mypy.readthedocs.io/en/stable/config_file.html

subliminal-2.4.0/src/subliminal/cli/__init__.py

@@ -0,0 +1,6 @@
+"""CLI module."""
+
+from .cli import cli
+from .generate_config import generate_default_config
+
+__all__ = ['cli', 'generate_default_config']

subliminal-2.4.0/src/subliminal/cli/cli.py

@@ -0,0 +1,241 @@
+# ruff: noqa: FBT001
+"""Subliminal uses `click <https://click.palletsprojects.com>`_ to provide a :abbr:`CLI (command-line interface)`."""
+
+from __future__ import annotations
+
+import logging
+import os
+import pathlib
+import warnings
+from datetime import timedelta
+from pathlib import Path
+from typing import Any
+
+import click
+from platformdirs import PlatformDirs
+
+from subliminal import (
+    __version__,
+    region,
+)
+
+from .commands import download
+from .helpers import (
+    MutexLock,
+    options_from_providers,
+    options_from_refiners,
+    providers_config,
+    read_configuration,
+)
+
+logger = logging.getLogger(__name__)
+
+
+def configure(ctx: click.Context, param: click.Parameter | None, filename: str | os.PathLike) -> None:
+    """Update :class:`click.Context` based on a configuration file."""
+    config = read_configuration(filename)
+
+    ctx.obj = config['obj']
+    ctx.default_map = config['default_map']
+
+
+dirs = PlatformDirs('subliminal')
+cache_file = 'subliminal.dbm'
+default_config_path = dirs.user_config_path / 'subliminal.toml'
+
+
+@click.group(
+    context_settings={'max_content_width': 100},
+    epilog='Suggestions and bug reports are greatly appreciated: https://github.com/Diaoul/subliminal/',
+)
+@click.option(
+    '-c',
+    '--config',
+    type=click.Path(dir_okay=False, path_type=pathlib.Path),
+    default=default_config_path,
+    callback=configure,
+    show_default=True,
+    is_eager=True,
+    expose_value=False,
+    show_envvar=True,
+    help='Path to the TOML configuration file.',
+)
+@click.option(
+    '--cache-dir',
+    type=click.Path(writable=True, file_okay=False),
+    default=dirs.user_cache_dir,
+    show_default=True,
+    expose_value=True,
+    help='Path to the cache directory.',
+)
+@providers_config.option(
+    '--addic7ed',
+    type=click.STRING,
+    nargs=2,
+    metavar='USERNAME PASSWORD',
+    help='DEPRECATED: Addic7ed configuration.',
+)
+@providers_config.option(
+    '--opensubtitles',
+    type=click.STRING,
+    nargs=2,
+    metavar='USERNAME PASSWORD',
+    help='DEPRECATED: OpenSubtitles configuration.',
+)
+@providers_config.option(
+    '--opensubtitlescom',
+    type=click.STRING,
+    nargs=2,
+    metavar='USERNAME PASSWORD',
+    help='DEPRECATED: OpenSubtitlesCom configuration.',
+)
+@options_from_providers
+@options_from_refiners
+@click.option('--debug', is_flag=True, help='Print useful information for debugging subliminal and for reporting bugs.')
+@click.option(
+    '--logfile',
+    type=str,
+    default='',
+    help=(
+        'If defined, record information to the specified log file. '
+        'If the file already exists, new logs are appended to the file.'
+    ),
+)
+@click.option(
+    '--logfile-level',
+    type=click.Choice(['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']),
+    default='DEBUG',
+    help='The logging level used for the log file.',
+)
+@click.version_option(__version__)
+@click.pass_context
+def subliminal(
+    ctx: click.Context,
+    /,
+    cache_dir: str,
+    debug: bool,
+    logfile: os.PathLike[str] | None,
+    logfile_level: str,
+    addic7ed: tuple[str, str],
+    opensubtitles: tuple[str, str],
+    opensubtitlescom: tuple[str, str],
+    **kwargs: Any,
+) -> None:
+    """Subtitles, faster than your thoughts."""
+    # make sure to expand user
+    cache_dir_path = Path(cache_dir).expanduser()
+    # create cache directory
+    try:
+        cache_dir_path.mkdir(parents=True)
+    except OSError:  # pragma: no cover
+        if not cache_dir_path.is_dir():
+            raise
+
+    # configure cache
+    region.configure(
+        'dogpile.cache.dbm',
+        expiration_time=timedelta(days=30),
+        arguments={'filename': os.fspath(cache_dir_path / cache_file), 'lock_factory': MutexLock},
+    )
+
+    # Set the logger level to DEBUG in case debug or logfile is defined
+    subliminal_logger = logging.getLogger('subliminal')
+    subliminal_logger.setLevel(logging.DEBUG)
+
+    # configure logging file
+    if logfile:
+        # make sure to expand user
+        logfile_path = Path(logfile).expanduser()
+        try:
+            # make sure the parent directories exist
+            logfile_path.parent.mkdir(parents=True)
+        except OSError:  # pragma: no cover
+            if not logfile_path.parent.is_dir():
+                raise
+
+        file_handler = logging.FileHandler(logfile_path)
+        file_handler.setFormatter(
+            logging.Formatter(
+                '%(asctime)s | %(levelname)-8s | %(name)s | %(message)s',
+                datefmt='%Y-%m-%d %H:%M:%S',
+            ),
+        )
+        file_handler.setLevel(logfile_level)
+        subliminal_logger.addHandler(file_handler)
+
+    # configure logging
+    if debug:
+        handler = logging.StreamHandler()
+        handler.setFormatter(logging.Formatter(logging.BASIC_FORMAT))
+        handler.setLevel(logging.DEBUG)
+        subliminal_logger.addHandler(handler)
+        # log about the config file
+        msg = ctx.obj['debug_message']
+        logger.info(msg)
+
+    ctx.obj['debug'] = debug
+
+    # create provider and refiner configs
+    provider_configs: dict[str, dict[str, Any]] = {}
+    refiner_configs: dict[str, dict[str, Any]] = {}
+
+    for k, v in kwargs.items():
+        try_split = k.split('__')
+        if len(try_split) != 3:  # pragma: no cover
+            click.echo(f'Unknown option: {k}={v}')
+            continue
+        group, plugin, key = try_split
+        if group == '_provider':
+            provider_configs.setdefault(plugin, {})[key] = v
+
+        elif group == '_refiner':  # pragma: no branch
+            refiner_configs.setdefault(plugin, {})[key] = v
+
+    ctx.obj['provider_configs'] = provider_configs
+    ctx.obj['refiner_configs'] = refiner_configs
+
+    # Deprecated options
+    # To be remove in next version
+    deprecated_options = {
+        'addic7ed': addic7ed,
+        'opensubtitles': opensubtitles,
+        'opensubtitlescom': opensubtitlescom,
+    }
+    for provider, option_value in deprecated_options.items():
+        if option_value is not None:  # pragma: no cover
+            msg = (
+                f'option --{provider} is deprecated, use --provider.{provider}.username and '
+                f'--provider.{provider}.password'
+            )
+            warnings.warn(msg, DeprecationWarning, stacklevel=2)
+
+            provider_configs[provider]['username'] = option_value[0]
+            provider_configs[provider]['password'] = option_value[1]
+
+
+@subliminal.command()
+@click.option(
+    '--clear-subliminal',
+    is_flag=True,
+    help='Clear subliminal cache. Use this ONLY if your cache is corrupted or if you experience issues.',
+)
+@click.pass_context
+def cache(ctx: click.Context, clear_subliminal: bool) -> None:
+    """Cache management."""
+    if clear_subliminal and ctx.parent and 'cache_dir' in ctx.parent.params:
+        cache_dir_path = Path(ctx.parent.params['cache_dir'])
+        for file in (cache_dir_path / cache_file).glob('*'):  # pragma: no cover
+            file.unlink()
+        click.echo("Subliminal's cache cleared.")
+    else:
+        click.echo('Nothing done.')
+
+
+# Add commands
+# Download best subtitle
+subliminal.add_command(download)
+
+
+def cli() -> None:  # pragma: no cover
+    """CLI that recognizes environment variables."""
+    subliminal(auto_envvar_prefix='SUBLIMINAL')

subliminal-2.4.0/src/subliminal/cli/commands/__init__.py

@@ -0,0 +1,5 @@
+"""CLI subcommands."""
+
+from .download_best import download
+
+__all__ = ['download']

subliminal-2.4.0/src/subliminal/cli/commands/_format.py

@@ -0,0 +1,63 @@
+"""Helper functions."""
+
+from __future__ import annotations
+
+import logging
+import re
+from datetime import timedelta
+from typing import Any
+
+import click
+from babelfish import Error as BabelfishError  # type: ignore[import-untyped]
+from babelfish import Language
+
+logger = logging.getLogger(__name__)
+
+
+class LanguageParamType(click.ParamType):
+    """:class:`~click.ParamType` for languages that returns a :class:`~babelfish.language.Language`."""
+
+    name = 'language'
+
+    def convert(self, value: str, param: click.Parameter | None, ctx: click.Context | None) -> Language:
+        """Convert ietf language to :class:`~babelfish.language.Language`."""
+        try:
+            return Language.fromietf(value)
+        except BabelfishError:
+            self.fail(f'{value} is not a valid language', param, ctx)  # pragma: no cover
+
+
+class AgeParamType(click.ParamType):
+    """:class:`~click.ParamType` for age strings that returns a :class:`~datetime.timedelta`.
+
+    An age string is in the form `number + identifier` with possible identifiers:
+
+        * ``w`` for weeks
+        * ``d`` for days
+        * ``h`` for hours
+
+    The form can be specified multiple times but only with that identifier ordering. For example:
+
+        * ``1w2d4h`` for 1 week, 2 days and 4 hours
+        * ``2w`` for 2 weeks
+        * ``3w6h`` for 3 weeks and 6 hours
+    """
+
+    name = 'age'
+
+    def convert(self, value: str, param: click.Parameter | None, ctx: click.Context | None) -> timedelta:
+        """Convert an age string to :class:`~datetime.timedelta`."""
+        match = re.match(r'^(?:(?P<weeks>\d+?)w)?(?:(?P<days>\d+?)d)?(?:(?P<hours>\d+?)h)?$', value)
+        if not match:
+            self.fail(f'{value} is not a valid age', param, ctx)
+
+        return timedelta(**{k: int(v) for k, v in match.groupdict(0).items()})
+
+
+def plural(quantity: int, name: str, *, bold: bool = True, **kwargs: Any) -> str:
+    """Format a quantity with plural."""
+    return '{} {}{}'.format(
+        click.style(str(quantity), bold=bold, **kwargs),
+        name,
+        's' if quantity > 1 else '',
+    )