Closed epignatelli closed 1 year ago
************* Module navix.components navix/components.py:1:0: C0114: Missing module docstring (missing-module-docstring) navix/components.py:31:0: C0115: Missing class docstring (missing-class-docstring) navix/components.py:31:0: R0903: Too few public methods (0/2) (too-few-public-methods) navix/components.py:38:0: C0115: Missing class docstring (missing-class-docstring) navix/components.py:38:0: R0903: Too few public methods (0/2) (too-few-public-methods) navix/components.py:48:0: R0903: Too few public methods (0/2) (too-few-public-methods) navix/components.py:59:0: C0115: Missing class docstring (missing-class-docstring) navix/components.py:28:0: C0412: Imports from package jax are not grouped (ungrouped-imports) ************* Module navix.environments.environment navix/environments/environment.py:1:0: C0114: Missing module docstring (missing-module-docstring) navix/environments/environment.py:38:0: C0115: Missing class docstring (missing-class-docstring) navix/environments/environment.py:57:4: C0116: Missing function or method docstring (missing-function-docstring) navix/environments/environment.py:60:4: C0116: Missing function or method docstring (missing-function-docstring) navix/environments/environment.py:60:4: W0102: Dangerous default value ACTIONS (builtins.dict) as argument (dangerous-default-value) navix/environments/environment.py:70:4: C0116: Missing function or method docstring (missing-function-docstring) navix/environments/environment.py:73:4: C0116: Missing function or method docstring (missing-function-docstring) navix/environments/environment.py:76:4: C0116: Missing function or method docstring (missing-function-docstring) navix/environments/environment.py:76:40: C0103: Argument name "t" doesn't conform to snake_case naming style (invalid-name) navix/environments/environment.py:81:4: C0116: Missing function or method docstring (missing-function-docstring) navix/environments/environment.py:81:4: W0102: Dangerous default value ACTIONS (builtins.dict) as argument (dangerous-default-value) navix/environments/environment.py:100:4: C0116: Missing function or method docstring (missing-function-docstring) navix/environments/environment.py:100:37: C0103: Argument name "t" doesn't conform to snake_case naming style (invalid-name) navix/environments/environment.py:32:0: W0611: Unused StepType imported from components (unused-import) ************* Module navix.grid navix/grid.py:1:0: C0114: Missing module docstring (missing-module-docstring) navix/grid.py:34:0: C0116: Missing function or method docstring (missing-function-docstring) navix/grid.py:39:0: C0116: Missing function or method docstring (missing-function-docstring) navix/grid.py:43:0: C0116: Missing function or method docstring (missing-function-docstring) navix/grid.py:47:0: C0116: Missing function or method docstring (missing-function-docstring) navix/grid.py:51:0: C0116: Missing function or method docstring (missing-function-docstring) navix/grid.py:60:0: C0116: Missing function or method docstring (missing-function-docstring) navix/grid.py:64:0: C0116: Missing function or method docstring (missing-function-docstring) navix/grid.py:68:0: C0116: Missing function or method docstring (missing-function-docstring) navix/grid.py:84: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:89:0: W0102: Dangerous default value {} as argument (dangerous-default-value) navix/grid.py:28:0: W0611: Unused ArrayLike imported from jax.typing (unused-import) ************* Module navix.observations navix/observations.py:1:0: C0114: Missing module docstring (missing-module-docstring) navix/observations.py:28:0: C0116: Missing function or method docstring (missing-function-docstring) navix/observations.py:32:0: C0116: Missing function or method docstring (missing-function-docstring) navix/observations.py:36:0: C0116: Missing function or method docstring (missing-function-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) ************* Module navix.tasks navix/tasks.py:1:0: C0114: Missing module docstring (missing-module-docstring) navix/tasks.py:34:0: C0116: Missing function or method docstring (missing-function-docstring) navix/tasks.py:37:12: C0103: Variable name "fn" doesn't conform to snake_case naming style (invalid-name) navix/tasks.py:44:0: C0116: Missing function or method docstring (missing-function-docstring) navix/tasks.py:44:9: W0613: Unused argument 'state' (unused-argument) navix/tasks.py:48:0: C0116: Missing function or method docstring (missing-function-docstring) navix/tasks.py:49:4: W0613: Unused argument 'prev_state' (unused-argument) navix/tasks.py:49:23: W0613: Unused argument 'action' (unused-argument) navix/tasks.py:62:0: C0116: Missing function or method docstring (missing-function-docstring) navix/tasks.py:63:4: W0613: Unused argument 'prev_state' (unused-argument) navix/tasks.py:63:38: W0613: Unused argument 'new_state' (unused-argument) navix/tasks.py:69:0: C0116: Missing function or method docstring (missing-function-docstring) navix/tasks.py:70:4: W0613: Unused argument 'prev_state' (unused-argument) navix/tasks.py:70:23: W0613: Unused argument 'action' (unused-argument) navix/tasks.py:70:38: W0613: Unused argument 'new_state' (unused-argument) navix/tasks.py:76:0: C0116: Missing function or method docstring (missing-function-docstring) ************* Module navix.termination navix/termination.py:1:0: C0114: Missing module docstring (missing-module-docstring) navix/termination.py:29:0: C0116: Missing function or method docstring (missing-function-docstring) navix/termination.py:33:0: C0116: Missing function or method docstring (missing-function-docstring) navix/termination.py:25:0: W0611: Unused StepType imported from components (unused-import) ************* Module navix.transitions navix/transitions.py:1:0: C0114: Missing module docstring (missing-module-docstring) navix/transitions.py:28:0: C0116: Missing function or method docstring (missing-function-docstring) navix/transitions.py:28:43: W0613: Unused argument 'action' (unused-argument) navix/transitions.py:32:0: C0116: Missing function or method docstring (missing-function-docstring) ************* Module tests.test_grid tests/test_grid.py:1:0: C0114: Missing module docstring (missing-module-docstring) tests/test_grid.py:4:0: C0116: Missing function or method docstring (missing-function-docstring) Report ====== 198 statements analysed. Statistics by type ------------------ +---------+-------+-----------+-----------+------------+---------+ |type |number |old number |difference |%documented |%badname | +=========+=======+===========+===========+============+=========+ |module |8 |NC |NC |0.00 |0.00 | +---------+-------+-----------+-----------+------------+---------+ |class |5 |NC |NC |20.00 |0.00 | +---------+-------+-----------+-----------+------------+---------+ |method |7 |NC |NC |0.00 |0.00 | +---------+-------+-----------+-----------+------------+---------+ |function |27 |NC |NC |3.70 |0.00 | +---------+-------+-----------+-----------+------------+---------+ External dependencies --------------------- :: navix (tests.test_grid) \-actions (navix.environments.environment) \-components (navix.environments.environment) \-tasks (navix.environments.environment) \-termination (navix.environments.environment) \-transitions (navix.environments.environment) 516 lines have been analyzed Raw metrics ----------- +----------+-------+------+---------+-----------+ |type |number |% |previous |difference | +==========+=======+======+=========+===========+ |code |267 |51.74 |NC |NC | +----------+-------+------+---------+-----------+ |docstring |7 |1.36 |NC |NC | +----------+-------+------+---------+-----------+ |comment |113 |21.90 |NC |NC | +----------+-------+------+---------+-----------+ |empty |129 |25.00 |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 |49 |NC |NC | +-----------+-------+---------+-----------+ |refactor |3 |NC |NC | +-----------+-------+---------+-----------+ |warning |15 |NC |NC | +-----------+-------+---------+-----------+ |error |0 |NC |NC | +-----------+-------+---------+-----------+ Messages -------- +---------------------------+------------+ |message id |occurrences | +===========================+============+ |missing-function-docstring |33 | +---------------------------+------------+ |unused-argument |9 | +---------------------------+------------+ |missing-module-docstring |8 | +---------------------------+------------+ |missing-class-docstring |4 | +---------------------------+------------+ |unused-import |3 | +---------------------------+------------+ |too-few-public-methods |3 | +---------------------------+------------+ |invalid-name |3 | +---------------------------+------------+ |dangerous-default-value |3 | +---------------------------+------------+ |ungrouped-imports |1 | +---------------------------+------------+ ----------------------------------- Your code has been rated at 6.62/10
github-actions[bot]
commented
1 year ago github-actions[bot]
commented
1 year ago