epignatelli / navix

Accelerated minigrid environments with JAX
Apache License 2.0
116 stars 10 forks source link

Fix trans #71

Closed epignatelli closed 4 months ago

github-actions[bot] commented 4 months ago
************* Module navix._version
navix/_version.py:1:0: C0114: Missing module docstring (missing-module-docstring)
************* Module navix.environments.dynamic_obstacles
navix/environments/dynamic_obstacles.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/environments/dynamic_obstacles.py:41:0: C0115: Missing class docstring (missing-class-docstring)
navix/environments/dynamic_obstacles.py:45:4: R0914: Too many local variables (17/15) (too-many-locals)
navix/environments/dynamic_obstacles.py:29:0: W0611: Unused terminations imported from navix (unused-import)
************* Module navix.rendering.registry
navix/rendering/registry.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/rendering/registry.py:52:0: C0115: Missing class docstring (missing-class-docstring)
navix/rendering/registry.py:62:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/rendering/registry.py:66:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/rendering/registry.py:70:0: C0115: Missing class docstring (missing-class-docstring)
navix/rendering/registry.py:87:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/rendering/registry.py:90:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/rendering/registry.py:93:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/rendering/registry.py:96:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/rendering/registry.py:102:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/rendering/registry.py:112:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/rendering/registry.py:122:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/rendering/registry.py:125:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/rendering/registry.py:131:4: C0116: Missing function or method docstring (missing-function-docstring)
************* Module navix.states
navix/states.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/states.py:36:0: C0115: Missing class docstring (missing-class-docstring)
navix/states.py:36:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/states.py:46:0: C0115: Missing class docstring (missing-class-docstring)
navix/states.py:62:0: C0115: Missing class docstring (missing-class-docstring)
navix/states.py:72:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:73:8: R1705: Unnecessary "elif" after "return", remove the leading "el" from "elif" (no-else-return)
navix/states.py:81:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:82:8: R1705: Unnecessary "elif" after "return", remove the leading "el" from "elif" (no-else-return)
navix/states.py:88:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:100:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:110:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:122:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:132:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:144:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:156:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:168:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:180:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:210:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:213:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:217:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:220:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:224:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:227:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:227:41: W0613: Unused argument 'idx' (unused-argument)
navix/states.py:232:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:235:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:239:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:242:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:246:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:249:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:253:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:256:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:259:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:262:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:266:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:270:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:273:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:276:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:279:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:282:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/states.py:193:0: R0904: Too many public methods (22/20) (too-many-public-methods)
************* Module navix.transitions
navix/transitions.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/transitions.py:33:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/transitions.py:39:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/transitions.py:49:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/transitions.py:27:0: W0611: Unused jax.tree_util imported as jtu (unused-import)

Report
======
300 statements analysed.

Statistics by type
------------------

+---------+-------+-----------+-----------+------------+---------+
|type     |number |old number |difference |%documented |%badname |
+=========+=======+===========+===========+============+=========+
|module   |5      |NC         |NC         |0.00        |0.00     |
+---------+-------+-----------+-----------+------------+---------+
|class    |7      |NC         |NC         |14.29       |0.00     |
+---------+-------+-----------+-----------+------------+---------+
|method   |49     |NC         |NC         |10.20       |0.00     |
+---------+-------+-----------+-----------+------------+---------+
|function |6      |NC         |NC         |50.00       |0.00     |
+---------+-------+-----------+-----------+------------+---------+

External dependencies
---------------------
::

    navix 
      \-components (navix.environments.dynamic_obstacles)
      \-entities (navix.environments.dynamic_obstacles)
      \-grid (navix.environments.dynamic_obstacles)
      \-observations (navix.environments.dynamic_obstacles)
      \-rendering 
      | \-cache (navix.environments.dynamic_obstacles)
      | \-registry (navix.environments.dynamic_obstacles)
      \-rewards (navix.environments.dynamic_obstacles)
      \-states (navix.environments.dynamic_obstacles)
      \-terminations (navix.environments.dynamic_obstacles)

725 lines have been analyzed

Raw metrics
-----------

+----------+-------+------+---------+-----------+
|type      |number |%     |previous |difference |
+==========+=======+======+=========+===========+
|code      |489    |67.45 |NC       |NC         |
+----------+-------+------+---------+-----------+
|docstring |21     |2.90  |NC       |NC         |
+----------+-------+------+---------+-----------+
|comment   |89     |12.28 |NC       |NC         |
+----------+-------+------+---------+-----------+
|empty     |126    |17.38 |NC       |NC         |
+----------+-------+------+---------+-----------+

Duplication
-----------

+-------------------------+------+---------+-----------+
|                         |now   |previous |difference |
+=========================+======+=========+===========+
|nb duplicated lines      |0     |NC       |NC         |
+-------------------------+------+---------+-----------+
|percent duplicated lines |0.000 |NC       |NC         |
+-------------------------+------+---------+-----------+

Messages by category
--------------------

+-----------+-------+---------+-----------+
|type       |number |previous |difference |
+===========+=======+=========+===========+
|convention |58     |NC       |NC         |
+-----------+-------+---------+-----------+
|refactor   |5      |NC       |NC         |
+-----------+-------+---------+-----------+
|warning    |3      |NC       |NC         |
+-----------+-------+---------+-----------+
|error      |0      |NC       |NC         |
+-----------+-------+---------+-----------+

% errors / warnings by module
-----------------------------

+-------------------------------------+------+--------+---------+-----------+
|module                               |error |warning |refactor |convention |
+=====================================+======+========+=========+===========+
|navix.states                         |0.00  |33.33   |80.00    |63.79      |
+-------------------------------------+------+--------+---------+-----------+
|navix.environments.dynamic_obstacles |0.00  |33.33   |20.00    |3.45       |
+-------------------------------------+------+--------+---------+-----------+
|navix.transitions                    |0.00  |33.33   |0.00     |6.90       |
+-------------------------------------+------+--------+---------+-----------+
|navix.rendering.registry             |0.00  |0.00    |0.00     |24.14      |
+-------------------------------------+------+--------+---------+-----------+
|navix._version                       |0.00  |0.00    |0.00     |1.72       |
+-------------------------------------+------+--------+---------+-----------+

Messages
--------

+---------------------------+------------+
|message id                 |occurrences |
+===========================+============+
|missing-function-docstring |47          |
+---------------------------+------------+
|missing-class-docstring    |6           |
+---------------------------+------------+
|missing-module-docstring   |5           |
+---------------------------+------------+
|unused-import              |2           |
+---------------------------+------------+
|no-else-return             |2           |
+---------------------------+------------+
|unused-argument            |1           |
+---------------------------+------------+
|too-many-public-methods    |1           |
+---------------------------+------------+
|too-many-locals            |1           |
+---------------------------+------------+
|too-few-public-methods     |1           |
+---------------------------+------------+

-----------------------------------
Your code has been rated at 7.80/10