Improve Cognitive Complexity of the Code
What is Cognitive Complexity
Cognitive complexity refers to a measure of how complex a piece of code (or any system) is, in terms of how difficult it is for a human to understand. Unlike other complexity measures that focus on code's structural aspects, cognitive complexity aims to gauge the effort required to follow the logic of the code by considering the number of paths, interruptions in linear flow, and the understanding of the structures that alter that flow. In simpler terms, it's about how hard it is for someone to keep track of what's going on in the code without getting lost in its twists and turns.
How to Improve Cognitive Complexity
To improve cognitive complexity, you can simplify the logic of your code, making it easier for humans to understand. Here are some strategies with short code examples:
1. Refactor Nested Conditions
Before:
if condition1:
if condition2:
# Do something complex
After:
if condition1 and condition2:
# Do something complex
2. Use Guard Clauses
Instead of deeply nested conditions, use guard clauses to exit early.
Before:
def calculate(value):
if value > 0:
# Do a lot of work
else:
return "Invalid value"
After:
def calculate(value):
if value <= 0:
return "Invalid value"
# Do a lot of work
3. Break Down Large Functions
Split large, complex functions into smaller, more manageable ones.
Before:
def process_data(data):
# Step 1
# Step 2
# Step 3
After:
def step1(data):
# Step 1
def step2(data):
# Step 2
def step3(data):
# Step 3
def process_data(data):
step1(data)
step2(data)
step3(data)
4. Simplify Boolean Expressions
Before:
if (is_admin or is_user) and has_permission:
# Allow access
After:
allow_access = is_admin or (is_user and has_permission)
if allow_access:
# Allow access
Improving cognitive complexity makes your code more readable, maintainable, and less prone to errors. By applying these strategies, you can ensure that your code is not only functional but also understandable.