[build] Add pyright checks to analysis, add moviepy as dev dep

Author: Breakthrough

.github/workflows/build.yml

@@ -59,12 +59,6 @@ jobs:
           python -m pip install --upgrade pip build wheel virtualenv setuptools
           pip install -e .[dev] --only-binary av,opencv-python
 
-      - name: Install MoviePy
-        # TODO: We can only run MoviePy tests on systems that have ffmpeg.
-        if: ${{ runner.arch == 'X64' }}
-        run: |
-          pip install moviepy
-
       - name: Checkout test resources
         run: |
           git fetch --depth=1 https://github.com/Breakthrough/PySceneDetect.git refs/heads/resources:refs/remotes/origin/resources

.github/workflows/check-code-format.yml .github/workflows/static-analysis.yml.github/workflows/check-code-format.yml renamed to .github/workflows/static-analysis.yml

@@ -7,15 +7,13 @@ on:
       - scenedetect/**
       - tests/**
       - pyproject.toml
-      - .style.yapf
-      - .github/workflows/check-code-format.yml
+      - .github/workflows/static-analysis.yml
   push:
     paths:
       - scenedetect/**
       - tests/**
       - pyproject.toml
-      - .style.yapf
-      - .github/workflows/check-code-format.yml
+      - .github/workflows/static-analysis.yml
 
 jobs:
   check_format:
@@ -34,16 +32,14 @@ jobs:
           python -m pip install --upgrade pip
           python -m pip install -e .[dev] --only-binary av,opencv-python
 
-      - name: Check Code Format (yapf)
-        if: ${{ hashFiles('.style.yapf') != '' }}
-        run: |
-          python -m pip install --upgrade yapf toml
-          python -m yapf --diff --recursive scenedetect/ tests/
-
       - name: Static Analysis (ruff)
-        if: ${{ hashFiles('.style.yapf') == '' }}
         run: |
           python -m pip install --upgrade ruff
           python -m ruff check
           python -m ruff format --check
 
+      - name: Type Check (pyright)
+        run: |
+          python -m pip install pyright==1.1.408
+          python -m pyright
+

pyproject.toml

@@ -51,7 +51,7 @@ dependencies = [
 [project.optional-dependencies]
 pyav = ["av>=9.2"]
 moviepy = ["moviepy"]
-dev = ["av>=9.2", "pytest>=7.0"]
+dev = ["av>=9.2", "moviepy", "pytest>=7.0"]
 docs = ["Sphinx==7.0.1"]
 website = ["mkdocs==1.5.2", "jinja2>=3.1.6"]
 

scenedetect/detectors/hash_detector.py

@@ -143,7 +143,7 @@ def hash_frame(frame_img, hash_size, factor) -> numpy.ndarray:
         dct_low_freq = dct_complete[:hash_size, :hash_size]
 
         # Calculate the median of the low frequency informations
-        med = numpy.median(dct_low_freq)
+        med = numpy.median(numpy.asarray(dct_low_freq, dtype=numpy.float32))
 
         # Transform the low frequency information into a binary image based on > or < median
         hash_img = dct_low_freq > med

scripts/generate_assets.py

@@ -21,6 +21,7 @@ class LogoOutput(NamedTuple):
     height: int
     source: Path
 
+
 # Colors matching the SVG design
 BG = (224, 232, 240, 255)  # #e0e8f0
 FG = (42, 53, 69, 255)  # #2a3545
@@ -55,9 +56,15 @@ class LogoOutput(NamedTuple):
 
 LOGO_OUTPUTS: list[LogoOutput] = [
     LogoOutput(REPO_DIR / "docs" / "_static" / "pyscenedetect_logo.png", 900, 422, LOGO_SVG),
-    LogoOutput(REPO_DIR / "docs" / "_static" / "pyscenedetect_logo_small.png", 300, 141, LOGO_BG_SVG),
-    LogoOutput(REPO_DIR / "website" / "pages" / "img" / "pyscenedetect_logo.png", 640, 300, LOGO_BG_SVG),
-    LogoOutput(REPO_DIR / "website" / "pages" / "img" / "pyscenedetect_logo_small.png", 462, 217, LOGO_SVG),
+    LogoOutput(
+        REPO_DIR / "docs" / "_static" / "pyscenedetect_logo_small.png", 300, 141, LOGO_BG_SVG
+    ),
+    LogoOutput(
+        REPO_DIR / "website" / "pages" / "img" / "pyscenedetect_logo.png", 640, 300, LOGO_BG_SVG
+    ),
+    LogoOutput(
+        REPO_DIR / "website" / "pages" / "img" / "pyscenedetect_logo_small.png", 462, 217, LOGO_SVG
+    ),
 ]
 
 SVG_FOR_SIZE: dict[int, Path] = {
@@ -82,7 +89,7 @@ def make_icon_16() -> Image.Image:
         px[i, 0] = BG
         px[i, 15] = BG
 
-    # Arm stripe gaps (rows 2–4): clear pixels not part of a complete stripe.
+    # Arm stripe gaps (rows 2-4): clear pixels not part of a complete stripe.
     # A stripe x+y=s spans all 3 arm rows only when 5 <= s <= 16.
     for y in range(2, 5):
         for x in range(1, 15):
@@ -93,7 +100,7 @@ def make_icon_16() -> Image.Image:
             if not ((x + y) % 4 < 2 and 5 <= (x + y) <= 16):
                 px[x, y] = BG
 
-    # Slate interior (rows 8–12, cols 3–12)
+    # Slate interior (rows 8-12, cols 3-12)
     for y in range(8, 13):
         for x in range(3, 13):
             px[x, y] = BG
@@ -117,7 +124,16 @@ def find_inkscape() -> str:
 def render_svg(inkscape: str, svg: Path, output: Path, width: int, height: int):
     """Render an SVG to a PNG at the given dimensions using Inkscape."""
     subprocess.run(
-        [inkscape, str(svg), "--export-type=png", f"--export-filename={output}", "-w", str(width), "-h", str(height)],
+        [
+            inkscape,
+            str(svg),
+            "--export-type=png",
+            f"--export-filename={output}",
+            "-w",
+            str(width),
+            "-h",
+            str(height),
+        ],
         check=True,
         capture_output=True,
     )
@@ -127,7 +143,8 @@ def render_logos(inkscape: str):
     """Render the logo SVG to all required PNG outputs."""
     print("Rendering logo PNGs...")
     for entry in LOGO_OUTPUTS:
-        print(f"  {entry.path.relative_to(REPO_DIR)} ({entry.width}x{entry.height}) [source: {entry.source.name}]...")
+        rel_path = entry.path.relative_to(REPO_DIR)
+        print(f"  {rel_path} ({entry.width}x{entry.height}) [source: {entry.source.name}]...")
         render_svg(inkscape, entry.source, entry.path, entry.width, entry.height)
     print(f"  Done ({len(LOGO_OUTPUTS)} files).")
 
@@ -147,7 +164,11 @@ def render_all_sizes(inkscape: str, work_dir: Path) -> list[Image.Image]:
             render_svg(inkscape, svg_path, png_path, size, size)
             img = Image.open(png_path).copy()
             if size in SHARPEN_AMOUNT:
-                img = img.filter(ImageFilter.UnsharpMask(radius=SHARPEN_RADIUS, percent=SHARPEN_AMOUNT[size], threshold=0))
+                img = img.filter(
+                    ImageFilter.UnsharpMask(
+                        radius=SHARPEN_RADIUS, percent=SHARPEN_AMOUNT[size], threshold=0
+                    )
+                )
                 print(f"    Sharpened {size}x{size} (USM {SHARPEN_AMOUNT[size]}%)")
                 img.save(png_path)
         images.append(img)

scripts/pre_release.py

@@ -21,7 +21,7 @@
 REPO_DIR = Path(__file__).resolve().parent.parent
 sys.path.insert(0, str(REPO_DIR))
 
-import scenedetect
+import scenedetect  # noqa: E402
 
 PACKAGING_DIR = REPO_DIR / "packaging"
 WINDOWS_DIR = PACKAGING_DIR / "windows"
@@ -30,30 +30,31 @@
 
 VERSION = scenedetect.__version__
 
-run_version_check = ("--release" in sys.argv)
+run_version_check = "--release" in sys.argv
 
 if run_version_check:
-  installer_aip = INSTALLER_AIP.read_text()
-  aip_version = f"<ROW Property=\"ProductVersion\" Value=\"{VERSION}\" Options=\"32\"/>"
-  assert aip_version in installer_aip, f"Installer project version does not match {VERSION}."
+    installer_aip = INSTALLER_AIP.read_text()
+    aip_version = f'<ROW Property="ProductVersion" Value="{VERSION}" Options="32"/>'
+    assert aip_version in installer_aip, f"Installer project version does not match {VERSION}."
 
 with VERSION_INFO.open("wb") as f:
     v = VERSION.split(".")
     assert 2 <= len(v) <= 4, f"Unrecognized version format: {VERSION}"
     while len(v) < 4:
-       v.append("0")
+        v.append("0")
     (maj, min, pat, bld) = v[0], v[1], v[2], v[3]
     # If either major or minor have suffixes, assume it's a dev/beta build and set
     # the final component to 999.
     if not min.isdigit():
-       assert "-" in min
-       min = min[:min.find("-")]
-       bld = 999
+        assert "-" in min
+        min = min[: min.find("-")]
+        bld = 999
     if not pat.isdigit():
-       assert "-" in pat
-       pat = pat[:pat.find("-")]
-       bld = 999
-    f.write(f"""# UTF-8
+        assert "-" in pat
+        pat = pat[: pat.find("-")]
+        bld = 999
+    f.write(
+        f"""# UTF-8
 #
 # For more details about fixed file info 'ffi' see:
 # http://msdn.microsoft.com/en-us/library/ms646997.aspx
@@ -96,4 +97,5 @@
 VarFileInfo([VarStruct(u'Translation', [1033, 1200])])
   ]
 )
-""".encode())
+""".encode()
+    )