Black and tests

Author: Sukhbinder Singh

README.md

@@ -24,6 +24,26 @@ vidtoolz install vidtoolz-apply-fadein-fadeout
 
 type ``vid fadeinout --help`` to get help
 
+```bash
+usage: vid fadeinout [-h] [-d DURATION] [-o OUTPUT]
+                     video {fadein,fadeout,both}
+
+Apply fadein-fadeout effects on videos
+
+positional arguments:
+  video                 Path to the input video file.
+  {fadein,fadeout,both}
+                        Type of fade effect to apply.
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -d DURATION, --duration DURATION
+                        Duration of the fade effect in seconds. (Default 1)
+  -o OUTPUT, --output OUTPUT
+                        Path for the output video file. Defaults to
+                        'output_video.mp4'.
+
+```
 
 
 ## Development

tests/test_vidtoolz_apply_fadein_fadeout.py

@@ -1,17 +1,18 @@
 import pytest
 import moviepy as mpy
-from vidtoolz_apply_fadein_fadeout.applyfadeinfadeout import apply_fade_effect  
+from vidtoolz_apply_fadein_fadeout.applyfadeinfadeout import apply_fade_effect
 import vidtoolz_apply_fadein_fadeout as w
 
 from argparse import Namespace, ArgumentParser
 
+
 def test_create_parser():
     subparser = ArgumentParser().add_subparsers()
     parser = w.create_parser(subparser)
 
     assert parser is not None
 
-    result = parser.parse_args(['test.mp4', 'fadein'])
+    result = parser.parse_args(["test.mp4", "fadein"])
     assert result.video == "test.mp4"
     assert result.fade_type == "fadein"
     assert result.duration == 1
@@ -24,11 +25,13 @@ def test_plugin(capsys):
     assert "Hello! This is an example ``vidtoolz`` plugin." in captured.out
 
 
-
 @pytest.fixture
 def sample_clip():
     """Create a short test video clip."""
-    return mpy.ColorClip(size=(640, 480), color=(255, 0, 0), duration=5).with_fps(30)  # Red video
+    return mpy.ColorClip(size=(640, 480), color=(255, 0, 0), duration=5).with_fps(
+        30
+    )  # Red video
+
 
 @pytest.mark.parametrize("fade_type", ["fadein", "fadeout", "both"])
 def test_apply_fade_effect_with_clip(sample_clip, fade_type):
@@ -37,30 +40,38 @@ def test_apply_fade_effect_with_clip(sample_clip, fade_type):
     processed_clip, fps = apply_fade_effect(sample_clip, fade_type, duration)
 
     assert isinstance(processed_clip, mpy.VideoClip), "Output should be a VideoClip"
-    assert processed_clip.duration == sample_clip.duration, "Clip duration should remain unchanged"
+    assert (
+        processed_clip.duration == sample_clip.duration
+    ), "Clip duration should remain unchanged"
     assert fps == sample_clip.fps, "FPS should be preserved"
 
     sample_clip.close()
     processed_clip.close()
 
+
 @pytest.mark.parametrize("fade_type", ["fadein", "fadeout", "both"])
 def test_apply_fade_effect_with_path(tmp_path, fade_type):
     """Test fade effects using a file path."""
     test_video_path = str(tmp_path / "test.mp4")
-    sample_clip = mpy.ColorClip(size=(640, 480), color=(255, 0, 0), duration=5).with_fps(30)
+    sample_clip = mpy.ColorClip(
+        size=(640, 480), color=(255, 0, 0), duration=5
+    ).with_fps(30)
     sample_clip.write_videofile(test_video_path, codec="libx264", fps=30, audio=False)
 
     duration = 1  # 1-second fade duration
     processed_clip, fps = apply_fade_effect(test_video_path, fade_type, duration)
 
     assert isinstance(processed_clip, mpy.VideoClip), "Output should be a VideoClip"
-    assert processed_clip.duration == sample_clip.duration, "Clip duration should remain unchanged"
+    assert (
+        processed_clip.duration == sample_clip.duration
+    ), "Clip duration should remain unchanged"
     assert fps == sample_clip.fps, "FPS should be preserved"
 
     sample_clip.close()
     processed_clip.close()
 
+
 def test_invalid_fade_type(sample_clip):
     """Test with an invalid fade type."""
     with pytest.raises(ValueError, match="Invalid fade type"):
-        apply_fade_effect(sample_clip, "invalid_type", 1)
+        apply_fade_effect(sample_clip, "invalid_type", 1)

vidtoolz_apply_fadein_fadeout/__init__.py

