MAKENTNU/web

View on GitHub
src/make_queue/models/reservation.py

Summary

Maintainability
C
1 day
Test Coverage

Function validate has a Cognitive Complexity of 32 (exceeds 5 allowed). Consider refactoring.
Open

    def validate(self):
        # User needs to be able to print, for it to be able to reserve the printers
        if not self.machine.can_user_use(self.user):
            return False

Severity: Minor
Found in src/make_queue/models/reservation.py - About 4 hrs 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

Cyclomatic complexity is too high in method validate. (22)
Open

    def validate(self):
        # User needs to be able to print, for it to be able to reserve the printers
        if not self.machine.can_user_use(self.user):
            return False

Severity: Minor
Found in src/make_queue/models/reservation.py by radon

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.

Source: http://radon.readthedocs.org/en/latest/intro.html

Cyclomatic complexity is too high in method get_best_quota. (11)
Open

    def get_best_quota(cls, reservation: 'Reservation') -> Optional['Quota']:
        """
        Selects the best quota for the given reservation,
        by preferring non-diminishing quotas that do not ignore the rules.

Severity: Minor
Found in src/make_queue/models/reservation.py by radon

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.

Source: http://radon.readthedocs.org/en/latest/intro.html

Cyclomatic complexity is too high in method valid_time. (8)
Open

    def valid_time(cls, start_time: datetime, end_time: datetime, machine_type: MachineType) -> bool:
        """
        Checks if a reservation in the supplied period is allowed by the rules for the machine type.

        :param start_time: The start time of the reservation
Severity: Minor
Found in src/make_queue/models/reservation.py by radon

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.

Source: http://radon.readthedocs.org/en/latest/intro.html

Function get_best_quota has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

    def get_best_quota(cls, reservation: 'Reservation') -> Optional['Quota']:
        """
        Selects the best quota for the given reservation,
        by preferring non-diminishing quotas that do not ignore the rules.

Severity: Minor
Found in src/make_queue/models/reservation.py - About 1 hr 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

Avoid too many return statements within this function.
Open

                return False
Severity: Major
Found in src/make_queue/models/reservation.py - About 30 mins to fix

    Avoid too many return statements within this function.
    Open

                        return False
    Severity: Major
    Found in src/make_queue/models/reservation.py - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

                      return False
      Severity: Major
      Found in src/make_queue/models/reservation.py - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

                            return False
        Severity: Major
        Found in src/make_queue/models/reservation.py - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                  return self.quota_can_create_reservation()
          Severity: Major
          Found in src/make_queue/models/reservation.py - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                    return all(rule.valid_time_in_rule(start_time, end_time, len(rules) > 1) for rule in rules)
            Severity: Major
            Found in src/make_queue/models/reservation.py - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                                  return False
              Severity: Major
              Found in src/make_queue/models/reservation.py - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                            return False
                Severity: Major
                Found in src/make_queue/models/reservation.py - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                                  return False
                  Severity: Major
                  Found in src/make_queue/models/reservation.py - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                                        return False
                    Severity: Major
                    Found in src/make_queue/models/reservation.py - About 30 mins to fix

                      Refactor this function to reduce its Cognitive Complexity from 35 to the 15 allowed.
                      Open

                          def validate(self):

                      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

                      TODO found
                      Open

                          # TODO: move all validation out of the `save()` method and to a form
                      Severity: Minor
                      Found in src/make_queue/models/reservation.py by fixme

                      TODO found
                      Open

                          # TODO: remove the explicitly set `max_length` when https://github.com/goinnn/django-multiselectfield/issues/131 is resolved
                      Severity: Minor
                      Found in src/make_queue/models/reservation.py by fixme

                      TODO found
                      Open

                              # TODO: translate this and Reservation.__str__()
                      Severity: Minor
                      Found in src/make_queue/models/reservation.py by fixme

                      TODO found
                      Open

                                  # TODO: give variables proper names, or rewrite algorithm
                      Severity: Minor
                      Found in src/make_queue/models/reservation.py by fixme

                      There are no issues that match your filters.

                      Category
                      Status