瀏覽代碼

Deprecation warning gym_minigrid (#236)

Rodrigo de Lazcano 2 年之前
父節點
當前提交
5a660dd97c
共有 1 個文件被更改,包括 10 次插入0 次删除
  1. 10 0
      gym_minigrid/__init__.py

+ 10 - 0
gym_minigrid/__init__.py

@@ -1,9 +1,19 @@
+from warnings import warn
+
 from gym.envs.registration import register
 
 from gym_minigrid import minigrid, roomgrid, wrappers
 
 
 def register_minigrid_envs():
+
+    # gym_minigrid package deprecated in favor of minigrid
+    warn(
+        "The package name gym_minigrid has been deprecated in favor of minigrid. Please uninstall gym_minigrid and install minigrid with `pip install minigrid`. Future releases will be maintained under the new package name minigrid.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+
     # BlockedUnlockPickup
     # ----------------------------------------