Function _get_model_arrays has a Cognitive Complexity of 81 (exceeds 5 allowed). Consider refactoring. Wontfix
def _get_model_arrays(self, return_transitions=True, return_rewards=True):
if return_rewards:
if is_unwrappable_to(self.env, RewardWrapper):
reward_wrapper = unwrap_env(self.env, RewardWrapper)- Read upRead up
Cognitive Complexity
Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.
A method's cognitive complexity is based on a few simple rules:
- Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
- Code is considered more complex for each "break in the linear flow of the code"
- Code is considered more complex when "flow breaking structures are nested"
Further reading
Cyclomatic complexity is too high in method _get_model_arrays. (31) Open
def _get_model_arrays(self, return_transitions=True, return_rewards=True):
if return_rewards:
if is_unwrappable_to(self.env, RewardWrapper):
reward_wrapper = unwrap_env(self.env, RewardWrapper)- Read upRead up
- Exclude checks
Cyclomatic Complexity
Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.
Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:
| Construct | Effect on CC | Reasoning |
|---|---|---|
| if | +1 | An if statement is a single decision. |
| elif | +1 | The elif statement adds another decision. |
| else | +0 | The else statement does not cause a new decision. The decision is at the if. |
| for | +1 | There is a decision at the start of the loop. |
| while | +1 | There is a decision at the while statement. |
| except | +1 | Each except branch adds a new conditional path of execution. |
| finally | +0 | The finally block is unconditionally executed. |
| with | +1 | The with statement roughly corresponds to a try/except block (see PEP 343 for details). |
| assert | +1 | The assert statement internally roughly equals a conditional statement. |
| Comprehension | +1 | A list/set/dict comprehension of generator expression is equivalent to a for loop. |
| Boolean Operator | +1 | Every boolean operator (and, or) adds a decision point. |
Avoid deeply nested control flow statements. Open
if reward_wrapper is None:
rewards[s, a] = 0
else:
rewards[s, a] = wrapped_reward
continueAvoid deeply nested control flow statements. Open
if state[num_rewards + a] == 0:
# if reward is already collected at this field:
rew_value = 0
else:
rews_where = self.maze_env.rews_whereAvoid deeply nested control flow statements. Open
if reward_wrapper is None:
rewards[s, a] = REWARD_MOVE
if state[num_rewards + a] != 0:
rews_where = self.maze_env.rews_where
rewards[s, a] += float(Refactor this function to reduce its Cognitive Complexity from 81 to the 15 allowed. Wontfix
def _get_model_arrays(self, return_transitions=True, return_rewards=True):- Read upRead up
- Exclude checks
Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.