Fix CLI bugs (#1431)

* First draft at fixing CLI bugs

Fixed output_file option

Removed -h help flag from manim/manim render

* Updated play logic test to use format = png

* Added suggestions, fixed test cases

* Revert file

* Fix?

* Append format to end of config_code

* Update manim/cli/render/render_options.py

Co-authored-by: Benjamin Hackl <[email protected]>

* Add format to default.cfg

Co-authored-by: Benjamin Hackl <[email protected]>

Author: jsonvillanueva

docs/source/manim_directive.py

@@ -218,10 +218,13 @@ def run(self):
             f'config["pixel_height"] = {pixel_height}',
             f'config["pixel_width"] = {pixel_width}',
             f'config["save_last_frame"] = {save_last_frame}',
-            f'config["save_as_gif"] = {save_as_gif}',
             f'config["write_to_movie"] = {not save_last_frame}',
             f'config["output_file"] = r"{output_file}"',
         ]
+        if save_last_frame:
+            config_code.append('config["format"] = None')
+        if save_as_gif:
+            config_code.append('config["format"] = "gif"')
 
         user_code = self.content
         if user_code[0].startswith(">>> "):  # check whether block comes from doctest

manim/__main__.py

@@ -7,7 +7,7 @@
 from .cli.cfg.commands import cfg
 from .cli.plugins.commands import plugins
 from .cli.render.commands import render
-from .constants import CONTEXT_SETTINGS, EPILOG
+from .constants import EPILOG
 
 
 def exit_early(ctx, param, value):
@@ -22,7 +22,6 @@ def exit_early(ctx, param, value):
     cls=DefaultGroup,
     default="render",
     no_args_is_help=True,
-    context_settings=CONTEXT_SETTINGS,
     help="Animation engine for explanatory math videos",
     epilog=EPILOG,
 )

manim/_config/default.cfg

@@ -20,6 +20,8 @@ notify_outdated_version = True
 # -w, --write_to_movie
 write_to_movie = True
 
+format = mp4
+
 # -s, --save_last_frame
 # setting save_last_frame to True forces write_to_movie to False
 save_last_frame = False

manim/_config/utils.py

@@ -244,6 +244,7 @@ class MyScene(Scene):
         "custom_folders",
         "disable_caching",
         "ffmpeg_loglevel",
+        "format",
         "flush_cache",
         "frame_height",
         "frame_rate",
@@ -261,6 +262,7 @@ class MyScene(Scene):
         "media_dir",
         "movie_file_extension",
         "notify_outdated_version",
+        "output_file",
         "partial_movie_dir",
         "pixel_height",
         "pixel_width",
@@ -626,6 +628,7 @@ def digest_args(self, args: argparse.Namespace) -> "ManimConfig":
             "save_as_gif",
             "write_all",
             "disable_caching",
+            "format",
             "flush_cache",
             "progress_bar",
             "transparent",
@@ -660,7 +663,6 @@ def digest_args(self, args: argparse.Namespace) -> "ManimConfig":
                 if attr is not None:
                     self[key] = attr
 
-        # The -s (--save_last_frame) flag invalidates -w (--write_to_movie).
         if self["save_last_frame"]:
             self["write_to_movie"] = False
 
@@ -842,6 +844,20 @@ def verbosity(self, val: str) -> None:
         )
         logging.getLogger("manim").setLevel(val)
 
