hackedteam/vector-edk

View on GitHub
BaseTools/Source/Python/Common/EdkLogger.py

Summary

Maintainability
C
1 day
Test Coverage

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

def error(ToolName, ErrorCode, Message=None, File=None, Line=None, ExtraData=None, RaiseError=IsRaiseError):
    if Line == None:
        Line = "..."
    else:
        Line = "%d" % Line
Severity: Minor
Found in BaseTools/Source/Python/Common/EdkLogger.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 warn has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

def warn(ToolName, Message, File=None, Line=None, ExtraData=None):
    if _InfoLogger.level > WARN:
        return

    # if no tool name given, use caller's source file name as tool name
Severity: Minor
Found in BaseTools/Source/Python/Common/EdkLogger.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 error has 7 arguments (exceeds 4 allowed). Consider refactoring.
Open

def error(ToolName, ErrorCode, Message=None, File=None, Line=None, ExtraData=None, RaiseError=IsRaiseError):
Severity: Major
Found in BaseTools/Source/Python/Common/EdkLogger.py - About 50 mins to fix

    Function warn has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def warn(ToolName, Message, File=None, Line=None, ExtraData=None):
    Severity: Minor
    Found in BaseTools/Source/Python/Common/EdkLogger.py - About 35 mins to fix

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

      def SetLevel(Level):
          if Level not in _LogLevels:
              info("Not supported log level (%d). Use default level instead." % Level)
              Level = INFO
          _DebugLogger.setLevel(Level)
      Severity: Major
      Found in BaseTools/Source/Python/Common/EdkLogger.py and 1 other location - About 2 hrs to fix
      BaseTools/Source/Python/UPT/Logger/Log.py on lines 285..292

      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 61.

      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

          if ExtraData != None:
              LogText = _DebugMessageTemplate % TemplateDict + "\n    %s" % ExtraData
          else:
              LogText = _DebugMessageTemplate % TemplateDict
      Severity: Major
      Found in BaseTools/Source/Python/Common/EdkLogger.py and 1 other location - About 1 hr to fix
      BaseTools/Source/Python/UPT/Logger/Log.py on lines 137..140

      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 45.

      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

          if Message == None:
              if ErrorCode in gErrorMessage:
                  Message = gErrorMessage[ErrorCode]
              else:
                  Message = gErrorMessage[UNKNOWN_ERROR]
      Severity: Major
      Found in BaseTools/Source/Python/Common/EdkLogger.py and 1 other location - About 1 hr to fix
      BaseTools/Source/Python/UPT/Logger/Log.py on lines 223..227

      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 43.

      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 4 locations. Consider refactoring.
      Open

          if File != None:
              LogText =  _ErrorMessageTemplate % TemplateDict
          else:
              LogText = _ErrorMessageTemplateWithoutFile % TemplateDict
      Severity: Major
      Found in BaseTools/Source/Python/Common/EdkLogger.py and 3 other locations - About 35 mins to fix
      BaseTools/Source/Python/Common/EdkLogger.py on lines 134..137
      BaseTools/Source/Python/UPT/Logger/Log.py on lines 183..186
      BaseTools/Source/Python/UPT/Logger/Log.py on lines 241..244

      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 33.

      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 4 locations. Consider refactoring.
      Open

          if File != None:
              LogText = _WarningMessageTemplate % TemplateDict
          else:
              LogText = _WarningMessageTemplateWithoutFile % TemplateDict
      Severity: Major
      Found in BaseTools/Source/Python/Common/EdkLogger.py and 3 other locations - About 35 mins to fix
      BaseTools/Source/Python/Common/EdkLogger.py on lines 191..194
      BaseTools/Source/Python/UPT/Logger/Log.py on lines 183..186
      BaseTools/Source/Python/UPT/Logger/Log.py on lines 241..244

      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 33.

      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