cea-sec/miasm

View on GitHub
miasm/core/locationdb.py

Summary

Maintainability
D
2 days
Test Coverage

File locationdb.py has 409 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import warnings
from builtins import int as int_types

from functools import reduce
from future.utils import viewitems, viewvalues
Severity: Minor
Found in miasm/core/locationdb.py - About 5 hrs to fix

    LocationDB has 38 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class LocationDB(object):
        """
        LocationDB is a "database" of information associated to location.
    
        An entry in a LocationDB is uniquely identified with a LocKey.
    Severity: Minor
    Found in miasm/core/locationdb.py - About 5 hrs to fix

      Function add_location has a Cognitive Complexity of 26 (exceeds 5 allowed). Consider refactoring.
      Open

          def add_location(self, name=None, offset=None, strict=True):
              """Add a new location in the locationDB. Returns the corresponding LocKey.
              If @name is set, also associate a name to this new location.
              If @offset is set, also associate an offset to this new location.
      
      
      Severity: Minor
      Found in miasm/core/locationdb.py - About 3 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

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

          def merge(self, location_db):
              """Merge with another LocationDB @location_db
      
              WARNING: old reference to @location_db information (such as LocKeys)
              must be retrieved from the updated version of this instance. The
      Severity: Minor
      Found in miasm/core/locationdb.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 set_location_offset has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

          def set_location_offset(self, loc_key, offset, force=False):
              """Associate the offset @offset to an LocKey @loc_key
      
              If @force is set, override silently. Otherwise, if an offset is already
              associated to @loc_key, an error will be raised
      Severity: Minor
      Found in miasm/core/locationdb.py - About 25 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

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

          def canonize_to_exprloc(self, expr):
              """
              If expr is ExprInt, return ExprLoc with corresponding loc_key
              Else, return expr
      
      
      Severity: Major
      Found in miasm/core/locationdb.py and 1 other location - About 2 hrs to fix
      miasm/expression/expression.py on lines 159..170

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

      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 already_existing_loc is not None and already_existing_loc != loc_key:
                  raise KeyError("%r is already associated to a different loc_key "
                                 "(%r)" % (offset, already_existing_loc))
      Severity: Minor
      Found in miasm/core/locationdb.py and 1 other location - About 55 mins to fix
      miasm/core/locationdb.py on lines 138..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 37.

      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 already_existing_loc is not None and already_existing_loc != loc_key:
                  raise KeyError("%r is already associated to a different loc_key "
                                 "(%r)" % (name, already_existing_loc))
      Severity: Minor
      Found in miasm/core/locationdb.py and 1 other location - About 55 mins to fix
      miasm/core/locationdb.py on lines 169..171

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

      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