+    @property
+    def format(self):
+        """File format; "png", "gif", "mp4", or "mov"."""
+        return self._d["format"]
+
+    @format.setter
+    def format(self, val: str) -> None:
+        """File format the renderer will output."""
+        self._set_from_list(
+            "format",
+            val,
+            [None, "png", "gif", "mp4", "mov"],
+        )
+
     ffmpeg_loglevel = property(
         lambda self: self._d["ffmpeg_loglevel"],
         lambda self, val: self._set_from_list(

manim/cli/render/commands.py

@@ -25,7 +25,7 @@
 
 
 @cloup.command(
-    context_settings=CONTEXT_SETTINGS,
+    context_settings=None,
     epilog=EPILOG,
 )
 @click.argument("file", type=Path, required=True)
@@ -34,9 +34,7 @@
 @output_options
 @render_options
 @ease_of_access_options
-@click.pass_context
 def render(
-    ctx,
     **args,
 ):
     """Render SCENE(S) from the input FILE.
@@ -71,18 +69,31 @@ def render(
         logger.warning(
             "--use_opengl_renderer is deprecated, please use --renderer=opengl instead!"
         )
-        renderer = "opengl"
+        args["renderer"] = "opengl"
 
     if args["use_webgl_renderer"]:
         logger.warning(
             "--use_webgl_renderer is deprecated, please use --renderer=webgl instead!"
         )
-        renderer = "webgl"
+        args["renderer"] = "webgl"
 
     if args["use_webgl_renderer"] and args["use_opengl_renderer"]:
         logger.warning("You may select only one renderer!")
         sys.exit()
 
+    if args["save_as_gif"]:
+        logger.warning("--save_as_gif is deprecated, please use --format=gif instead!")
+        args["format"] = "gif"
+
+    if args["save_pngs"]:
+        logger.warning("--save_pngs is deprecated, please use --format=png instead!")
+        args["format"] = "png"
+
+    if args["show_in_file_browser"]:
+        logger.warning(
+            "The short form of show_in_file_browser is deprecated and will be moved to support --format."
+        )
+
     class ClickArgs:
         def __init__(self, args):
             for name in args:

manim/cli/render/output_options.py

@@ -6,7 +6,7 @@
     option(
         "-o",
         "--output_file",
-        multiple=True,
+        type=str,
         help="Specify the filename(s) of the rendered scene(s).",
     ),
     option(

manim/cli/render/render_options.py

@@ -51,10 +51,7 @@ def validate_resolution(ctx, param, value):
         help="Render all scenes in the input file.",
     ),
     option(
-        "-f",
         "--format",
-        "file_format",
-        default="mp4",
         type=click.Choice(["png", "gif", "mp4"], case_sensitive=False),
     ),
     option("-s", "--save_last_frame", is_flag=True),
@@ -106,6 +103,27 @@ def validate_resolution(ctx, param, value):
         type=click.Path(),
         help="The path to the WebGL frontend.",
     ),
+    option(
+        "-g",
+        "--save_pngs",
+        is_flag=True,
+        default=None,
+        help="Save each frame as png (Deprecated).",
+    ),
+    option(
+        "-i",
+        "--save_as_gif",
+        default=None,
+        is_flag=True,
+        help="Save as a gif (Deprecated).",
+    ),
+    option(
+        "-s",
+        "--save_last_frame",
+        default=None,
+        is_flag=True,
+        help="Save last frame as png (Deprecated).",
+    ),
     option(
         "-t", "--transparent", is_flag=True, help="Render scenes with alpha channel."
     ),

manim/scene/scene.py

@@ -209,7 +209,11 @@ def render(self, preview=False):
         self.renderer.scene_finished(self)
 
         # Show info only if animations are rendered or to get image
-        if self.renderer.num_plays or config["save_last_frame"] or config["save_pngs"]:
+        if (
+            self.renderer.num_plays
+            or config["format"] == "png"
+            or config["save_last_frame"]
+        ):
             logger.info(
                 f"Rendered {str(self)}\nPlayed {self.renderer.num_plays} animations"
             )

manim/scene/scene_file_writer.py

@@ -97,7 +97,7 @@ def init_output_directories(self, scene_name):
                     default_name, config["movie_file_extension"]
                 ),
             )
-            if config["save_as_gif"]:
+            if config["format"] == "gif":
                 self.gif_file_path = os.path.join(
                     movie_dir,
                     add_extension_if_not_present(default_name, GIF_FILE_EXTENSION),
@@ -287,7 +287,7 @@ def write_frame(self, frame_or_renderer):
             frame = frame_or_renderer
             if config["write_to_movie"]:
                 self.writing_process.stdin.write(frame.tobytes())
-            if config["save_pngs"]:
+            if config["format"] == "png":
                 path, extension = os.path.splitext(self.image_file_path)
                 Image.fromarray(frame).save(f"{path}{self.frame_count}{extension}")
                 self.frame_count += 1
@@ -474,10 +474,10 @@ def combine_movie_files(self, partial_movie_files=None):
             "-nostdin",
         ]
 
-        if config["write_to_movie"] and not config["save_as_gif"]:
+        if config["write_to_movie"] and not config["format"] == "gif":
             commands += ["-c", "copy", movie_file_path]
 
-        if config["save_as_gif"]:
+        if config["format"] == "gif":
             if not config["output_file"]:
                 self.gif_file_path = str(
                     add_version_before_extension(self.gif_file_path)

manim/utils/file_ops.py

@@ -84,9 +84,9 @@ def open_media_file(file_writer):
 
     if config["save_last_frame"]:
         file_paths.append(file_writer.image_file_path)
-    if config["write_to_movie"] and not config["save_as_gif"]:
+    if config["write_to_movie"] and not config["format"] == "gif":
         file_paths.append(file_writer.movie_file_path)
-    if config["save_as_gif"]:
+    if config["format"] == "gif":
         file_paths.append(file_writer.gif_file_path)
 
     for file_path in file_paths: