Some typing improvements, add py.typed (#284)

Co-authored-by: Mark Towers <[email protected]>

Author: micimize

.gitignore

@@ -21,4 +21,5 @@ __pycache__
 
 # Virtual environments
 .env
+.venv
 venv

docs/conf.py

@@ -18,9 +18,11 @@
 # TODO: change to minigrid version
 # from TODO import __version__ as minigrid_version
 
+from __future__ import annotations
+
 import os
 import sys
-from typing import Any, Dict
+from typing import Any
 
 project = "MiniGrid"
 copyright = "2022"
@@ -79,7 +81,7 @@
     "dark_logo": "img/minigrid-white.svg",
     "gtag": "G-FBXJQQLXKD",
 }
-html_context: Dict[str, Any] = {}
+html_context: dict[str, Any] = {}
 html_context["conf_py_path"] = "/docs/"
 html_context["display_github"] = True
 html_context["github_user"] = "Farama-Foundation"

docs/scripts/gen_envs_display.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os
 
 import gymnasium

docs/scripts/gen_gifs.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import os
 import re
 

docs/scripts/move404.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import sys
 
 if __name__ == "__main__":

docs/scripts/utils.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import re
 
 

minigrid/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from gymnasium.envs.registration import register
 
 from minigrid import minigrid_env, wrappers

minigrid/benchmark.py

@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
 
+from __future__ import annotations
+
 import time
 
 import gymnasium as gym

minigrid/core/actions.py

@@ -1,4 +1,6 @@
 # Enumeration of possible actions
+from __future__ import annotations
+
 from enum import IntEnum
 
 

minigrid/core/constants.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import numpy as np
 
 TILE_PIXELS = 32