GH-39: Remove usages of the future components (GH-40)

* Fix path creation for the win32 platform
* Fix the routes in the final thumbnails
* Fix the PyAV version depending on the environment
* Add assertions after CLI test cases

Author: ArtyomVancyan

README.md

@@ -34,22 +34,24 @@ thumbnails --help
 
 ## Development
 
-Install the dependencies:
+### Install the dependencies
 ```bash
 python3 -m pip install -r requirements.txt
 ```
 
-Install the development dependencies:
+### Install the development dependencies
 ```bash
-python3 -m pip install -r requirements-dev.txt
+python3 -m pip install -r tests/requirements.txt
 ```
 
-Install the package in editable mode:
+### Install the package in editable mode
 ```bash
 python3 -m pip install -e .
 ```
+If you are using a non-default version of Python (for example, you work with a virtual environment), you may get an error with `distutils`. See how to [fix](https://askubuntu.com/questions/1261162) the issue.
 
-Run the tests to ensure everything is working before opening a PR:
+### Run the tests
+Run this in the local environment to ensure everything is working before opening a PR
 ```bash
 tox
 ```

requirements.txt

@@ -1,4 +1,4 @@
-av>=9.2.0
+av>=8.0.0,<=9.2.0
 click>=8.0.3
 imageio-ffmpeg>=0.4.7
 imageio>=2.23.0

setup.cfg

@@ -15,7 +15,8 @@ classifiers =
 packages =
     thumbnails
 install_requires =
-    av>=9.2.0
+    av==8.0.0;python_version=='3.7'
+    av==9.2.0;python_version>'3.7'
     click>=8.0.3
     imageio-ffmpeg>=0.4.7
     imageio>=2.23.0

src/thumbnails/frame.py

@@ -1,4 +1,3 @@
-import functools
 import math
 
 
@@ -10,6 +9,9 @@ def __init__(self, size):
         _min_width = 300
         _min_height = math.ceil(_min_width * height / width)
 
+        self.__width = None
+        self.__height = None
+
         self._width = width / 10
         self._height = height / 10
         self._min_width = _min_width
@@ -20,12 +22,16 @@ def compress(self):
         """Defines an interface for the compress property."""
         raise NotImplementedError
 
-    @functools.cached_property
+    @property
     def width(self):
         """Calculates and caches the frame width."""
-        return max(self._min_width, self._width * self.compress)
+        if not self.__width:
+            self.__width = max(self._min_width, self._width * self.compress)
+        return self.__width
 
-    @functools.cached_property
+    @property
     def height(self):
         """Calculates and caches the frame height."""
-        return max(self._min_height, self._height * self.compress)
+        if not self.__height:
+            self.__height = max(self._min_height, self._height * self.compress)
+        return self.__height

src/thumbnails/pathtools.py

@@ -1,4 +1,3 @@
-import functools
 import os
 from distutils.dir_util import create_tree
 
@@ -11,7 +10,6 @@ def listdir(directory):
             yield os.path.abspath(filepath)
 
 
-@functools.cache
 def metadata_path(path, out, fmt):
     """Calculates the thumbnail metadata output path."""
     out = os.path.abspath(out or os.path.dirname(path))

src/thumbnails/thumbnail.py

@@ -1,5 +1,6 @@
 import json
 import os
+import pathlib
 from abc import ABCMeta
 from abc import abstractmethod
 from datetime import timedelta
@@ -99,13 +100,12 @@ def prepare_frames(self):
         master = Image.new(mode="RGBA", size=next(thumbnails))
         master_path = os.path.join(self.thumbnail_dir, extract_name(self.filepath) + ".png")
 
-        for frame, *_, x, y in self.thumbnails():
+        for frame, *_, x, y in thumbnails:
             with Image.open(frame) as image:
                 image = image.resize((self.width, self.height), Image.ANTIALIAS)
                 master.paste(image, (x, y))
 
         master.save(master_path)
-        self.tempdir.cleanup()
 
     def generate(self):
         def format_time(secs):
@@ -115,6 +115,7 @@ def format_time(secs):
         metadata = ["WEBVTT\n\n"]
         prefix = self.base or os.path.relpath(self.thumbnail_dir)
         route = os.path.join(prefix, extract_name(self.filepath) + ".png")
+        route = pathlib.Path(route).as_posix()
 
         for _, start, end, x, y in self.thumbnails():
             thumbnail_data = "%s --> %s\n%s#xywh=%d,%d,%d,%d\n\n" % (
@@ -126,6 +127,8 @@ def format_time(secs):
         with open(self.metadata_path, "w") as fp:
             fp.writelines(metadata)
 
+        self.tempdir.cleanup()
+
 
 @register_thumbnail("json")
 class ThumbnailJSON(Thumbnail):
@@ -139,7 +142,6 @@ def prepare_frames(self):
         if os.path.exists(self.thumbnail_dir):
             remove_tree(self.thumbnail_dir)
         copy_tree(self.tempdir.name, self.thumbnail_dir)
-        self.tempdir.cleanup()
 
     def generate(self):
         metadata = {}
@@ -151,6 +153,7 @@ def generate(self):
                 base = os.path.join(self.base, os.path.basename(self.thumbnail_dir))
                 prefix = base if self.base else os.path.relpath(self.thumbnail_dir)
                 route = os.path.join(prefix, os.path.basename(frame))
+                route = pathlib.Path(route).as_posix()
                 thumbnail_data = {
                     "src": route,
                     "width": "%spx" % self.width,
@@ -159,3 +162,5 @@ def generate(self):
 
         with open(self.metadata_path, "w") as fp:
             json.dump(metadata, fp, indent=2)
+
+        self.tempdir.cleanup()

src/thumbnails/video.py

@@ -1,5 +1,4 @@
 import concurrent.futures
-import functools
 import glob
 import math
 import os
@@ -15,7 +14,6 @@
 ffmpeg_bin = get_ffmpeg_exe()
 
 
-@functools.cache
 def arange(start, stop, step):
     """Roughly equivalent to numpy.arange."""
 
@@ -67,7 +65,9 @@ def calc_columns(frames_count, width, height):
     def _extract_frame(self, start_time):
         """Extracts a single frame from the video by the offset."""
         offset = str(timedelta(seconds=start_time))
-        output = "%s/%s.png" % (self.tempdir.name, offset)
+        filename = "%s.png" % offset.replace(":", "-")
+        output = os.path.join(self.tempdir.name, filename)
+        os.close(os.open(output, os.O_CREAT, mode=0o664))
 
         cmd = (
             ffmpeg_bin,

tests/conftest.py

@@ -1,3 +1,4 @@
+import os
 from distutils.dir_util import copy_tree
 from tempfile import TemporaryDirectory
 
@@ -7,5 +8,5 @@
 @pytest.fixture
 def tmp_media():
     with TemporaryDirectory() as tempdir:
-        copy_tree("tests/data", tempdir)
+        copy_tree(os.path.join("tests", "data"), tempdir)
         yield tempdir

tests/data/snapshots/relative-base-json

@@ -1,46 +1,46 @@
 {
   "0": {
-    "src": "%(tmp_media)s/video/0:00:00.png",
+    "src": "%(tmp_media)s/video/0-00-00.png",
     "width": "300px"
   },
   "10": {
-    "src": "%(tmp_media)s/video/0:00:10.png",
+    "src": "%(tmp_media)s/video/0-00-10.png",
     "width": "300px"
   },
   "20": {
-    "src": "%(tmp_media)s/video/0:00:20.png",
+    "src": "%(tmp_media)s/video/0-00-20.png",
     "width": "300px"
   },
   "30": {
-    "src": "%(tmp_media)s/video/0:00:30.png",
+    "src": "%(tmp_media)s/video/0-00-30.png",
     "width": "300px"
   },
   "40": {
-    "src": "%(tmp_media)s/video/0:00:40.png",
+    "src": "%(tmp_media)s/video/0-00-40.png",
     "width": "300px"
   },
   "50": {
-    "src": "%(tmp_media)s/video/0:00:50.png",
+    "src": "%(tmp_media)s/video/0-00-50.png",
     "width": "300px"
   },
   "60": {
-    "src": "%(tmp_media)s/video/0:01:00.png",
+    "src": "%(tmp_media)s/video/0-01-00.png",
     "width": "300px"
   },
   "70": {
-    "src": "%(tmp_media)s/video/0:01:10.png",
+    "src": "%(tmp_media)s/video/0-01-10.png",
     "width": "300px"
   },
   "80": {
-    "src": "%(tmp_media)s/video/0:01:20.png",
+    "src": "%(tmp_media)s/video/0-01-20.png",
     "width": "300px"
   },
   "90": {
-    "src": "%(tmp_media)s/video/0:01:30.png",
+    "src": "%(tmp_media)s/video/0-01-30.png",
     "width": "300px"
   },
   "100": {
-    "src": "%(tmp_media)s/video/0:01:40.png",
+    "src": "%(tmp_media)s/video/0-01-40.png",
     "width": "300px"
   }
 }

tests/data/snapshots/specified-base-json

@@ -1,46 +1,46 @@
 {
   "0": {
-    "src": "/media/thumbnails/video/0:00:00.png",
+    "src": "/media/thumbnails/video/0-00-00.png",
     "width": "300px"
   },
   "10": {
-    "src": "/media/thumbnails/video/0:00:10.png",
+    "src": "/media/thumbnails/video/0-00-10.png",
     "width": "300px"
   },
   "20": {
-    "src": "/media/thumbnails/video/0:00:20.png",
+    "src": "/media/thumbnails/video/0-00-20.png",
     "width": "300px"
   },
   "30": {
-    "src": "/media/thumbnails/video/0:00:30.png",
+    "src": "/media/thumbnails/video/0-00-30.png",
     "width": "300px"
   },
   "40": {
-    "src": "/media/thumbnails/video/0:00:40.png",
+    "src": "/media/thumbnails/video/0-00-40.png",
     "width": "300px"
   },
   "50": {
-    "src": "/media/thumbnails/video/0:00:50.png",
+    "src": "/media/thumbnails/video/0-00-50.png",
     "width": "300px"
   },
   "60": {
-    "src": "/media/thumbnails/video/0:01:00.png",
+    "src": "/media/thumbnails/video/0-01-00.png",
     "width": "300px"
   },
   "70": {
-    "src": "/media/thumbnails/video/0:01:10.png",
+    "src": "/media/thumbnails/video/0-01-10.png",
     "width": "300px"
   },
   "80": {
-    "src": "/media/thumbnails/video/0:01:20.png",
+    "src": "/media/thumbnails/video/0-01-20.png",
     "width": "300px"
   },
   "90": {
-    "src": "/media/thumbnails/video/0:01:30.png",
+    "src": "/media/thumbnails/video/0-01-30.png",
     "width": "300px"
   },
   "100": {
-    "src": "/media/thumbnails/video/0:01:40.png",
+    "src": "/media/thumbnails/video/0-01-40.png",
     "width": "300px"
   }
 }