subliminal 2.2.1__tar.gz → 2.4.0__tar.gz

{subliminal-2.2.1 → subliminal-2.4.0}/.dockerignore

@@ -1,6 +1,3 @@
-# SCM
-.git/
-
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

subliminal-2.4.0/.github/actions/prepare-tests/action.yaml

@@ -0,0 +1,62 @@
+name: 'Download data for tests'
+description: 'Download .mkv and compress them with rar to be used in tests.'
+
+runs:
+  using: "composite"
+  steps:
+    - name: Check Runner OS
+      if: ${{ runner.os != 'Linux' && runner.os != 'Windows' && runner.os != 'macOS'}}
+      shell: bash
+      run: |
+        echo "::error title=⛔ error hint::Support Linux, Windows, and macOS Only"
+        exit 1
+    - uses: actions/checkout@v4
+      with:
+        persist-credentials: false
+        fetch-depth: 0
+    - name: Cache test data
+      id: cache-test-data
+      uses: actions/cache@v4
+      with:
+        path: tests/data/
+        enableCrossOsArchive: true
+        key: prepare-tests
+
+    - name: Download only from Linux Runner OS
+      if: ${{ steps.cache-test-data.outputs.cache-hit != 'true' && runner.os != 'Linux' }}
+      shell: bash
+      run: |
+        echo "::error title=⛔ error hint::Download cache only from Linux: ${{ runner.os }}."
+        exit 1
+    - name: Install other test software (on Linux only)
+      if: steps.cache-test-data.outputs.cache-hit != 'true'
+      uses: awalsh128/cache-apt-pkgs-action@v1
+      with:
+        packages: rar
+        version: 1.0
+    - uses: actions/setup-python@v5
+      if: steps.cache-test-data.outputs.cache-hit != 'true'
+      with:
+        python-version-file: .python-version-default
+        cache: pip
+    - name: Install dependencies
+      if: steps.cache-test-data.outputs.cache-hit != 'true'
+      shell: bash
+      run: |
+        python -Im pip install --upgrade pip
+        python -Im pip install tox requests
+    - name: Download tests data
+      if: steps.cache-test-data.outputs.cache-hit != 'true'
+      shell: bash
+      run: |
+        tox -e prepare-tests
+
+    # - name: Upload files for test
+    #   uses: actions/upload-artifact@v4
+    #   with:
+    #     name: tests-data
+    #     path: tests/data/
+    #     include-hidden-files: false
+    #     if-no-files-found: error
+    #     # heavy artifact should be deleted asap
+    #     retention-days: 1

subliminal-2.4.0/.github/workflows/CI.yaml

