websecmap/organizations/models.py
File models.py has 390 lines of code (exceeds 250 allowed). Consider refactoring. Open
Open
# coding=UTF-8
# from __future__ import unicode_literals
import hashlib
import loggingCyclomatic complexity is too high in method add_subdomain. (10) Open
Open
@transaction.atomic
def add_subdomain(self, subdomain, internal_notes: str = ""):
# import here to prevent circular/cyclic imports, this module imports Url.
from websecmap.scanners.scanner.http import resolves
- 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. |
Function add_subdomain has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring. Open
Open
def add_subdomain(self, subdomain, internal_notes: str = ""):
# import here to prevent circular/cyclic imports, this module imports Url.
from websecmap.scanners.scanner.http import resolves
if not subdomain:- 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 too many return statements within this function. Open
Open
return TrueAvoid too many return statements within this function. Open
Open
returnAvoid too many return statements within this function. Open
Open
returnAvoid too many return statements within this function. Open
Open
return u