Refactored the Command Line Interface to use Click + Cloup instead of Argparse (#1013)

* Added click dependency and command structure

* Refactored code for separation of concerns

* Shortened plugins command to plugin, added render options

* first draft for render -h

* First successful render using click

* Cleaned main

* Moved flush_cache to option, ran black

* Removed argparse logic, scattered print statements

* corrected tests, all passing

* merge upstream

* fixed test with click's clirunner

* Fixed doctest configuration.rst

* Temporarily add in main_utils

* Removed main_utils.parse_args, used ManimConfig.digest_args

* fixed progress bar

* Fix jupyter

* black

* Fixed incorrectly merged merge conflict

* updated README command.png image

* updated configuration.rst expected output

* Fixed test_plugins and config_file expected type

* Refixed the jupyter fix

* Apply 3/5 suggestions

Remove stray print

Improve readability of test code

Added module docs for the subcommands

* Updated `main` to `manim` for tests

* Forced `file` positional argument to be Path type

* Fixed main -> manim

* Added libpango to linux dependency

* Updated poetry.lock

* Changed configuration.rst test

* Fixed test_a_flag test

minor space issue

added media_width to configuration.rst

* Fixed fps flag in Cairo rendering

* Fixed more outdated rst in sphinx docs

Removed default for fps option, always overwrote quality

Fixed doctest control_data

* Fixed more incorrect rst orderings

* Update tests/test_commands.py

Co-authored-by: Naveen M K <[email protected]>

* Added suggestions

* Removed unused imports

* Reverted entry point back to main

* Update manim/_config/default.cfg

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

* Adjusted ipython_magic's call to the entry_point

* Converted frame_rate to int if integer

* run black

* Fixed doctest

* Fixed issue with command name from CliRunner

* Fixed multiple video windows opening from upstream merge

* to black or not to black

* Added deprecation warning to render subcommand

* warning instead of warn

* Applied Naveen's suggestions

* Made `manim render` show the help page

* Update manim/cli/render/commands.py

Co-authored-by: Naveen M K <[email protected]>

* Update manim/cli/cfg/commands.py

Co-authored-by: Naveen M K <[email protected]>

* Update manim/cli/cfg/commands.py

Co-authored-by: Naveen M K <[email protected]>

* Update manim/cli/plugins/commands.py

Co-authored-by: Naveen M K <[email protected]>

* Addressed some style changes

* add back in write_to_movie temporarily for OpenGL support

* Removed sound flag, deprecated use_opengl_renderer, added renderer option

* revert webgl_renderer_path removal

* Fixed cfg export

Fixed readme usage of CLI

* Flake8/black

* Fixed bug in setting renderer choice

* Removed log message due to default option

Removed default option of background color

Fixed write_to_movie flag default

* Fix log_to_file tests

* Make '-c' option for config_file, not background_color

* print colored version always

* Remove -v = --version shorthand, conflicts with verbosity

* Use subprocess.run instead of Click's CliRunner for stdout

* Refactor cli/render to use Cloup instead of click-option-group

1) There's a new file for each option group
2) render is now a cloup.Command, not a Group

Fixed issue when an animation is cached, manim can't merge the partial movie files. (#1192)

* fixed issue

* fixed tests

* Update manim/renderer/cairo_renderer.py

Co-authored-by: Darylgolden <[email protected]>

* added tests

* imrpoved test

* fixed logic

* added new test

* check if the file has been outputed

* added test when caching is enabled

* fixed tests on windows

* black

* Update manim/renderer/cairo_renderer.py

Co-authored-by: Naveen M K <[email protected]>

* Update tests/assert_utils.py

Co-authored-by: Naveen M K <[email protected]>

Co-authored-by: KingWampy <[email protected]>
Co-authored-by: Darylgolden <[email protected]>
Co-authored-by: Naveen M K <[email protected]>

