ducky/devices/svga.py

Summary

Maintainability
D
2 days
Test Coverage

File svga.py has 332 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""
SimpleVGA is very basic implementation of VGA-like device, with text
and graphic modes.
"""

Severity: Minor
Found in ducky/devices/svga.py - About 4 hrs to fix

    Function on_tick has a Cognitive Complexity of 27 (exceeds 5 allowed). Consider refactoring.
    Open

      def on_tick(self, task):
        self.display.machine.DEBUG('Display: refresh display')
    
        gpu = self.display.gpu
        mode = gpu.active_mode
    Severity: Minor
    Found in ducky/devices/svga.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 read_u16 has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
    Open

      def read_u16(self, offset):
        self.DEBUG('%s.read_u16: offset=%s', self.__class__.__name__, offset)
    
        if offset == SimpleVGAPorts.CONTROL:
          return 0x0000
    Severity: Minor
    Found in ducky/devices/svga.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 __init__ has 10 arguments (exceeds 4 allowed). Consider refactoring.
    Open

      def __init__(self, machine, name, memory_size = None, mmio_address = None, memory_address = None, memory_banks = None, modes = None, boot_mode = None, *args, **kwargs):
    Severity: Major
    Found in ducky/devices/svga.py - About 1 hr to fix

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

        def write_u16(self, offset, value):
          self.DEBUG('%s.put: offset=%s, value=%s', self.__class__.__name__, UINT8_FMT(offset), UINT16_FMT(value))
      
          if offset == SimpleVGAPorts.CONTROL:
            if value == SimpleVGACommands.RESET:
      Severity: Minor
      Found in ducky/devices/svga.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 __init__ has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Open

        def __init__(self, machine, name, memory_size = None, mmio_address = None, memory_address = None, memory_banks = None, modes = None, boot_mode = None, *args, **kwargs):
          if memory_address is None:
            raise InvalidResourceError('sVGA device memory address must be specified explicitly')
      
          if memory_address % PAGE_SIZE:
      Severity: Minor
      Found in ducky/devices/svga.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 __init__ has 6 arguments (exceeds 4 allowed). Consider refactoring.
      Open

        def __init__(self, machine, name, gpu = None, stream_out = None, *args, **kwargs):
      Severity: Minor
      Found in ducky/devices/svga.py - About 45 mins to fix

        Avoid too many return statements within this function.
        Open

            return 0x0000
        Severity: Major
        Found in ducky/devices/svga.py - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                return
          Severity: Major
          Found in ducky/devices/svga.py - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                    return self._device.active_bank
            Severity: Major
            Found in ducky/devices/svga.py - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                      return self._device.active_mode.depth
              Severity: Major
              Found in ducky/devices/svga.py - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                      return 0xFFFF
                Severity: Major
                Found in ducky/devices/svga.py - About 30 mins to fix

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

                  class SimpleVGACommands(enum.IntEnum):
                    RESET          = 0x0001
                    REFRESH        = 0x0002
                  
                    GRAPHIC        = 0x0020
                  Severity: Major
                  Found in ducky/devices/svga.py and 1 other location - About 1 hr to fix
                  ducky/devices/rtc.py on lines 15..22

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

                  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

                      self.data[self.dev.bank_offsets[self.dev.active_bank] + self.offset + offset] = b
                  Severity: Minor
                  Found in ducky/devices/svga.py and 1 other location - About 55 mins to fix
                  ducky/devices/svga.py on lines 263..263

                  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

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

                      return self.data[self.dev.bank_offsets[self.dev.active_bank] + self.offset + offset]
                  Severity: Minor
                  Found in ducky/devices/svga.py and 1 other location - About 55 mins to fix
                  ducky/devices/svga.py on lines 266..266

                  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