@@ -1,32 +1,56 @@
 import vidtoolz
-from vidtoolz_apply_fadein_fadeout.applyfadeinfadeout import apply_fade_effect, write_clip
+from vidtoolz_apply_fadein_fadeout.applyfadeinfadeout import (
+    apply_fade_effect,
+    write_clip,
+)
+
 
 def create_parser(subparser):
-    parser = subparser.add_parser("fadeinout", description="Apply fadein-fadeout effects on videos ")
+    parser = subparser.add_parser(
+        "fadeinout", description="Apply fadein-fadeout effects on videos "
+    )
     # Add subprser arguments here.
     parser.add_argument("video", help="Path to the input video file.")
-    parser.add_argument("fade_type", choices=["fadein", "fadeout", "both"], help="Type of fade effect to apply.")
-    parser.add_argument("-d", "--duration", type=float, default=1, help="Duration of the fade effect in seconds. (Default 1)")
-    parser.add_argument("-o", "--output", default="output_video.mp4", help="Path for the output video file. Defaults to 'output_video.mp4'.")
+    parser.add_argument(
+        "fade_type",
+        choices=["fadein", "fadeout", "both"],
+        help="Type of fade effect to apply.",
+    )
+    parser.add_argument(
+        "-d",
+        "--duration",
+        type=float,
+        default=1,
+        help="Duration of the fade effect in seconds. (Default 1)",
+    )
+    parser.add_argument(
+        "-o",
+        "--output",
+        default="output_video.mp4",
+        help="Path for the output video file. Defaults to 'output_video.mp4'.",
+    )
 
     return parser
 
 
 class ViztoolzPlugin:
-    """ Apply fadein-fadeout effects on videos  """
+    """Apply fadein-fadeout effects on videos"""
+
     __name__ = "fadeinout"
 
     @vidtoolz.hookimpl
     def register_commands(self, subparser):
         self.parser = create_parser(subparser)
         self.parser.set_defaults(func=self.run)
-    
+
     def run(self, args):
         clip, fps = apply_fade_effect(args.video, args.fade_type, args.duration)
-        write_clip(clip,fps, args.output)
-    
+        write_clip(clip, fps, args.output)
+        print(f"{args.output} written.")
+
     def hello(self, args):
         # this routine will be called when "vidtoolz "fadeinout is called."
         print("Hello! This is an example ``vidtoolz`` plugin.")
 
+
 fadeinout_plugin = ViztoolzPlugin()

vidtoolz_apply_fadein_fadeout/applyfadeinfadeout.py

@@ -2,6 +2,7 @@
 from moviepy import VideoFileClip
 from moviepy import vfx
 
+
 def apply_fade_effect(video_path, fade_type, duration):
     """
     Apply fadein or fadeout effect to a video and write the result to an output file.
@@ -11,30 +12,32 @@ def apply_fade_effect(video_path, fade_type, duration):
         fade_type (str): "fadein" or "fadeout" or "both".
         duration (float): Duration of the fade effect in seconds.
     """
-    # Load video clip 
-    clip = (
-        VideoFileClip(video_path) if isinstance(video_path, str) else video_path
-    )
+    # Load video clip
+    clip = VideoFileClip(video_path) if isinstance(video_path, str) else video_path
     fps = clip.fps
     # Apply fade effects
     if fade_type.lower() == "fadein":
         processed_clip = clip.with_effects([vfx.FadeIn(duration)])
     elif fade_type.lower() == "fadeout":
         processed_clip = clip.with_effects([vfx.FadeOut(duration)])
     elif fade_type.lower() == "both":
-        processed_clip = clip.with_effects([vfx.FadeIn(duration), vfx.FadeOut(duration)])
+        processed_clip = clip.with_effects(
+            [vfx.FadeIn(duration), vfx.FadeOut(duration)]
+        )
     else:
         raise ValueError("Invalid fade type. Choose 'fadein', 'fadeout', or 'both'.")
-    
-    clip.close()
+
     return processed_clip, fps
 
+
 def write_clip(processed_clip, fps, output_path):
     """
     output_path (str): Path to save the output video.
     """
     # Write the result to the output file. Using the same codec as input.
-    processed_clip.write_videofile(output_path, codec="libx264", audio_codec="aac", fps=fps)
+    has_audio = processed_clip.audio is not None
+    processed_clip.write_videofile(
+        output_path, codec="libx264",  fps=fps,  audio_codec="aac" if has_audio else None,
+    )
     # Close the clips to free up resources
     processed_clip.close()
-