Added MyPy Support (#1972)

* MyPy Support

* MyPy Hook

* Removing MyPy Hook

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Delete __init__.pyi

* Delete color.pyi

* Update .mypy.ini

Co-authored-by: Christopher Besch <christopher.besch@gmx.de>

* changes

* quick fix

* MyPy Hook

* MyPy Hook

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Christopher Besch <christopher.besch@gmx.de>

Author: 3 people

.mypy.ini

@@ -0,0 +1,88 @@
+[mypy]
+show_error_codes = True
+
+# ignore most files; should be checked once proper types have been implemented
+[mypy-manim.__main__]
+ignore_errors = True
+
+[mypy-manim.camera.*]
+ignore_errors = True
+
+[mypy-manim.scene.*]
+ignore_errors = True
+
+[mypy-manim.cli.cfg.*]
+ignore_errors = True
+
+[mypy-manim.mobject.*]
+ignore_errors = True
+
+[mypy-manim._config.*]
+ignore_errors = True
+
+[mypy-manim.utils.*]
+ignore_errors = True
+
+[mypy-manim.animation.*]
+ignore_errors = True
+
+# ---------------- We can't properly type this ------------------------
+
+[mypy-manim.grpc.*]
+ignore_errors = True
+
+# ---------------- Stubless imported Modules --------------------------
+
+# We should be able to create stubs for this or type hint it
+[mypy-manimpango]
+ignore_missing_imports = True
+
+# Has stubs in 3.8
+[mypy-numpy]
+ignore_missing_imports = True
+
+# Has stubs in 3.8
+[mypy-pydub]
+ignore_missing_imports = True
+
+[mypy-matplotlib]
+ignore_missing_imports = True
+
+[mypy-scipy.*]
+ignore_missing_imports = True
+
+[mypy-networkx]
+ignore_missing_imports = True
+
+[mypy-git]
+ignore_missing_imports = True
+
+[mypy-moderngl.*]
+ignore_missing_imports = True
+
+[mypy-moderngl_window.*]
+ignore_missing_imports = True
+
+[mypy-colour]
+ignore_missing_imports = True
+
+[mypy-dearpygui.*]
+ignore_missing_imports = True
+
+[mypy-screeninfo]
+ignore_missing_imports = True
+
+[mypy-IPython.*]
+ignore_missing_imports = True
+
+[mypy-watchdog.*]
+ignore_missing_imports = True
+
+[mypy-tqdm]
+ignore_missing_imports = True
+
+[mypy-mapbox_earcut]
+ignore_missing_imports = True
+
+[mypy-click_default_group]
+ignore_missing_imports = True

.pre-commit-config.yaml

@@ -55,6 +55,12 @@ repos:
         additional_dependencies: [flake8-builtins==1.5.3, flake8-bugbear==21.4.3,
                                   flake8-docstrings==1.6.0, flake8-rst-docstrings==0.2.3,
                                   flake8-pytest-style==1.5.0, flake8-simplify==0.14.1, flake8-comprehensions>=3.6.1]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 'v0.930'
+    hooks:
+      - id: mypy
+        additional_dependencies: [types-decorator, types-docutils, types-requests, types-setuptools]
+
   - repo: https://github.com/codespell-project/codespell
     rev: v2.1.0
     hooks:

docs/source/conf.py

@@ -69,7 +69,7 @@
 # This pattern also affects html_static_path and html_extra_path.
 html_extra_path = ["robots.txt"]
 
-exclude_patterns = []
+exclude_patterns: list = []
 
 # -- Options for internationalization ----------------------------------------
 # Set the destination directory of the localized po files

example_scenes/opengl.py

@@ -3,7 +3,7 @@
 
 import manim.utils.opengl as opengl
 from manim import *
-from manim.opengl import *
+from manim.opengl import *  # type: ignore
 
 # Copied from https://3b1b.github.io/manim/getting_started/example_scenes.html#surfaceexample.
 # Lines that do not yet work with the Community Version are commented.

manim/__init__.py

@@ -3,7 +3,7 @@
 
 import pkg_resources
 
-__version__ = pkg_resources.get_distribution(__name__).version
+__version__: str = pkg_resources.get_distribution(__name__).version
 
 
 import sys

manim/_config/__init__.py

@@ -17,6 +17,7 @@
 ]
 
 parser = make_config_parser()
+logger: logging.Logger
 
 # The logger can be accessed from anywhere as manim.logger, or as
 # logging.getLogger("manim").  The console must be accessed as manim.console.

manim/cli/render/commands.py

@@ -30,7 +30,7 @@
 @click.argument("scene_names", required=False, nargs=-1)
 @global_options
 @output_options
-@render_options
+@render_options  # type: ignore
 @ease_of_access_options
 def render(
     **args,

manim/cli/render/render_options.py

@@ -62,7 +62,7 @@ def validate_resolution(ctx, param, value):
         "--quality",
         default=None,
         type=click.Choice(
-            list(reversed([q["flag"] for q in QUALITIES.values() if q["flag"]])),
+            list(reversed([q["flag"] for q in QUALITIES.values() if q["flag"]])),  # type: ignore
             case_sensitive=False,
         ),
         help="Render quality at the follow resolution framerates, respectively: "

manim/plugins/import_plugins.py

@@ -22,7 +22,7 @@
         # essentially this would be similar to `from plugin import *``
         # if not just import the module with the plugin name
         if hasattr(loaded_plugin, "__all__"):
-            for thing in loaded_plugin.__all__:
+            for thing in loaded_plugin.__all__:  # type: ignore
                 exec(f"{thing}=loaded_plugin.{thing}")
                 __all__.append(thing)
         else:

manim/renderer/cairo_renderer.py

@@ -201,7 +201,7 @@ def save_static_frame_data(
         self,
         scene,
         static_mobjects: typing.Iterable[Mobject],
-    ) -> typing.Iterable[Mobject]:
+    ) -> typing.Optional[typing.Iterable[Mobject]]:
         """Compute and save the static frame, that will be reused at each frame to avoid to unecesseraly computer
         static mobjects.
 
@@ -219,7 +219,7 @@ def save_static_frame_data(
         """
         if not static_mobjects:
             self.static_image = None
-            return
+            return None
         self.update_frame(scene, mobjects=static_mobjects)
         self.static_image = self.get_frame()
         return self.static_image

manim/renderer/shader.py

@@ -11,8 +11,8 @@
 from ..utils.simple_functions import get_parameters
 
 SHADER_FOLDER = Path(__file__).parent / "shaders"
-shader_program_cache = {}
-file_path_to_code_map = {}
+shader_program_cache: dict = {}
+file_path_to_code_map: dict = {}
 
 __all__ = [
     "Object3D",

manim/renderer/shader_wrapper.py

@@ -152,7 +152,7 @@ def combine_with(self, *shader_wrappers):
 
 
 # For caching
-filename_to_code_map = {}
+filename_to_code_map: dict = {}
 
 
 def get_shader_code_from_file(filename):

manim/utils/docbuild/manim_directive.py

@@ -85,7 +85,7 @@ def construct(self):
 
 import jinja2
 from docutils import nodes
-from docutils.parsers.rst import Directive, directives
+from docutils.parsers.rst import Directive, directives  # type: ignore
 from docutils.statemachine import StringList
 
 from manim import QUALITIES