github-actions[bot]
commented
1 year ago ************* Module navix
navix/__init__.py:1:0: C0114: Missing module docstring (missing-module-docstring)
************* Module navix._version
navix/_version.py:1:0: C0114: Missing module docstring (missing-module-docstring)
************* Module navix.actions
navix/actions.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/actions.py:129:0: W0622: Redefining built-in 'open' (redefined-builtin)
navix/actions.py:71:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/actions.py:82:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/actions.py:86:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/actions.py:90:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/actions.py:94:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/actions.py:98:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/actions.py:102:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/actions.py:106:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/actions.py:110:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/actions.py:129:0: C0116: Missing function or method docstring (missing-function-docstring)
************* Module navix.components
navix/components.py:33:0: C0301: Line too long (101/100) (line-too-long)
navix/components.py:43:0: C0301: Line too long (109/100) (line-too-long)
navix/components.py:54:0: C0301: Line too long (109/100) (line-too-long)
navix/components.py:74:0: C0301: Line too long (105/100) (line-too-long)
navix/components.py:75:0: C0301: Line too long (112/100) (line-too-long)
navix/components.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/components.py:29:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/components.py:36:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/components.py:50:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/components.py:67:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/components.py:59:0: R0903: Too few public methods (1/2) (too-few-public-methods)
navix/components.py:86:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/components.py:71:0: R0903: Too few public methods (1/2) (too-few-public-methods)
navix/components.py:90:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/components.py:25:0: C0412: Imports from package jax are not grouped (ungrouped-imports)
************* Module navix.environments.keydoor
navix/environments/keydoor.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/environments/keydoor.py:15:0: C0115: Missing class docstring (missing-class-docstring)
navix/environments/keydoor.py:16:4: R0914: Too many local variables (22/15) (too-many-locals)
navix/environments/keydoor.py:17:13: C0103: Variable name "k1" doesn't conform to snake_case naming style (invalid-name)
navix/environments/keydoor.py:17:17: C0103: Variable name "k2" doesn't conform to snake_case naming style (invalid-name)
navix/environments/keydoor.py:17:21: C0103: Variable name "k3" doesn't conform to snake_case naming style (invalid-name)
navix/environments/keydoor.py:17:25: C0103: Variable name "k4" doesn't conform to snake_case naming style (invalid-name)
************* Module navix.graphics
navix/graphics.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/graphics.py:47:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/graphics.py:95:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/graphics.py:101:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/graphics.py:107:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/graphics.py:116:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/graphics.py:122:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/graphics.py:128:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/graphics.py:134:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/graphics.py:146:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/graphics.py:146:14: W0613: Unused argument 'size' (unused-argument)
navix/graphics.py:162:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/graphics.py:162:0: R0914: Too many local variables (17/15) (too-many-locals)
navix/graphics.py:168:4: C0103: Variable name "y" doesn't conform to snake_case naming style (invalid-name)
navix/graphics.py:168:7: C0103: Variable name "x" doesn't conform to snake_case naming style (invalid-name)
navix/graphics.py:198:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/graphics.py:204:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/graphics.py:209:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/graphics.py:1:0: W0611: Unused import jax (unused-import)
************* Module navix.grid
navix/grid.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/grid.py:80:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/grid.py:81:32: C0103: Argument name "n" doesn't conform to snake_case naming style (invalid-name)
navix/grid.py:102:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/grid.py:102:37: C0103: Argument name "n" doesn't conform to snake_case naming style (invalid-name)
navix/grid.py:106:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/grid.py:106:0: W0102: Dangerous default value {} as argument (dangerous-default-value)
************* Module navix.observations
navix/observations.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/observations.py:40:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/observations.py:44:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/observations.py:48:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/observations.py:72:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/observations.py:91:20: C0103: Argument name "x" doesn't conform to snake_case naming style (invalid-name)
navix/observations.py:104:24: C0103: Argument name "x" doesn't conform to snake_case naming style (invalid-name)
************* Module test_actions
tests/test_actions.py:1:0: C0114: Missing module docstring (missing-module-docstring)
tests/test_actions.py:7:0: C0116: Missing function or method docstring (missing-function-docstring)
tests/test_actions.py:17:12: W0212: Access to a protected member _rotate of a client class (protected-access)
tests/test_actions.py:22:12: W0212: Access to a protected member _rotate of a client class (protected-access)
tests/test_actions.py:27:12: W0212: Access to a protected member _rotate of a client class (protected-access)
tests/test_actions.py:32:12: W0212: Access to a protected member _rotate of a client class (protected-access)
tests/test_actions.py:7:0: R1711: Useless return at end of function or method (useless-return)
tests/test_actions.py:39:0: C0116: Missing function or method docstring (missing-function-docstring)
************* Module test_observations
tests/test_observations.py:1:0: C0114: Missing module docstring (missing-module-docstring)
tests/test_observations.py:5:0: C0116: Missing function or method docstring (missing-function-docstring)
************* Module test_terminations
tests/test_terminations.py:1:0: C0114: Missing module docstring (missing-module-docstring)
tests/test_terminations.py:7:0: C0116: Missing function or method docstring (missing-function-docstring)
tests/test_terminations.py:8:4: C0103: Function name "f" doesn't conform to snake_case naming style (invalid-name)
tests/test_terminations.py:37:0: C0116: Missing function or method docstring (missing-function-docstring)
tests/test_terminations.py:38:4: C0103: Function name "f" doesn't conform to snake_case naming style (invalid-name)
Report
======
441 statements analysed.
Statistics by type
------------------
+---------+-------+-----------+-----------+------------+---------+
|type |number |old number |difference |%documented |%badname |
+=========+=======+===========+===========+============+=========+
|module |11 |NC |NC |0.00 |0.00 |
+---------+-------+-----------+-----------+------------+---------+
|class |7 |NC |NC |85.71 |0.00 |
+---------+-------+-----------+-----------+------------+---------+
|method |3 |NC |NC |33.33 |0.00 |
+---------+-------+-----------+-----------+------------+---------+
|function |50 |NC |NC |30.00 |4.00 |
+---------+-------+-----------+-----------+------------+---------+
1018 lines have been analyzed
Raw metrics
-----------
+----------+-------+------+---------+-----------+
|type |number |% |previous |difference |
+==========+=======+======+=========+===========+
|code |644 |63.26 |NC |NC |
+----------+-------+------+---------+-----------+
|docstring |35 |3.44 |NC |NC |
+----------+-------+------+---------+-----------+
|comment |134 |13.16 |NC |NC |
+----------+-------+------+---------+-----------+
|empty |205 |20.14 |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 |67 |NC |NC |
+-----------+-------+---------+-----------+
|refactor |9 |NC |NC |
+-----------+-------+---------+-----------+
|warning |8 |NC |NC |
+-----------+-------+---------+-----------+
|error |0 |NC |NC |
+-----------+-------+---------+-----------+
Messages
--------
+---------------------------+------------+
|message id |occurrences |
+===========================+============+
|missing-function-docstring |37 |
+---------------------------+------------+
|invalid-name |12 |
+---------------------------+------------+
|missing-module-docstring |11 |
+---------------------------+------------+
|too-few-public-methods |6 |
+---------------------------+------------+
|line-too-long |5 |
+---------------------------+------------+
|protected-access |4 |
+---------------------------+------------+
|too-many-locals |2 |
+---------------------------+------------+
|useless-return |1 |
+---------------------------+------------+
|unused-import |1 |
+---------------------------+------------+
|unused-argument |1 |
+---------------------------+------------+
|ungrouped-imports |1 |
+---------------------------+------------+
|redefined-builtin |1 |
+---------------------------+------------+
|missing-class-docstring |1 |
+---------------------------+------------+
|dangerous-default-value |1 |
+---------------------------+------------+
-----------------------------------
Your code has been rated at 8.10/10
Closes #16