hackedteam/vector-edk

View on GitHub
BaseTools/Source/Python/PatchPcdValue/PatchPcdValue.py

Summary

Maintainability
D
2 days
Test Coverage

Function PatchBinaryFile has a Cognitive Complexity of 65 (exceeds 5 allowed). Consider refactoring.
Open

def PatchBinaryFile(FileName, ValueOffset, TypeName, ValueString, MaxSize=0):
    #
    # Length of Binary File
    #
    FileHandle = open (FileName, 'rb')
Severity: Minor
Found in BaseTools/Source/Python/PatchPcdValue/PatchPcdValue.py - About 1 day 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 Main has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
Open

def Main():
    try:
        #
        # Check input parameter
        #
Severity: Minor
Found in BaseTools/Source/Python/PatchPcdValue/PatchPcdValue.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 PatchBinaryFile has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

def PatchBinaryFile(FileName, ValueOffset, TypeName, ValueString, MaxSize=0):
Severity: Minor
Found in BaseTools/Source/Python/PatchPcdValue/PatchPcdValue.py - About 35 mins to fix

    Avoid too many return statements within this function.
    Open

                    return PARAMETER_INVALID, "PCD Value %s is not valid dec or hex string array." %(ValueString)
    Severity: Major
    Found in BaseTools/Source/Python/PatchPcdValue/PatchPcdValue.py - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

              return 1
      Severity: Major
      Found in BaseTools/Source/Python/PatchPcdValue/PatchPcdValue.py - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

            return 0, "Patch Value into File %s successfully." %(FileName)
        Severity: Major
        Found in BaseTools/Source/Python/PatchPcdValue/PatchPcdValue.py - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                      return 1
          Severity: Major
          Found in BaseTools/Source/Python/PatchPcdValue/PatchPcdValue.py - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                        return PARAMETER_INVALID, "PCD Value %s is not valid dec or hex string." %(ValueString)
            Severity: Major
            Found in BaseTools/Source/Python/PatchPcdValue/PatchPcdValue.py - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                      return 0
              Severity: Major
              Found in BaseTools/Source/Python/PatchPcdValue/PatchPcdValue.py - About 30 mins to fix

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

                            for ByteString in ValueString[1:-1]:
                                #
                                # Reserve zero as string tail
                                #
                                if Index + 1 >= ValueLength:
                Severity: Major
                Found in BaseTools/Source/Python/PatchPcdValue/PatchPcdValue.py and 1 other location - About 3 hrs to fix
                BaseTools/Source/Python/PatchPcdValue/PatchPcdValue.py on lines 148..158

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

                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 ByteString in ValueString[2:-1]:
                                #
                                # Reserve zero as unicode tail
                                #
                                if Index + 2 >= ValueLength:
                Severity: Major
                Found in BaseTools/Source/Python/PatchPcdValue/PatchPcdValue.py and 1 other location - About 3 hrs to fix
                BaseTools/Source/Python/PatchPcdValue/PatchPcdValue.py on lines 182..192

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

                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

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

                        if CommandOptions.LogLevel < EdkLogger.DEBUG_9:
                            EdkLogger.SetLevel(CommandOptions.LogLevel + 1)
                        else:
                            EdkLogger.SetLevel(CommandOptions.LogLevel)
                Severity: Major
                Found in BaseTools/Source/Python/PatchPcdValue/PatchPcdValue.py and 1 other location - About 1 hr to fix
                BaseTools/Source/Python/Trim/Trim.py on lines 561..564

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

                                    if ByteString.upper().startswith('0X'):
                                        ByteValue = int(ByteString, 16)
                                    else:
                                        ByteValue = int(ByteString)
                Severity: Minor
                Found in BaseTools/Source/Python/PatchPcdValue/PatchPcdValue.py and 1 other location - About 40 mins to fix
                BaseTools/Source/Python/AutoGen/GenC.py on lines 842..846

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

                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 len(Args) == 0:
                        EdkLogger.error("PatchPcdValue", PARAMETER_INVALID, ExtraData=Parser.get_usage())
                Severity: Minor
                Found in BaseTools/Source/Python/PatchPcdValue/PatchPcdValue.py and 1 other location - About 30 mins to fix
                BaseTools/Source/Python/Trim/Trim.py on lines 540..541

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

                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