Added :ref_methods: to the manim directive (#1209)

* fix manim_directive for methods

* added ref_methods to Angle example

* black

* added new ref_methods references

* sort out ref_functions vs ref_methods in examples.rst

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

Fixed issue when an animation is cached, manim can't merge the partial movie files. (#1192)

* fixed issue

* fixed tests

* Update manim/renderer/cairo_renderer.py

Co-authored-by: Darylgolden <[email protected]>

* added tests

* imrpoved test

* fixed logic

* added new test

* check if the file has been outputed

* added test when caching is enabled

* fixed tests on windows

* black

* Update manim/renderer/cairo_renderer.py

Co-authored-by: Naveen M K <[email protected]>

* Update tests/assert_utils.py

Co-authored-by: Naveen M K <[email protected]>

Co-authored-by: KingWampy <[email protected]>
Co-authored-by: Darylgolden <[email protected]>
Co-authored-by: Naveen M K <[email protected]>

Added :ref_methods: to the manim directive (#1209)

* fix manim_directive for methods

* added ref_methods to Angle example

* black

* added new ref_methods references

* sort out ref_functions vs ref_methods in examples.rst

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

Fixed unnecessary args dict

* Fixed bug that changed caching hashing result

* Revert doctest logic for fps filename output

Co-authored-by: Naveen M K <[email protected]>
Co-authored-by: Benjamin Hackl <[email protected]>
Co-authored-by: Gianluca Gippetto <[email protected]>

Author: 4 people

README.md

@@ -73,7 +73,7 @@ class SquareToCircle(Scene):
 In order to view the output of this scene, save the code in a file called `example.py`. Then, run the following in a terminal window:
 
 ```sh
-manim example.py SquareToCircle -p -ql
+manim -p -ql example.py SquareToCircle 
 ```
 
 You should see your native video player program pop up and play a simple scene in which a square is transformed into a circle. You may find some more simple examples within this

docs/source/_static/command.png

@@ -39,15 +39,15 @@ your available plugins, see the following help output:
 .. code-block:: bash
 
     manim plugins -h
-    usage: manim plugins -h -l
+    Usage: manim plugins [OPTIONS]
 
-    Utility command for managing plugins
+      Manages Manim plugins.
 
-    optional arguments:
-    -h, --help    show this help message and exit
-    -l, --list    Lists all available plugins
+    Options:
+    -l, --list  List available plugins
+    -h, --help  Show this message and exit.
 
-    Made with <3 by the ManimCommunity devs
+    Made with <3 by Manim Community developers.
 
 You can list plugins as such:
 

docs/source/installation/plugins.rst

@@ -14,7 +14,7 @@ At this point, you have just executed the following command.
 
 .. code-block:: bash
 
-   $ manim scene.py SquareToCircle -pql
+   $ manim -pql scene.py SquareToCircle
 
 Let's dissect what just happened step by step.  First, this command executes
 manim on the file ``scene.py``, which contains our animation code.  Further,
@@ -57,7 +57,7 @@ the following command,
 
 .. code-block:: bash
 
-   $ manim scene.py SquareToCircle -pqh
+   $ manim -pqh scene.py SquareToCircle
 
 The ``-ql`` flag (for low quality) has been replaced by the ``-qh`` flag, for
 high quality.  Manim will take considerably longer to render this file, and it
@@ -144,7 +144,7 @@ When executing the command
 
 .. code-block:: bash
 
-   $ manim scene.py SquareToCircle -pql
+   $ manim -pql scene.py SquareToCircle
 
 it was necessary to specify which ``Scene`` class to render.  This is because a
 single file can contain more than one ``Scene`` class.  If your file contains

docs/source/tutorials/a_deeper_look.rst

@@ -90,7 +90,7 @@ high, and 4k quality, respectively.
 
 .. code-block:: bash
 
-   $ manim <file.py> SceneName -ql
+   $ manim -ql <file.py> SceneName 
 
 These flags set the values of the config options ``config.pixel_width``,
 ``config.pixel_height``, ``config.frame_rate``, and ``config.quality``.
@@ -110,7 +110,7 @@ instead of the whole video, you can execute
 
 .. code-block:: bash
 
-   $ manim <file.py> SceneName -sqh
+   $ manim -sqh <file.py> SceneName 
 
 The following example specifies the output file name (with the :code:`-o`
 flag), renders only the first ten animations (:code:`-n` flag) with a white
@@ -120,7 +120,7 @@ open the file after it is rendered.
 
 .. code-block:: bash
 
-   $ manim <file.py> SceneName -o myscene -i -n 0,10 -c WHITE
+   $ manim -o myscene -i -n 0,10 -c WHITE <file.py> SceneName 
 
 .. tip:: There are many more command line flags that manim accepts.  All the
 	 possible flags are shown by executing ``manim -h``.  A complete list
@@ -162,7 +162,7 @@ Now, executing the following command
 
 .. code-block:: bash
 
-   $ manim <file.py> SceneName -o myscene -i -c WHITE
+   $ manim -o myscene -i -c WHITE <file.py> SceneName 
 
 is equivalent to executing the following command, provided that ``manim.cfg``
 is in the same directory as <file.py>,
@@ -187,7 +187,7 @@ file being rendered, and **not** in the directory of execution.  For example,
 
 .. code-block:: bash
 
-   $ manim <path/to/file.py> SceneName -o myscene -i -c WHITE
+   $ manim -o myscene -i -c WHITE <path/to/file.py> SceneName
 
 will use the config file found in ``path/to/file.py``, if any.  It will **not**
 use the config file found in the current working directory, even if it exists.
@@ -260,15 +260,16 @@ using any config files and executing
 
 .. code-block:: bash
 
-   manim <file.py> SceneName -o myscene -c WHITE
+   manim -o myscene -c WHITE <file.py> SceneName
 
 Any command line flags have precedence over any config file.  For example,
-using the previous two config files and executing :code:`manim <file.py>
-SceneName -c RED` is equivalent to not using any config files and executing
+using the previous two config files and executing :code:`manim -c RED
+<file.py> SceneName` is equivalent to not using any config files and
+executing
 
 .. code-block:: bash
 
-   manim <file.py> SceneName -o myscene -c RED
+   manim -o myscene -c RED <file.py> SceneName
 
 There is also a **library-wide** config file that determines manim's default
 behavior, and applies to every user of the library.  It has the least
@@ -337,114 +338,50 @@ highest precedence, is:
 A list of all config options
 ****************************
 
-.. testcode::
-   :hide:
-
-   from manim._config import ManimConfig
-   from inspect import getmembers
-   print(sorted([n for n, _ in getmembers(ManimConfig, lambda v: isinstance(v, property))]))
-
-.. testoutput::
-   :options: -ELLIPSIS, +NORMALIZE_WHITESPACE
-
-   ['aspect_ratio', 'assets_dir', 'background_color', 'background_opacity', 'bottom',
-   'custom_folders', 'disable_caching', 'dry_run', 'ffmpeg_loglevel', 'flush_cache',
-   'frame_height', 'frame_rate', 'frame_size', 'frame_width', 'frame_x_radius',
-   'frame_y_radius', 'from_animation_number', 'images_dir', 'input_file',
-   'leave_progress_bars', 'left_side', 'log_dir', 'log_to_file',
-   'max_files_cached', 'media_dir', 'media_width', 'movie_file_extension', 'output_file',
-   'partial_movie_dir', 'pixel_height', 'pixel_width', 'plugins', 'png_mode',
-   'preview', 'progress_bar', 'quality', 'right_side', 'save_as_gif', 'save_last_frame',
+.. code::
+
+   ['aspect_ratio', 'assets_dir', 'background_color', 'background_opacity',
+   'bottom', 'custom_folders', 'disable_caching', 'dry_run',
+   'ffmpeg_loglevel', 'flush_cache', 'frame_height', 'frame_rate',
+   'frame_size', 'frame_width', 'frame_x_radius', 'frame_y_radius',
+   'from_animation_number', 'images_dir', 'input_file', 'left_side',
+   'log_dir', 'log_to_file', 'max_files_cached', 'media_dir', 'media_width',
+   'movie_file_extension', 'output_file', 'partial_movie_dir',
+   'pixel_height', 'pixel_width', 'plugins', 'png_mode', 'preview',
+   'progress_bar', 'quality', 'right_side', 'save_as_gif', 'save_last_frame',
    'save_pngs', 'scene_names', 'show_in_file_browser', 'sound', 'tex_dir',
    'tex_template', 'tex_template_file', 'text_dir', 'top', 'transparent',
-   'upto_animation_number', 'use_opengl_renderer', 'use_webgl_renderer', 'verbosity',
-   'video_dir', 'webgl_renderer_path', 'webgl_updater_fps', 'write_all',
+   'upto_animation_number', 'use_opengl_renderer', 'use_webgl_renderer',
+   'verbosity', 'video_dir', 'webgl_renderer_path', 'write_all',
    'write_to_movie']
 
 
 A list of all CLI flags
 ***********************
 
-.. testcode::
-   :hide:
-
-   import subprocess
-   import os
-   is_windows = os.name == 'nt'
-   result = subprocess.run(['manim', '-h'], shell=is_windows, stdout=subprocess.PIPE)
-   print(result.stdout.decode('utf-8'))
-
-.. testoutput::
-   :options: +ELLIPSIS, +NORMALIZE_WHITESPACE
-   
-   Manim Community v...
-   usage: manim file [flags] [scene [scene ...]]
-          manim {cfg,init,plugins} [opts]
-
-   Animation engine for explanatory math videos
-
-   positional arguments:
-     file                  Path to file holding the python code for the scene
-     scene_names           Name of the Scene class you want to see
-
-   optional arguments:
-     -h, --help            show this help message and exit
-     -o OUTPUT_FILE, --output_file OUTPUT_FILE
-                           Specify the name of the output file, if it should be different from the scene class name
-     -p, --preview         Automatically open the saved file once its done
-     -f, --show_in_file_browser
-                           Show the output file in the File Browser
-     --sound               Play a success/failure sound
-     --leave_progress_bars
-                           Leave progress bars displayed in terminal
-     -a, --write_all       Write all the scenes from a file
-     -w, --write_to_movie  Render the scene as a movie file (this is on by default)
-     -s, --save_last_frame
-                           Save the last frame only (no movie file is generated)
-     -g, --save_pngs       Save each frame as a png
-     -i, --save_as_gif     Save the video as gif
-     --disable_caching     Disable caching (will generate partial-movie-files anyway)
-     --flush_cache         Remove all cached partial-movie-files
-     --log_to_file         Log terminal output to file
-     -c BACKGROUND_COLOR, --background_color BACKGROUND_COLOR
-                           Specify background color
-     --media_dir MEDIA_DIR
-                           Directory to store media (including video files)
-     --log_dir LOG_DIR     Directory to store log files
-     --tex_template TEX_TEMPLATE
-                           Specify a custom TeX template file
-     --dry_run             Do a dry run (render scenes but generate no output files)
-     -t, --transparent     Render a scene with an alpha channel
-     -q {k,p,h,m,l}, --quality {k,p,h,m,l}
-                           Render at specific quality, short form of the --*_quality flags
-     --low_quality         Render at low quality
-     --medium_quality      Render at medium quality
-     --high_quality        Render at high quality
-     --production_quality  Render at default production quality
-     --fourk_quality       Render at 4K quality
-     -l                    DEPRECATED: USE -ql or --quality l
-     -m                    DEPRECATED: USE -qm or --quality m
-     -e                    DEPRECATED: USE -qh or --quality h
-     -k                    DEPRECATED: USE -qk or --quality k
-     -r RESOLUTION, --resolution RESOLUTION
-                           Resolution, passed as "height,width". Overrides the -l, -m, -e, and -k flags, if present
-     -n FROM_ANIMATION_NUMBER, --from_animation_number FROM_ANIMATION_NUMBER
-                           Start rendering at the specified animation index, instead of the first animation. If you pass in two comma separated values, e.g. '3,6', it will end
-                           the rendering at the second value
-     --use_opengl_renderer
-                              Render animations using the OpenGL renderer
-     --use_webgl_renderer     Render animations using the WebGL frontend
-     --webgl_renderer_path WEBGL_RENDERER_PATH
-                           Path to the WebGL frontend
-     --webgl_updater_fps WEBGL_UPDATER_FPS
-                           Frame rate to use when generating keyframe data for animations that use updaters while using the WebGL frontend
-     --config_file CONFIG_FILE
-                           Specify the configuration file
-     --custom_folders      Use the folders defined in the [custom_folders] section of the config file to define the output folder structure
-     -v {DEBUG,INFO,WARNING,ERROR,CRITICAL}, --verbosity {DEBUG,INFO,WARNING,ERROR,CRITICAL}
-                           Verbosity level. Also changes the ffmpeg log level unless the latter is specified in the config
-     --version             Print the current version of Manim you are using
-     --progress_bar True/False
-                           Display the progress bar
-
-   Made with <3 by the ManimCommunity devs
+.. code::
+
+   manim -h
+
+   Usage: manim [OPTIONS] COMMAND [ARGS]...
+
+     Animation engine for explanatory math videos
+
+   Options:
+     --version   Show the version and exit.
+     -h, --help  Show this message and exit.
+
+   Commands:
+     render*  Render SCENE(S) from the input FILE.
+     cfg      Manages Manim configuration files.
+     plugins  Manages Manim plugins.
+
+     Made with <3 by Manim Community developers.
+     
+Each of the subcommands has their own help page which can be 
+
+.. code::
+
+   manim render -h
+   manim cfg -h
+   manim plugins -h

docs/source/tutorials/configuration.rst

@@ -58,7 +58,7 @@ the following command:
 
 .. code-block:: bash
 
-   $ manim scene.py SquareToCircle -pql
+   $ manim -pql scene.py SquareToCircle 
 
 After showing some output, manim should render the scene into a .mp4 file,
 and open that file with the default movie player application.  You should see a
@@ -155,7 +155,7 @@ And render it using the following command:
 
 .. code-block:: bash
 
-   $ manim scene.py SquareToCircle -pql
+   $ manim -pql scene.py SquareToCircle 
 
 The output should look as follows.
 

docs/source/tutorials/quickstart.rst

@@ -3,14 +3,14 @@
 from manim import *
 
 # To watch one of these scenes, run the following:
-# python --quality m manim example_scenes.py SquareToCircle -p
+# python --quality m manim -p example_scenes.py SquareToCircle
 #
 # Use the flag --quality l for a faster rendering at a lower quality.
 # Use -s to skip to the end and just save the final frame
 # Use the -p to have preview of the animation (or image, if -s was
 # used) pop up once done.
 # Use -n <number> to skip ahead to the nth animation of a scene.
-# Use -r <number> to specify a resolution (for example, -r 1080
+# Use -r <number> to specify a resolution (for example, -r 1920,1080
 # for a 1920x1080 video)