onejgordon/flow-dashboard

View on GitHub
tools.py

Summary

Maintainability
F
3 days
Test Coverage

Function gets has a Cognitive Complexity of 48 (exceeds 5 allowed). Consider refactoring.
Open

def gets(self, strings=[], lists=[], floats=[], integers=[], booleans=[],
         dates=[], times=[], json=[], multi=False, addMultiBrackets=False,
         getDefault=None, ignoreMissing=True, supportTextBooleans=False):
    '''
    Use ignoreMissing if resulting dictionary should not contain params that were not passed via request
Severity: Minor
Found in tools.py - About 7 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

File tools.py has 447 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import os, time, random, string, logging, re, cgi
import uuid
from datetime import datetime, timedelta, date
import hashlib
import pytz
Severity: Minor
Found in tools.py - About 6 hrs to fix

    Function gets has 14 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def gets(self, strings=[], lists=[], floats=[], integers=[], booleans=[],
    Severity: Major
    Found in tools.py - About 1 hr to fix

      Function safe_add_task has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
      Open

      def safe_add_task(callable, *args, **kwargs):
          """This function guarantees addition of a task to a queue.
              It retries safe_add_tasks adding task if any error occurs during task creation.
      
          There are 3 ways to use this function
      Severity: Minor
      Found in tools.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

      Function lookupDict has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
      Open

      def lookupDict(item_list, keyprop="key_string", valueTransform=None):
          """
          keyprop can be 'key_string', 'key_id', or a property name
          if valueProp is None, value at each key is full item from list
          otherwise, run specified function to get value to store in dict
      Severity: Minor
      Found in tools.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

      Function getJson has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
      Open

      def getJson(raw, default=None):
          '''
          Returns either a list or dictionary, or None
          '''
          j = None
      Severity: Minor
      Found in tools.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

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

      def variable_replacement(text, repl_dict, parens="[]"):
          for key, val in repl_dict.items():
              if key is not None:
                  key = parens[0] + key.upper() + parens[1]
                  if key in text:
      Severity: Minor
      Found in tools.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

      Similar blocks of code found in 2 locations. Consider refactoring.
      Open

          for arg in dates:
              raw = self.request.get(arg, default_value=getDefault)
              if raw:
                  vals[arg] = fromISODate(raw)
              else:
      Severity: Major
      Found in tools.py and 1 other location - About 2 hrs to fix
      tools.py on lines 393..398

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 54.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      Similar blocks of code found in 2 locations. Consider refactoring.
      Open

          for arg in times:
              raw = self.request.get(arg, default_value=getDefault)
              if raw:
                  vals[arg] = parseTimeString(raw)
              else:
      Severity: Major
      Found in tools.py and 1 other location - About 2 hrs to fix
      tools.py on lines 387..392

      Duplicated Code

      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

      Tuning

      This issue has a mass of 54.

      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

      Refactorings

      Further Reading

      There are no issues that match your filters.

      Category
      Status