uchicago-sg/caravel

View on GitHub
caravel/controllers/listings.py

Summary

Maintainability
A
1 hr
Test Coverage

Function show_listing has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

def show_listing(listing):
    """
    Retrieves a listing and displays it in the interface.
    """

Severity: Minor
Found in caravel/controllers/listings.py - About 55 mins to fix

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

Function modify_search has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

def modify_search(add=[], remove=[]):
    """Adds and removes the given words from the query, returning the new ?q."""

    query = request.args.get('q', '').split()
    query = [x.strip() for x in query if x.strip()]
Severity: Minor
Found in caravel/controllers/listings.py - About 35 mins to fix

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

There are no issues that match your filters.

Category
Status