Function _validate_spf has a Cognitive Complexity of 134 (exceeds 5 allowed). Consider refactoring. Open
def _validate_spf(spf: str, domain: str) -> {}:
errors = list()
if not spf.startswith('v=spf1 '):
errors.append(SpfError.INVALID_RECORD_START)
parts = spf.split(' ')- 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
Avoid deeply nested control flow statements. Open
if record.startswith('v=spf1 '):
if not has_spf:
for spf_part in record.split(' '):
parts_to_consider.append(spf_part)
has_spf = TrueFunction extract_spf_from_txt has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Open
def extract_spf_from_txt(txt_records: list, domain: str):
spfs = list()
errors = list()
if not txt_records:
errors.append(SpfError.NO_SPF_FOUND)- 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
Refactor this function to reduce its Cognitive Complexity from 134 to the 15 allowed. Open
def _validate_spf(spf: str, domain: str) -> {}:- 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.
See
Either merge this branch with the identical one on line "218" or change one of the implementations. Open
pass- Read upRead up
- Exclude checks
Having two branches in the same if structure with the same implementation is at best duplicate code, and at worst a coding error. If
the same logic is truly needed for both instances, then they should be combined.
Noncompliant Code Example
if 0 <= a < 10:
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
elif 20 <= a < 50:
do_the_thing() # Noncompliant; duplicates first condition
else:
do_the_rest()
b = 4 if a > 12 else 4
Compliant Solution
if (0 <= a < 10) or (20 <= a < 50):
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
else:
do_the_rest()
b = 4
or
if 0 <= a < 10:
do_the_thing()
elif 10 <= a < 20:
do_the_other_thing()
elif 20 <= a < 50:
do_the_third_thing()
else:
do_the_rest()
b = 8 if a > 12 else 4
Either remove or fill this block of code. Open
pass- Read upRead up
- Exclude checks
Most of the time a block of code is empty when a piece of code is really missing. So such empty block must be either filled or removed.
Noncompliant Code Example
for i in range(3):
pass
Exceptions
When a block contains a comment, this block is not considered to be empty.
Either remove or fill this block of code. Open
pass- Read upRead up
- Exclude checks
Most of the time a block of code is empty when a piece of code is really missing. So such empty block must be either filled or removed.
Noncompliant Code Example
for i in range(3):
pass
Exceptions
When a block contains a comment, this block is not considered to be empty.
Merge this if statement with the enclosing one. Open
if not has_spf:- Read upRead up
- Exclude checks
Merging collapsible if statements increases the code's readability.
Noncompliant Code Example
if condition1:
if condition2:
# ...
Compliant Solution
if condition1 and condition2:
# ...
Do not use bare 'except' Open
except:- Read upRead up
- Exclude checks
When catching exceptions, mention specific exceptions when possible.
Okay: except Exception:
Okay: except BaseException:
E722: except:Do not use bare 'except' Open
except:- Read upRead up
- Exclude checks
When catching exceptions, mention specific exceptions when possible.
Okay: except Exception:
Okay: except BaseException:
E722: except:Blank line contains whitespace Open
- Read upRead up
- Exclude checks
Trailing whitespace is superfluous.
The warning returned varies on whether the line itself is blank,
for easier filtering for those who want to indent their blank lines.
Okay: spam(1)\n#
W291: spam(1) \n#
W293: class Foo(object):\n \n bang = 12