search

epignatelli / navix

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

Add CI #1

Closed epignatelli closed 1 year ago

github-actions[bot] commented 1 year ago 
************* Module navix.components
navix/components.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/components.py:12:0: C0115: Missing class docstring (missing-class-docstring)
navix/components.py:12:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/components.py:19:0: C0115: Missing class docstring (missing-class-docstring)
navix/components.py:19:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/components.py:29:0: R0903: Too few public methods (0/2) (too-few-public-methods)
navix/components.py:40:0: C0115: Missing class docstring (missing-class-docstring)
navix/components.py:4:0: W0611: Unused import abc (unused-import)
************* Module navix.environments.environment
navix/environments/environment.py:1:0: C0114: Missing module docstring (missing-module-docstring)
navix/environments/environment.py:19:0: C0115: Missing class docstring (missing-class-docstring)
navix/environments/environment.py:38:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/environments/environment.py:41:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/environments/environment.py:41:54: C0103: Argument name "ACTIONS" doesn't conform to snake_case naming style (invalid-name)
navix/environments/environment.py:41:4: W0102: Dangerous default value ACTIONS (builtins.dict) as argument (dangerous-default-value)
navix/environments/environment.py:41:54: W0621: Redefining name 'ACTIONS' from outer scope (line 16) (redefined-outer-name)
navix/environments/environment.py:51:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/environments/environment.py:54:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/environments/environment.py:57:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/environments/environment.py:57:40: C0103: Argument name "t" doesn't conform to snake_case naming style (invalid-name)
navix/environments/environment.py:62:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/environments/environment.py:63:49: C0103: Argument name "ACTIONS" doesn't conform to snake_case naming style (invalid-name)
navix/environments/environment.py:62:4: W0102: Dangerous default value ACTIONS (builtins.dict) as argument (dangerous-default-value)
navix/environments/environment.py:63:49: W0621: Redefining name 'ACTIONS' from outer scope (line 16) (redefined-outer-name)
navix/environments/environment.py:79:4: C0116: Missing function or method docstring (missing-function-docstring)
navix/environments/environment.py:79:37: C0103: Argument name "t" doesn't conform to snake_case naming style (invalid-name)
navix/environments/environment.py:13:0: W0611: Unused StepType imported from components (unused-import)
************* Module test_environment
tests/test_environment.py:1:0: C0114: Missing module docstring (missing-module-docstring)
tests/test_environment.py:6:0: C0116: Missing function or method docstring (missing-function-docstring)
tests/test_environment.py:31:0: C0116: Missing function or method docstring (missing-function-docstring)

Report
======
103 statements analysed.

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

+---------+-------+-----------+-----------+------------+---------+
|type     |number |old number |difference |%documented |%badname |
+=========+=======+===========+===========+============+=========+
|module   |3      |NC         |NC         |0.00        |0.00     |
+---------+-------+-----------+-----------+------------+---------+
|class    |5      |NC         |NC         |20.00       |0.00     |
+---------+-------+-----------+-----------+------------+---------+
|method   |7      |NC         |NC         |0.00        |0.00     |
+---------+-------+-----------+-----------+------------+---------+
|function |2      |NC         |NC         |0.00        |0.00     |
+---------+-------+-----------+-----------+------------+---------+

188 lines have been analyzed

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

+----------+-------+------+---------+-----------+
|type      |number |%     |previous |difference |
+==========+=======+======+=========+===========+
|code      |150    |79.79 |NC       |NC         |
+----------+-------+------+---------+-----------+
|docstring |7      |3.72  |NC       |NC         |
+----------+-------+------+---------+-----------+
|comment   |4      |2.13  |NC       |NC         |
+----------+-------+------+---------+-----------+
|empty     |27     |14.36 |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 |20     |NC       |NC         |
+-----------+-------+---------+-----------+
|refactor   |3      |NC       |NC         |
+-----------+-------+---------+-----------+
|warning    |6      |NC       |NC         |
+-----------+-------+---------+-----------+
|error      |0      |NC       |NC         |
+-----------+-------+---------+-----------+

Messages
--------

+---------------------------+------------+
|message id                 |occurrences |
+===========================+============+
|missing-function-docstring |9           |
+---------------------------+------------+
|missing-class-docstring    |4           |
+---------------------------+------------+
|invalid-name               |4           |
+---------------------------+------------+
|too-few-public-methods     |3           |
+---------------------------+------------+
|missing-module-docstring   |3           |
+---------------------------+------------+
|unused-import              |2           |
+---------------------------+------------+
|redefined-outer-name       |2           |
+---------------------------+------------+
|dangerous-default-value    |2           |
+---------------------------+------------+

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