Noah-Huppert/py-i2c-register

View on GitHub
py_i2c_register/register_list.py

Summary

Maintainability
A
2 hrs
Test Coverage

Function __str__ has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

    def __str__(self):
        out = "RegisterList<device_address={}, registers={{\n".format(self.dev_addr)

        for k in self.registers:
            v = self.registers[k]
Severity: Minor
Found in py_i2c_register/register_list.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 set_bits has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def set_bits(self, reg_name, seg_name, bits, write_after=False, write_fn=None):
Severity: Minor
Found in py_i2c_register/register_list.py - About 35 mins to fix

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

        def set_bits_from_int(self, reg_name, seg_name, val, write_after=False, write_fn=None):
    Severity: Minor
    Found in py_i2c_register/register_list.py - About 35 mins to fix

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

          def to_int(self, reg_name, seg_name, read_first=False):
              # Convert value and return
              return self.get(reg_name, read_first=read_first).get(seg_name).bytes_to_int()
      Severity: Minor
      Found in py_i2c_register/register_list.py and 1 other location - About 40 mins to fix
      py_i2c_register/register_list.py on lines 48..49

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

          def to_twos_comp_int(self, reg_name, seg_name, read_first=False):
              return self.get(reg_name, read_first=read_first).get(seg_name).bytes_to_twos_comp_int()
      Severity: Minor
      Found in py_i2c_register/register_list.py and 1 other location - About 40 mins to fix
      py_i2c_register/register_list.py on lines 32..34

      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

      There are no issues that match your filters.

      Category
      Status