************* 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:151:0: W0622: Redefining built-in 'open' (redefined-builtin)
navix/actions.py:32:0: C0115: Missing class docstring (missing-class-docstring)
navix/actions.py:32:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/actions.py:82:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/actions.py:93:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/actions.py:97:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/actions.py:101:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/actions.py:105: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:115:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/actions.py:120:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/actions.py:125:0: C0116: Missing function or method docstring (missing-function-docstring)
navix/actions.py:173:4: W0621: Redefining name 'open' from outer scope (line 151) (redefined-outer-name)
navix/actions.py:29:0: C0411: third party import "from jax_enums import Enumerable as Enum" should be placed before "from .entities import Entities, State" (wrong-import-order)
************* Module navix.entities
navix/entities.py:63:0: C0301: Line too long (103/100) (line-too-long)
navix/entities.py:218:0: C0301: Line too long (105/100) (line-too-long)
navix/entities.py:219: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:28:0: C0115: Missing class docstring (missing-class-docstring)
navix/entities.py:28:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/entities.py:71:15: E1101: Instance of 'Field' has no 'shape' member (no-member)
navix/entities.py:71:37: E1101: Instance of 'Field' has no 'ndim' member (no-member)
navix/entities.py:74:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:78:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:86:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:114:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:148:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:170:30: E1101: Instance of 'Field' has no 'shape' member (no-member)
navix/entities.py:184:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:187:8: C0103: Argument name "id" doesn't conform to snake_case naming style (invalid-name)
navix/entities.py:187:8: W0622: Redefining built-in 'id' (redefined-builtin)
navix/entities.py:206:30: E1101: Instance of 'Field' has no 'shape' member (no-member)
navix/entities.py:225:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:230:8: W0622: Redefining built-in 'open' (redefined-builtin)
navix/entities.py:251:30: E1101: Instance of 'Field' has no 'shape' member (no-member)
navix/entities.py:273:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:276:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:280:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:283:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:287:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:290:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:290:41: W0613: Unused argument 'idx' (unused-argument)
navix/entities.py:295:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:298:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:302:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:305:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:309:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:312:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:316:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:319:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:322:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:325:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/entities.py:9:0: C0412: Imports from package jax are not grouped (ungrouped-imports)
navix/entities.py:3:0: W0611: Unused Type imported from typing (unused-import)
navix/entities.py:10:0: W0611: Unused Enumerable imported from jax_enums (unused-import)
************* Module navix.environments
navix/environments/__init__.py:1:0: C0114: Missing module docstring (missing-module-docstring)
************* Module navix.environments.environment
navix/environments/environment.py:54:0: C0301: Line too long (105/100) (line-too-long)
navix/environments/environment.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/environments/environment.py:37:0: C0115: Missing class docstring (missing-class-docstring)
navix/environments/environment.py:37:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/environments/environment.py:48:0: C0115: Missing class docstring (missing-class-docstring)
navix/environments/environment.py:48:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/environments/environment.py:65:0: C0115: Missing class docstring (missing-class-docstring)
navix/environments/environment.py:81:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/environments/environment.py:82:8: R1705: Unnecessary "elif" after "return", remove the leading "el" from "elif" (no-else-return)
navix/environments/environment.py:82:11: W0143: Comparing against a callable, did you omit the parenthesis? (comparison-with-callable)
navix/environments/environment.py:84:13: W0143: Comparing against a callable, did you omit the parenthesis? (comparison-with-callable)
navix/environments/environment.py:86:13: W0143: Comparing against a callable, did you omit the parenthesis? (comparison-with-callable)
navix/environments/environment.py:89:13: W0143: Comparing against a callable, did you omit the parenthesis? (comparison-with-callable)
navix/environments/environment.py:95:13: W0143: Comparing against a callable, did you omit the parenthesis? (comparison-with-callable)
navix/environments/environment.py:104:16: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
navix/environments/environment.py:110:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/environments/environment.py:114:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/environments/environment.py:117:4: W0102: Dangerous default value ACTIONS (builtins.dict) as argument (dangerous-default-value)
navix/environments/environment.py:131:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/environments/environment.py:131:4: W0102: Dangerous default value ACTIONS (builtins.dict) as argument (dangerous-default-value)
navix/environments/environment.py:141:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/environments/environment.py:144:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/environments/environment.py:147:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/environments/environment.py:148:62: C0103: Argument name "t" doesn't conform to snake_case naming style (invalid-name)
************* Module navix.environments.room
navix/environments/room.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/environments/room.py:35:0: C0115: Missing class docstring (missing-class-docstring)
navix/environments/room.py:39:13: C0103: Variable name "k1" doesn't conform to snake_case naming style (invalid-name)
navix/environments/room.py:39:17: C0103: Variable name "k2" doesn't conform to snake_case naming style (invalid-name)
************* Module tests.test_actions
tests/test_actions.py:1:0: C0114: Missing module docstring (missing-module-docstring)
tests/test_actions.py:10:0: C0116: Missing function or method docstring (missing-function-docstring)
tests/test_actions.py:34:12: W0212: Access to a protected member _rotate of a client class (protected-access)
tests/test_actions.py:39:12: W0212: Access to a protected member _rotate of a client class (protected-access)
tests/test_actions.py:44:12: W0212: Access to a protected member _rotate of a client class (protected-access)
tests/test_actions.py:49:12: W0212: Access to a protected member _rotate of a client class (protected-access)
tests/test_actions.py:10:0: R1711: Useless return at end of function or method (useless-return)
tests/test_actions.py:56:0: C0116: Missing function or method docstring (missing-function-docstring)
tests/test_actions.py:79:4: W0105: String statement has no effect (pointless-string-statement)
tests/test_actions.py:56:0: R0915: Too many statements (57/50) (too-many-statements)
tests/test_actions.py:154:0: C0116: Missing function or method docstring (missing-function-docstring)
tests/test_actions.py:178:4: W0105: String statement has no effect (pointless-string-statement)
tests/test_actions.py:202:19: W0212: Access to a protected member _walkable of a client class (protected-access)
tests/test_actions.py:204:11: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
tests/test_actions.py:239:0: C0116: Missing function or method docstring (missing-function-docstring)
tests/test_actions.py:258:4: W0105: String statement has no effect (pointless-string-statement)
tests/test_actions.py:283:7: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
tests/test_actions.py:296:7: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
tests/test_actions.py:302:7: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
tests/test_actions.py:305:0: C0116: Missing function or method docstring (missing-function-docstring)
tests/test_actions.py:354:7: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
tests/test_actions.py:364:7: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
tests/test_actions.py:376:7: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
tests/test_actions.py:387:7: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
tests/test_actions.py:398:7: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
tests/test_actions.py:407:7: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
tests/test_actions.py:416:7: C0209: Formatting a regular string which could be a f-string (consider-using-f-string)
tests/test_actions.py:305:0: R0915: Too many statements (52/50) (too-many-statements)
************* Module tests.test_observations
tests/test_observations.py:1:0: C0114: Missing module docstring (missing-module-docstring)
tests/test_observations.py:9:0: C0116: Missing function or method docstring (missing-function-docstring)
tests/test_observations.py:9:0: R0914: Too many local variables (20/15) (too-many-locals)
tests/test_observations.py:78:4: W0622: Redefining built-in 'open' (redefined-builtin)
tests/test_observations.py:57:8: C0103: Variable name "x" doesn't conform to snake_case naming style (invalid-name)
tests/test_observations.py:58:8: C0103: Variable name "y" doesn't conform to snake_case naming style (invalid-name)
tests/test_observations.py:9:0: R1711: Useless return at end of function or method (useless-return)
tests/test_observations.py:93:0: C0116: Missing function or method docstring (missing-function-docstring)
************* Module tests.test_spaces
tests/test_spaces.py:26:0: C0301: Line too long (103/100) (line-too-long)
tests/test_spaces.py:34:0: C0304: Final newline missing (missing-final-newline)
tests/test_spaces.py:1:0: C0114: Missing module docstring (missing-module-docstring)
tests/test_spaces.py:6:0: C0116: Missing function or method docstring (missing-function-docstring)
tests/test_spaces.py:20:0: C0116: Missing function or method docstring (missing-function-docstring)
************* Module tests.test_terminations
tests/test_terminations.py:1:0: C0114: Missing module docstring (missing-module-docstring)
tests/test_terminations.py:8:0: C0116: Missing function or method docstring (missing-function-docstring)
tests/test_terminations.py:40:0: C0116: Missing function or method docstring (missing-function-docstring)
Report
======
694 statements analysed.
Statistics by type
------------------
+---------+-------+-----------+-----------+------------+---------+
|type |number |old number |difference |%documented |%badname |
+=========+=======+===========+===========+============+=========+
|module |10 |NC |NC |0.00 |0.00 |
+---------+-------+-----------+-----------+------------+---------+
|class |13 |NC |NC |53.85 |0.00 |
+---------+-------+-----------+-----------+------------+---------+
|method |56 |NC |NC |46.43 |0.00 |
+---------+-------+-----------+-----------+------------+---------+
|function |26 |NC |NC |23.08 |0.00 |
+---------+-------+-----------+-----------+------------+---------+
External dependencies
---------------------
::
navix (tests.test_actions,tests.test_observations,tests.test_terminations)
\-actions (navix.environments.environment)
\-components (navix.environments.room,tests.test_actions,tests.test_observations,tests.test_terminations)
\-entities (navix.environments.environment,navix.environments.room,tests.test_actions,tests.test_observations)
\-graphics (navix.environments.environment,navix.environments.room)
\-grid (navix.environments.room)
\-observations (navix.environments.environment)
\-spaces (navix.environments.environment,tests.test_spaces)
\-tasks (navix.environments.environment)
\-terminations (navix.environments.environment)
1480 lines have been analyzed
Raw metrics
-----------
+----------+-------+------+---------+-----------+
|type |number |% |previous |difference |
+==========+=======+======+=========+===========+
|code |1007 |68.04 |NC |NC |
+----------+-------+------+---------+-----------+
|docstring |55 |3.72 |NC |NC |
+----------+-------+------+---------+-----------+
|comment |147 |9.93 |NC |NC |
+----------+-------+------+---------+-----------+
|empty |271 |18.31 |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 |92 |NC |NC |
+-----------+-------+---------+-----------+
|refactor |10 |NC |NC |
+-----------+-------+---------+-----------+
|warning |23 |NC |NC |
+-----------+-------+---------+-----------+
|error |5 |NC |NC |
+-----------+-------+---------+-----------+
Messages
--------
+---------------------------+------------+
|message id |occurrences |
+===========================+============+
|missing-function-docstring |50 |
+---------------------------+------------+
|consider-using-f-string |12 |
+---------------------------+------------+
|missing-module-docstring |10 |
+---------------------------+------------+
|missing-class-docstring |6 |
+---------------------------+------------+
|invalid-name |6 |
+---------------------------+------------+
|protected-access |5 |
+---------------------------+------------+
|no-member |5 |
+---------------------------+------------+
|line-too-long |5 |
+---------------------------+------------+
|comparison-with-callable |5 |
+---------------------------+------------+
|too-few-public-methods |4 |
+---------------------------+------------+
|redefined-builtin |4 |
+---------------------------+------------+
|pointless-string-statement |3 |
+---------------------------+------------+
|useless-return |2 |
+---------------------------+------------+
|unused-import |2 |
+---------------------------+------------+
|too-many-statements |2 |
+---------------------------+------------+
|dangerous-default-value |2 |
+---------------------------+------------+
|wrong-import-order |1 |
+---------------------------+------------+
|unused-argument |1 |
+---------------------------+------------+
|ungrouped-imports |1 |
+---------------------------+------------+
|too-many-locals |1 |
+---------------------------+------------+
|redefined-outer-name |1 |
+---------------------------+------------+
|no-else-return |1 |
+---------------------------+------------+
|missing-final-newline |1 |
+---------------------------+------------+
-----------------------------------
Your code has been rated at 7.84/10
github-actions[bot]
commented
1 year ago