github-actions[bot]
commented
1 year ago ************* Module navix._version
navix/_version.py:1:0: C0114: Missing module docstring (missing-module-docstring)
************* Module navix.components
navix/components.py:62:0: C0301: Line too long (101/100) (line-too-long)
navix/components.py:72:0: C0301: Line too long (109/100) (line-too-long)
navix/components.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/components.py:36:0: C0115: Missing class docstring (missing-class-docstring)
navix/components.py:45:0: C0115: Missing class docstring (missing-class-docstring)
navix/components.py:49:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/components.py:53:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/components.py:56:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/components.py:60:0: C0115: Missing class docstring (missing-class-docstring)
navix/components.py:60:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/components.py:65:0: C0115: Missing class docstring (missing-class-docstring)
navix/components.py:65:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/components.py:70:0: C0115: Missing class docstring (missing-class-docstring)
navix/components.py:70:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/components.py:75:0: C0115: Missing class docstring (missing-class-docstring)
navix/components.py:75:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/components.py:80:0: C0115: Missing class docstring (missing-class-docstring)
navix/components.py:80:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/components.py:87:0: C0115: Missing class docstring (missing-class-docstring)
navix/components.py:87:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/components.py:92:0: C0115: Missing class docstring (missing-class-docstring)
navix/components.py:92:0: R0903: Too few public methods (0/2) (too-few-public-methods)
************* Module navix.entities
navix/entities.py:8:0: C0301: Line too long (146/100) (line-too-long)
navix/entities.py:26:0: C0301: Line too long (133/100) (line-too-long)
navix/entities.py:51:0: C0301: Line too long (147/100) (line-too-long)
navix/entities.py:84:0: C0301: Line too long (104/100) (line-too-long)
navix/entities.py:114:0: C0301: Line too long (105/100) (line-too-long)
navix/entities.py:115:0: C0301: Line too long (112/100) (line-too-long)
navix/entities.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/entities.py:12:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:12:19: C0103: Argument name "x" doesn't conform to snake_case naming style (invalid-name)
navix/entities.py:18:0: W0223: Method 'get_sprite' is abstract in class 'Component' but is not overridden in child class 'Entity' (abstract-method)
navix/entities.py:18:0: W0223: Method 'is_transparent' is abstract in class 'Component' but is not overridden in child class 'Entity' (abstract-method)
navix/entities.py:18:0: W0223: Method 'walkable' is abstract in class 'Component' but is not overridden in child class 'Entity' (abstract-method)
navix/entities.py:22:0: W0223: Method 'is_transparent' is abstract in class 'Component' but is not overridden in child class 'Player' (abstract-method)
navix/entities.py:26:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:40:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:47:0: W0223: Method 'is_transparent' is abstract in class 'Component' but is not overridden in child class 'Goal' (abstract-method)
navix/entities.py:51:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:72:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:79:0: W0223: Method 'is_transparent' is abstract in class 'Component' but is not overridden in child class 'Key' (abstract-method)
navix/entities.py:84:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:84:66: C0103: Argument name "id" doesn't conform to snake_case naming style (invalid-name)
navix/entities.py:84:66: W0622: Redefining built-in 'id' (redefined-builtin)
navix/entities.py:104:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:111:0: W0223: Method 'is_transparent' is abstract in class 'Component' but is not overridden in child class 'Door' (abstract-method)
navix/entities.py:121:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:149:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:153:8: W0622: Redefining built-in 'open' (redefined-builtin)
navix/entities.py:175:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:186:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:197:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:213:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:6:0: C0412: Imports from package jax are not grouped (ungrouped-imports)
************* Module navix.grid
navix/grid.py:180:0: C0301: Line too long (103/100) (line-too-long)
navix/grid.py:181:0: C0301: Line too long (111/100) (line-too-long)
navix/grid.py:182:0: C0301: Line too long (104/100) (line-too-long)
navix/grid.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/grid.py:36:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/grid.py:40:38: W0621: Redefining name 'coordinates' from outer scope (line 36) (redefined-outer-name)
navix/grid.py:73:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/grid.py:85:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/grid.py:89:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/grid.py:93:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/grid.py:97:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/grid.py:101:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/grid.py:114:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/grid.py:115:32: C0103: Argument name "n" doesn't conform to snake_case naming style (invalid-name)
navix/grid.py:125:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/grid.py:125:37: C0103: Argument name "n" doesn't conform to snake_case naming style (invalid-name)
navix/grid.py:129:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/grid.py:129:20: C0103: Argument name "a" doesn't conform to snake_case naming style (invalid-name)
navix/grid.py:129:30: C0103: Argument name "b" doesn't conform to snake_case naming style (invalid-name)
navix/grid.py:158:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/grid.py:158:0: R0914: Too many local variables (17/15) (too-many-locals)
navix/grid.py:164:8: C0103: Variable name "d" doesn't conform to snake_case naming style (invalid-name)
navix/grid.py:197:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/grid.py:220:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/grid.py:220:0: W0102: Dangerous default value {} as argument (dangerous-default-value)
navix/grid.py:22:0: W0611: Unused partial imported from functools (unused-import)
navix/grid.py:25:0: W0611: Unused Sequence imported from typing (unused-import)
navix/grid.py:30:0: W0611: Unused canonicalize_axis imported from jax._src.util (unused-import)
************* Module navix.observations
navix/observations.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/observations.py:33:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/observations.py:34:4: W0613: Unused argument 'state' (unused-argument)
navix/observations.py:35:4: W0613: Unused argument 'sprites_registry' (unused-argument)
navix/observations.py:40:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/observations.py:42:4: W0613: Unused argument 'sprites_registry' (unused-argument)
navix/observations.py:55:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/observations.py:57:4: W0613: Unused argument 'sprites_registry' (unused-argument)
navix/observations.py:79:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/observations.py:103:0: C0116: Missing function or method docstring (missing-function-docstring)
************* Module performance.observations
tests/performance/observations.py:1:0: C0114: Missing module docstring (missing-module-docstring)
tests/performance/observations.py:15:0: C0116: Missing function or method docstring (missing-function-docstring)
tests/performance/observations.py:29:8: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
tests/performance/observations.py:39:10: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
tests/performance/observations.py:43:8: W0108: Lambda may not be necessary (unnecessary-lambda)
************* Module performance.profiling
tests/performance/profiling.py:1:0: C0114: Missing module docstring (missing-module-docstring)
tests/performance/profiling.py:9:0: C0116: Missing function or method docstring (missing-function-docstring)
tests/performance/profiling.py:9:0: C0103: Function name "f" doesn't conform to snake_case naming style (invalid-name)
tests/performance/profiling.py:13:4: W0621: Redefining name 'timestep' from outer scope (line 53) (redefined-outer-name)
tests/performance/profiling.py:24:0: C0116: Missing function or method docstring (missing-function-docstring)
tests/performance/profiling.py:28:4: W0621: Redefining name 'timestep' from outer scope (line 53) (redefined-outer-name)
tests/performance/profiling.py:30:24: C0103: Argument name "x" doesn't conform to snake_case naming style (invalid-name)
tests/performance/profiling.py:31:8: W0621: Redefining name 'timestep' from outer scope (line 53) (redefined-outer-name)
tests/performance/profiling.py:30:4: W0612: Unused variable 'body_fun' (unused-variable)
************* Module test_observations
tests/test_observations.py:20:0: C0301: Line too long (127/100) (line-too-long)
tests/test_observations.py:69:0: C0301: Line too long (127/100) (line-too-long)
tests/test_observations.py:1:0: C0114: Missing module docstring (missing-module-docstring)
tests/test_observations.py:8:0: C0116: Missing function or method docstring (missing-function-docstring)
tests/test_observations.py:35:8: C0103: Variable name "x" doesn't conform to snake_case naming style (invalid-name)
tests/test_observations.py:36:8: C0103: Variable name "y" doesn't conform to snake_case naming style (invalid-name)
tests/test_observations.py:8:0: R1711: Useless return at end of function or method (useless-return)
tests/test_observations.py:57:0: C0116: Missing function or method docstring (missing-function-docstring)
Report
======
404 statements analysed.
Statistics by type
------------------
+---------+-------+-----------+-----------+------------+---------+
|type |number |old number |difference |%documented |%badname |
+=========+=======+===========+===========+============+=========+
|module |8 |NC |NC |0.00 |0.00 |
+---------+-------+-----------+-----------+------------+---------+
|class |15 |NC |NC |40.00 |0.00 |
+---------+-------+-----------+-----------+------------+---------+
|method |23 |NC |NC |34.78 |0.00 |
+---------+-------+-----------+-----------+------------+---------+
|function |33 |NC |NC |27.27 |3.03 |
+---------+-------+-----------+-----------+------------+---------+
918 lines have been analyzed
Raw metrics
-----------
+----------+-------+------+---------+-----------+
|type |number |% |previous |difference |
+==========+=======+======+=========+===========+
|code |560 |61.00 |NC |NC |
+----------+-------+------+---------+-----------+
|docstring |41 |4.47 |NC |NC |
+----------+-------+------+---------+-----------+
|comment |106 |11.55 |NC |NC |
+----------+-------+------+---------+-----------+
|empty |211 |22.98 |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 |83 |NC |NC |
+-----------+-------+---------+-----------+
|refactor |9 |NC |NC |
+-----------+-------+---------+-----------+
|warning |23 |NC |NC |
+-----------+-------+---------+-----------+
|error |0 |NC |NC |
+-----------+-------+---------+-----------+
Messages
--------
+---------------------------+------------+
|message id |occurrences |
+===========================+============+
|missing-function-docstring |39 |
+---------------------------+------------+
|line-too-long |13 |
+---------------------------+------------+
|invalid-name |11 |
+---------------------------+------------+
|missing-class-docstring |9 |
+---------------------------+------------+
|missing-module-docstring |8 |
+---------------------------+------------+
|too-few-public-methods |7 |
+---------------------------+------------+
|abstract-method |7 |
+---------------------------+------------+
|unused-argument |4 |
+---------------------------+------------+
|redefined-outer-name |4 |
+---------------------------+------------+
|unused-import |3 |
+---------------------------+------------+
|redefined-builtin |2 |
+---------------------------+------------+
|consider-using-f-string |2 |
+---------------------------+------------+
|useless-return |1 |
+---------------------------+------------+
|unused-variable |1 |
+---------------------------+------------+
|unnecessary-lambda |1 |
+---------------------------+------------+
|ungrouped-imports |1 |
+---------------------------+------------+
|too-many-locals |1 |
+---------------------------+------------+
|dangerous-default-value |1 |
+---------------------------+------------+
-----------------------------------
Your code has been rated at 7.15/10
Solves #21
Opens #34