Add pre-commit hook to ban blanket noqa (facebookresearch#746)

SgtVincent · Oct 7, 2021 · 548f844 · 548f844
1 parent a0838cc
commit 548f844
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 8 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -30,6 +30,12 @@ repos:
     -   id: pretty-format-toml
         args: [--autofix]
 
+-   repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.9.0  # Use the ref you want to point at
+    hooks:
+    -   id: python-check-blanket-noqa
+    # TODO: Add blanket type ignore check as well
+
 -   repo: https://github.com/timothycrosley/isort
     rev: 5.8.0
     hooks:

diff --git a/examples/tutorials/colabs/Habitat_Lab.ipynb b/examples/tutorials/colabs/Habitat_Lab.ipynb
@@ -79,7 +79,7 @@
     "# Change to do something like this maybe: https://stackoverflow.com/a/41432704\n",
     "def display_sample(\n",
     "    rgb_obs, semantic_obs=np.array([]), depth_obs=np.array([])\n",
-    "):  # noqa B006\n",
+    "):  # noqa: B006\n",
     "    from habitat_sim.utils.common import d3_40_colors_rgb\n",
     "\n",
     "    rgb_img = Image.fromarray(rgb_obs, mode=\"RGB\")\n",

diff --git a/examples/tutorials/nb_python/Habitat_Lab.py b/examples/tutorials/nb_python/Habitat_Lab.py
@@ -75,7 +75,7 @@
 # Change to do something like this maybe: https://stackoverflow.com/a/41432704
 def display_sample(
     rgb_obs, semantic_obs=np.array([]), depth_obs=np.array([])
-):  # noqa B006
+):  # noqa: B006
     from habitat_sim.utils.common import d3_40_colors_rgb
 
     rgb_img = Image.fromarray(rgb_obs, mode="RGB")

diff --git a/habitat/__init__.py b/habitat/__init__.py
@@ -12,11 +12,11 @@
 from habitat.core.embodied_task import EmbodiedTask, Measure, Measurements
 from habitat.core.env import Env, RLEnv
 from habitat.core.logging import logger
-from habitat.core.registry import registry  # noqa : F401
+from habitat.core.registry import registry  # noqa: F401
 from habitat.core.simulator import Sensor, SensorSuite, SensorTypes, Simulator
 from habitat.core.vector_env import ThreadedVectorEnv, VectorEnv
 from habitat.datasets import make_dataset
-from habitat.version import VERSION as __version__  # noqa
+from habitat.version import VERSION as __version__  # noqa: F401
 
 __all__ = [
     "Agent",

diff --git a/habitat/core/vector_env.py b/habitat/core/vector_env.py
@@ -180,7 +180,7 @@ def __init__(
         (
             self._connection_read_fns,
             self._connection_write_fns,
-        ) = self._spawn_workers(  # noqa
+        ) = self._spawn_workers(
             env_fn_args,
             make_env_fn,
             workers_ignore_signals=workers_ignore_signals,

diff --git a/habitat/tasks/nav/__init__.py b/habitat/tasks/nav/__init__.py
@@ -10,7 +10,7 @@
 
 def _try_register_nav_task():
     try:
-        from habitat.tasks.nav.nav import NavigationTask  # noqa
+        from habitat.tasks.nav.nav import NavigationTask  # noqa: F401
     except ImportError as e:
         navtask_import_error = e
 

diff --git a/habitat/tasks/utils.py b/habitat/tasks/utils.py
@@ -5,7 +5,7 @@
 # LICENSE file in the root directory of this source tree.
 
 import numpy as np
-import quaternion  # noqa # pylint: disable=unused-import
+import quaternion  # noqa: F401 # pylint: disable=unused-import
 
 
 def quaternion_to_rotation(q_r, q_i, q_j, q_k):

diff --git a/habitat_baselines/il/data/nav_data.py b/habitat_baselines/il/data/nav_data.py
@@ -516,7 +516,7 @@ def map_dataset_sample(self, x: Dict) -> Tuple:
                 and (
                     self.max_controller_actions == 1
                     or controller_out[
-                        i - self.max_controller_actions + 1 : i  # noqa
+                        i - self.max_controller_actions + 1 : i
                     ].sum()
                     == self.max_controller_actions - 1
                 )