@@ -0,0 +1,318 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+
+permissions: {}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  FORCE_COLOR: "1"
+  PIP_DISABLE_PIP_VERSION_CHECK: "1"
+  PIP_NO_PYTHON_VERSION_WARNING: "1"
+
+jobs:
+  check-manifest:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - run: pipx run check-manifest --ignore "_version.py"
+
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@v5
+        with:
+          python-version-file: .python-version-default
+      - uses: pre-commit/action@v3.0.1
+
+  typing:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@v5
+        with:
+          python-version-file: .python-version-default
+      - name: Install hatch
+        run: python -Im pip install hatch
+      - name: Setup types environment
+        run: hatch -v env create types
+      - name: Type check
+        run: hatch run types:run
+
+  docs:
+    name: Build docs and run doctests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@v5
+        with:
+          # Keep in sync with tox/docs, hatch.toml and .readthedocs.yaml.
+          python-version-file: .python-version-default
+          cache: pip
+
+      - name: Install hatch
+        run: python -Im pip install hatch
+      - name: Build and check docs
+        run: hatch run docs:run
+      - name: Run doctests
+        run: hatch run docs:doctest
+      - name: Check changelog
+        run: hatch run changelog:run
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: docs/_build/
+
+  install-dev:
+    name: Verify install env
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@v5
+        with:
+          python-version-file: .python-version-default
+          cache: pip
+
+      - name: Install in dev mode & import
+        run: |
+          python -Im pip install -e .[dev]
+          python -Ic 'import subliminal; print(subliminal.__version__)'
+
+  build-package:
+    name: Build & verify package
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+
+      - uses: hynek/build-and-inspect-python-package@v2
+        id: baipp
+
+    outputs:
+      # Used to define the matrix for tests below. The value is based on
+      # packaging metadata (trove classifiers).
+      supported-python-versions: ${{ steps.baipp.outputs.supported_python_classifiers_json_array }}
+
+  prepare-test:
+    name: Download data for tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+      - name: Prepare tests
+        uses: ./.github/actions/prepare-tests
+      - name: Display downloaded files
+        run: ls -R tests/data
+
+  test:
+    name: Test
+    runs-on: ${{ matrix.os }}
+    needs: [build-package, prepare-test]
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        # Created by the build-and-inspect-python-package action above.
+        py: ${{ fromJson(needs.build-package.outputs.supported-python-versions) }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.py }}
+          allow-prereleases: true
+      - name: Prepare tests
+        uses: ./.github/actions/prepare-tests
+      - name: Display downloaded files
+        run: ls -R tests/data
+
+      - name: Install hatch
+        run: python -Im pip install hatch
+
+      - name: Pick environment to run
+        env:
+          PYTHON_VERSION: ${{ matrix.py }}
+        run: |
+          import codecs; import os
+          py = f"tests.py{os.environ.get('PYTHON_VERSION')}"
+          print(f"Picked {py}")
+          with codecs.open(os.environ["GITHUB_ENV"], mode="a", encoding="utf-8") as file_handler:
+              file_handler.write(f"FORCE_COLOR=1\nENV={py}\n")
+        shell: python
+      - name: Setup test environment
+        run: |
+          hatch -v env create ${ENV}
+        shell: bash
+      - name: Run test suite
+        env:
+          # Make sure to add `passenv=COVERAGE_FILE` to `[testenv]` in tox.ini
+          # Make sure to add `overrides = { env.COVERAGE_FILE.env-vars = "COVERAGE_FILE" }` to `[tests]` in hatch.toml
+          COVERAGE_FILE: ".coverage.${{ matrix.os }}.${{ matrix.py }}"
+          CI_RUN: "yes"
+        run: hatch -v run ${ENV}:test-cov
+        shell: bash
+
+      - name: Store coverage file
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-${{ matrix.os }}-${{ matrix.py }}
+          path: .coverage*
+          include-hidden-files: true
+          if-no-files-found: error
+
+  coverage:
+    name: Coverage
+    runs-on: ubuntu-latest
+    needs: test
+    permissions:
+      pull-requests: write
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # py-cov-action/python-coverage-comment-action needs git credentials
+          persist-credentials: true
+      - uses: actions/setup-python@v5
+        with:
+          python-version-file: .python-version-default
+      - uses: hynek/setup-cached-uv@v2
+
+      - name: Download coverage data
+        uses: actions/download-artifact@v4
+        with:
+          pattern: coverage-*
+          merge-multiple: true
+
+      - name: Combine coverage
+        run: |
+          uv tool install 'coverage[toml]>7'
+
+          coverage combine
+          coverage html --skip-covered --skip-empty
+
+          # Report and write to summary.
+          coverage report --skip-covered --skip-empty --show-missing --format=markdown >> $GITHUB_STEP_SUMMARY
+
+      - name: Upload HTML report if check failed.
+        uses: actions/upload-artifact@v4
+        with:
+          name: html-report
+          path: htmlcov
+
+      - name: Coverage comment
+        id: coverage_comment
+        uses: py-cov-action/python-coverage-comment-action@v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Store Pull Request comment to be posted
+        uses: actions/upload-artifact@v4
+        if: steps.coverage_comment.outputs.COMMENT_FILE_WRITTEN == 'true'
+        with:
+          # If you use a different name, update COMMENT_ARTIFACT_NAME accordingly
+          name: python-coverage-comment-action
+          # If you use a different name, update COMMENT_FILENAME accordingly
+          path: python-coverage-comment-action.txt
+
+  core-coverage:
+    name: Core Coverage
+    runs-on: ubuntu-latest
+    needs: [build-package, prepare-test]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@v5
+        id: setup
+        with:
+          python-version-file: .python-version-default
+      - name: Prepare tests
+        uses: ./.github/actions/prepare-tests
+      - name: Display downloaded files
+        run: ls -R tests/data
+      - name: Install hatch
+        run: python -Im pip install hatch
+
+      - name: Pick environment to run
+        env:
+          PYTHON_VERSION: ${{ steps.setup.outputs.python-version }}
+        run: |
+          import codecs; import os
+          py = os.environ.get('PYTHON_VERSION')
+          py = ".".join(py.split(".")[:2])
+          test_env = f"tests.py{py}"
+          print(f"Picked {test_env}")
+          with codecs.open(os.environ["GITHUB_ENV"], mode="a", encoding="utf-8") as file_handler:
+              file_handler.write(f"ENV={test_env}\n")
+        shell: python
+      - name: Setup test environment
+        run: |
+          hatch -v env create ${ENV}
+        shell: bash
+      - name: Run test suite
+        env:
+          # Make sure to add `passenv=COVERAGE_FILE` to `[testenv]` in tox.ini
+          # Make sure to add `overrides = { env.COVERAGE_FILE.env-vars = "COVERAGE_FILE" }` to `[tests]` in hatch.toml
+          COVERAGE_FILE: ".core-coverage"
+          CI_RUN: "yes"
+        run: hatch -v run ${ENV}:run-cov-core
+        shell: bash
+
+      - name: Store coverage file
+        uses: actions/upload-artifact@v4
+        if: ${{ failure() }}
+        with:
+          name: core-coverage
+          path: .core-coverage
+          include-hidden-files: true
+          if-no-files-found: error
+
+
+  # Ensure everything required is passing for branch protection.
+  required-checks-pass:
+    if: always()
+
+    needs:
+      - coverage
+      - core-coverage
+      - docs
+      - install-dev
+      - typing
+      - pre-commit
+      - check-manifest
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Decide whether the needed jobs succeeded or failed
+        uses: re-actors/alls-green@release/v1
+        with:
+          jobs: ${{ toJSON(needs) }}

