************* Module navix
navix/__init__.py:1:0: C0114: Missing module docstring (missing-module-docstring)
************* Module navix.components
navix/components.py:36:0: C0301: Line too long (101/100) (line-too-long)
navix/components.py:89:0: C0301: Line too long (109/100) (line-too-long)
navix/components.py:100:0: C0301: Line too long (109/100) (line-too-long)
navix/components.py:120:0: C0301: Line too long (105/100) (line-too-long)
navix/components.py:121:0: C0301: Line too long (112/100) (line-too-long)
navix/components.py:168:0: C0301: Line too long (105/100) (line-too-long)
navix/components.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/components.py:32:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/components.py:82:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/components.py:96:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/components.py:113:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/components.py:105:0: R0903: Too few public methods (1/2) (too-few-public-methods)
navix/components.py:132:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/components.py:117:0: R0903: Too few public methods (1/2) (too-few-public-methods)
navix/components.py:136:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/components.py:153:0: C0115: Missing class docstring (missing-class-docstring)
navix/components.py:162:0: C0115: Missing class docstring (missing-class-docstring)
navix/components.py:162:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/components.py:28: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:9:0: C0115: Missing class docstring (missing-class-docstring)
navix/environments/keydoor.py:10:4: R0914: Too many local variables (18/15) (too-many-locals)
navix/environments/keydoor.py:11:13: C0103: Variable name "k1" doesn't conform to snake_case naming style (invalid-name)
navix/environments/keydoor.py:11:17: C0103: Variable name "k2" doesn't conform to snake_case naming style (invalid-name)
navix/environments/keydoor.py:11:21: C0103: Variable name "k3" 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:160:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/graphics.py:160:0: R0914: Too many local variables (17/15) (too-many-locals)
navix/graphics.py:166:4: C0103: Variable name "y" doesn't conform to snake_case naming style (invalid-name)
navix/graphics.py:166:7: C0103: Variable name "x" doesn't conform to snake_case naming style (invalid-name)
navix/graphics.py:196:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/graphics.py:202:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/graphics.py:207:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/graphics.py:1:0: W0611: Unused import jax (unused-import)
************* Module navix.observations
navix/observations.py:91:0: C0301: Line too long (110/100) (line-too-long)
navix/observations.py:102:0: C0301: Line too long (114/100) (line-too-long)
navix/observations.py:116:0: C0304: Final newline missing (missing-final-newline)
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:73:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/observations.py:88:20: C0103: Argument name "x" doesn't conform to snake_case naming style (invalid-name)
navix/observations.py:97:24: C0103: Argument name "x" doesn't conform to snake_case naming style (invalid-name)
************* Module navix.terminations
navix/terminations.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/terminations.py:29:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/terminations.py:33:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/terminations.py:33:29: W0613: Unused argument 'prev_state' (unused-argument)
navix/terminations.py:33:48: W0613: Unused argument 'action' (unused-argument)
************* Module tests.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)
************* Module tests.test_observations
tests/test_observations.py:13:0: C0304: Final newline missing (missing-final-newline)
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)
Report
======
294 statements analysed.
Statistics by type
------------------
+---------+-------+-----------+-----------+------------+---------+
|type |number |old number |difference |%documented |%badname |
+=========+=======+===========+===========+============+=========+
|module |8 |NC |NC |0.00 |0.00 |
+---------+-------+-----------+-----------+------------+---------+
|class |9 |NC |NC |66.67 |0.00 |
+---------+-------+-----------+-----------+------------+---------+
|method |3 |NC |NC |33.33 |0.00 |
+---------+-------+-----------+-----------+------------+---------+
|function |23 |NC |NC |8.70 |0.00 |
+---------+-------+-----------+-----------+------------+---------+
694 lines have been analyzed
Raw metrics
-----------
+----------+-------+------+---------+-----------+
|type |number |% |previous |difference |
+==========+=======+======+=========+===========+
|code |408 |58.79 |NC |NC |
+----------+-------+------+---------+-----------+
|docstring |38 |5.48 |NC |NC |
+----------+-------+------+---------+-----------+
|comment |101 |14.55 |NC |NC |
+----------+-------+------+---------+-----------+
|empty |147 |21.18 |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 |52 |NC |NC |
+-----------+-------+---------+-----------+
|refactor |10 |NC |NC |
+-----------+-------+---------+-----------+
|warning |8 |NC |NC |
+-----------+-------+---------+-----------+
|error |0 |NC |NC |
+-----------+-------+---------+-----------+
Messages
--------
+---------------------------+------------+
|message id |occurrences |
+===========================+============+
|missing-function-docstring |23 |
+---------------------------+------------+
|missing-module-docstring |8 |
+---------------------------+------------+
|line-too-long |8 |
+---------------------------+------------+
|too-few-public-methods |7 |
+---------------------------+------------+
|invalid-name |7 |
+---------------------------+------------+
|protected-access |4 |
+---------------------------+------------+
|unused-argument |3 |
+---------------------------+------------+
|missing-class-docstring |3 |
+---------------------------+------------+
|too-many-locals |2 |
+---------------------------+------------+
|missing-final-newline |2 |
+---------------------------+------------+
|useless-return |1 |
+---------------------------+------------+
|unused-import |1 |
+---------------------------+------------+
|ungrouped-imports |1 |
+---------------------------+------------+
-----------------------------------
Your code has been rated at 7.62/10
github-actions[bot]
commented
1 year ago