GH-37: Implement a facade with a simple interface (GH-38)

* Refactor the structure of files
* Implement the high-level Generator facade

Author: ArtyomVancyan

thumbnails/__init__.py renamed to src/thumbnails/__init__.py

@@ -20,15 +20,6 @@
 from .thumbnail import ThumbnailJSON
 from .thumbnail import ThumbnailVTT
 from .thumbnail import register_thumbnail
-from .video import Video
 
-__version__ = "0.0.1"
-__all__ = (
-    "Thumbnail",
-    "ThumbnailExistsError",
-    "ThumbnailFactory",
-    "ThumbnailJSON",
-    "ThumbnailVTT",
-    "register_thumbnail",
-    "Video",
-)
+__version__ = "0.1.1"
+__all__ = []

src/thumbnails/__main__.py

@@ -0,0 +1,19 @@
+from .cli import cli
+from .generator import Generator
+
+
+@cli
+def main(inputs=None, **options):
+    """This command delegates the functionality of the `thumbnails` Python package
+    to the CLI. Read more at https://github.com/pysnippet/thumbnails#readme."""
+
+    generator = Generator(inputs)
+
+    for option, value in options.items():
+        setattr(generator, option, value)
+
+    generator.generate()
+
+
+if __name__ == "__main__":
+    main()

thumbnails/cli.py renamed to src/thumbnails/cli.py

@@ -4,14 +4,12 @@
 
 from . import ThumbnailFactory
 from . import __version__
-
-# Default values of the particular option of the CLI.
-DEFAULT_BASE = ""
-DEFAULT_SKIP = False
-DEFAULT_OUTPUT = None
-DEFAULT_FORMAT = "vtt"
-DEFAULT_COMPRESS = 1.0
-DEFAULT_INTERVAL = 1.0
+from .constants import DEFAULT_BASE
+from .constants import DEFAULT_COMPRESS
+from .constants import DEFAULT_FORMAT
+from .constants import DEFAULT_INTERVAL
+from .constants import DEFAULT_OUTPUT
+from .constants import DEFAULT_SKIP
 
 # Help messages of the particular option of the CLI.
 HELP_BASE = "The prefix of the thumbnails path can be customized."

src/thumbnails/constants.py

@@ -0,0 +1,6 @@
+DEFAULT_BASE = ""
+DEFAULT_SKIP = False
+DEFAULT_OUTPUT = None
+DEFAULT_FORMAT = "vtt"
+DEFAULT_COMPRESS = 1.0
+DEFAULT_INTERVAL = 1.0

thumbnails/ffmpeg.py renamed to src/thumbnails/ffmpeg.py

@@ -0,0 +1,75 @@
+import concurrent.futures
+import functools
+import itertools
+import os
+
+import click
+
+from . import ThumbnailExistsError
+from . import ThumbnailFactory
+from .constants import DEFAULT_BASE
+from .constants import DEFAULT_COMPRESS
+from .constants import DEFAULT_FORMAT
+from .constants import DEFAULT_INTERVAL
+from .constants import DEFAULT_OUTPUT
+from .constants import DEFAULT_SKIP
+from .pathtools import listdir
+from .pathtools import metadata_path
+from .video import Video
+
+
+class Generator:
+    """High-level class for generating thumbnails."""
+
+    def __init__(self, inputs):
+        if all(map(os.path.isfile, inputs)):
+            self.inputs = set(map(os.path.abspath, inputs))
+        elif all(map(os.path.isdir, inputs)):
+            self.inputs = set(itertools.chain(*map(listdir, inputs)))
+        else:
+            exit("Inputs must be all files or all directories.")
+
+        self.base = DEFAULT_BASE
+        self.skip = DEFAULT_SKIP
+        self.output = DEFAULT_OUTPUT
+        self.format = DEFAULT_FORMAT
+        self.compress = DEFAULT_COMPRESS
+        self.interval = DEFAULT_INTERVAL
+
+    @staticmethod
+    def worker(video, fmt, base, skip, output):
+        """Executes the required workflows for generating a thumbnail."""
+        try:
+            thumbnail = ThumbnailFactory.create_thumbnail(fmt, video, base, skip, output)
+        except ThumbnailExistsError:
+            return print("Skipping '%s'" % os.path.relpath(video.filepath))
+        thumbnail.prepare_frames()
+        thumbnail.generate()
+
+    def generate(self):
+        self.inputs = dict(zip(map(lambda i: metadata_path(i, self.output, self.format), self.inputs), self.inputs))
+
+        if not self.skip and any(map(os.path.exists, self.inputs.keys())):
+            self.skip = not click.confirm("Do you want to overwrite already existing files?")
+
+        with concurrent.futures.ThreadPoolExecutor() as executor:
+            videos = executor.map(
+                functools.partial(
+                    Video,
+                    compress=self.compress,
+                    interval=self.interval,
+                ),
+                self.inputs.values(),
+            )
+
+        with concurrent.futures.ProcessPoolExecutor() as executor:
+            executor.map(
+                functools.partial(
+                    self.worker,
+                    fmt=self.format,
+                    base=self.base,
+                    skip=self.skip,
+                    output=self.output,
+                ),
+                videos,
+            )