subliminal-2.4.0/.github/workflows/coverage.yaml

@@ -0,0 +1,39 @@
+name: Post coverage comment
+
+on:
+  workflow_run:
+    workflows: ["CI"]
+    types:
+      - completed
+
+permissions: {}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  FORCE_COLOR: "1"
+  PIP_DISABLE_PIP_VERSION_CHECK: "1"
+  PIP_NO_PYTHON_VERSION_WARNING: "1"
+
+jobs:
+  display-coverage:
+    name: Display coverage comment
+    runs-on: ubuntu-latest
+    if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success'
+    permissions:
+      pull-requests: write
+      contents: write
+      actions: read
+    steps:
+      # DO NOT run actions/checkout here, for security reasons
+      # For details, refer to https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
+      - name: Post comment
+        uses: py-cov-action/python-coverage-comment-action@v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_PR_RUN_ID: ${{ github.event.workflow_run.id }}
+          # Update those if you changed the default values:
+          # COMMENT_ARTIFACT_NAME: python-coverage-comment-action
+          # COMMENT_FILENAME: python-coverage-comment-action.txt

subliminal-2.4.0/.github/workflows/docker-build.yaml

@@ -0,0 +1,103 @@
+name: Publish Docker image
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "*.*.*"
+  workflow_call:
+    inputs:
+      tag-name:
+        description: 'Tag name'
+        required: true
+        type: 'string'
+  workflow_dispatch:
+    inputs:
+      tag-name:
+        description: 'Tag name'
+        required: true
+        type: 'string'
+  pull_request:
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+  TEST_IMAGE: subliminal
+
+jobs:
+  build-docker:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        if: github.event_name == 'push' || github.event_name == 'pull_request'
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Checkout repository
+        if: github.event_name == 'workflow_call' || github.event_name == 'workflow_dispatch'
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.tag-name }}
+          persist-credentials: false
+
+      - name: Set up QEMU
+        if: |
+          github.event_name == 'push'
+          || github.event_name == 'workflow_call'
+          || github.event_name == 'workflow_dispatch'
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+        with:
+          cache-binary: false
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=ref,event=branch
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}},enable=${{ !startsWith(github.ref, 'refs/tags/0.') }}
+
+      - name: Test building Docker image
+        uses: docker/build-push-action@v6
+        if: github.event_name == 'pull_request'
+        with:
+          context: .
+          load: true
+          tags: ${{ env.TEST_IMAGE }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v6
+        if: |
+          github.event_name == 'push'
+          || github.event_name == 'workflow_call'
+          || github.event_name == 'workflow_dispatch'
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64,linux/arm/v7
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+# vim:ts=2:sw=2:et

subliminal-2.4.0/.github/workflows/prepare-release-pr.yaml

@@ -0,0 +1,58 @@
+name: Prepare release PR
+
+on:
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: 'Branch to base the release from'
+        required: false
+        default: 'main'
+      bump:
+        description: |
+          'Release type: major, minor or patch. '
+          'Leave empty for autommatic detection based on changelog segments.'
+        required: false
+        default: ''
+      prerelease:
+        description: 'Prerelease (ex: rc1). Leave empty if not a pre-release.'
+        required: false
+        default: ''
+
+env:
+  FORCE_COLOR: "1"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        # persist-credentials is needed in order for us to push the release branch.
+        persist-credentials: true
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version-file: .python-version-default
+        cache: pip
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install --upgrade setuptools tox
+
+    - name: Prepare release PR
+      env:
+        BRANCH: ${{ github.event.inputs.branch }}
+        BUMP: ${{ github.event.inputs.bump }}
+        PRERELEASE: ${{ github.event.inputs.prerelease }}
+        GH_TOKEN: ${{ github.token }}
+      run: |
+        git config user.name 'github-actions[bot]'
+        git config user.email '41898282+github-actions[bot]@users.noreply.github.com'
+        tox -e prepare-release-pr -- ${BRANCH} --bump=${BUMP} --prerelease=${PRERELEASE}

subliminal-2.4.0/.github/workflows/publish-release.yaml

@@ -0,0 +1,82 @@
+name: Publish Github release
+
+on:
+  push:
+    tags:
+      - "*.*.*"
+  workflow_call:
+    inputs:
+      tag-name:
+        description: 'Tag name'
+        required: true
+        type: 'string'
+  workflow_dispatch:
+    inputs:
+      tag-name:
+        description: 'Tag name'
+        required: true
+        type: 'string'
+
+permissions: {}
+
+env:
+  FORCE_COLOR: "1"
+  PIP_DISABLE_PIP_VERSION_CHECK: "1"
+  PIP_NO_PYTHON_VERSION_WARNING: "1"
+
+jobs:
+  # Always build & lint package.
+  build-package:
+    name: Build & verify package
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        if: github.event_name == 'push'
+        with:
+          persist-credentials: false
+      - name: Checkout
+        uses: actions/checkout@v4
+        if: |
+          github.event_name == 'workflow_dispatch'
+          || github.event_name == 'workflow_call'
+        with:
+          ref: ${{ inputs.tag-name }}
+          persist-credentials: false
+      - name: Build dist
+        uses: hynek/build-and-inspect-python-package@v2
+        id: baipp
+    outputs:
+      tag: ${{ steps.baipp.outputs.package_version }}
+
+
+  github-release:
+    name: Make a GitHub Release
+    needs: [build-package]
+    if: github.repository == 'Diaoul/subliminal'
+    runs-on: ubuntu-latest
+    permissions:
+      # IMPORTANT: mandatory for making GitHub Releases
+      contents: write
+      id-token: write
+
+    # Publish a Github release when a tag was pushed, or it's called with a tag.
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-tags: true
+          ref: ${{ needs.build-package.outputs.tag }}
+          persist-credentials: false
+
+      - name: Download packages built by build-and-inspect-python-package
+        uses: actions/download-artifact@v4
+        with:
+          name: Packages
+          path: dist
+      - name: Publish GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true
+          draft: true