EventGhost/EventGhost

View on GitHub
eg/WinApi/HID.py

Summary

Maintainability
F
6 days
Test Coverage

Function run has a Cognitive Complexity of 73 (exceeds 5 allowed). Consider refactoring.
Open

    def run(self):
        #open file/device
        try:
            handle = win32file.CreateFile(
                self.devicePath,
Severity: Minor
Found in eg/WinApi/HID.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

File HID.py has 528 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
#
# This file is part of EventGhost.
# Copyright © 2005-2020 EventGhost Project <http://www.eventghost.net/>
#
Severity: Major
Found in eg/WinApi/HID.py - About 1 day to fix

    Function GetDevicePath has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
    Open

    def GetDevicePath(
        devicePath,
        vendorId,
        productId,
        versionNumber,   # pass None to ignore
    Severity: Minor
    Found in eg/WinApi/HID.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

    Cyclomatic complexity is too high in method run. (30)
    Open

    
        def run(self):
            #open file/device
            try:
                handle = win32file.CreateFile(
    Severity: Minor
    Found in eg/WinApi/HID.py by radon

    Cyclomatic Complexity

    Cyclomatic Complexity corresponds to the number of decisions a block of code contains plus 1. This number (also called McCabe number) is equal to the number of linearly independent paths through the code. This number can be used as a guide when testing conditional logic in blocks.

    Radon analyzes the AST tree of a Python program to compute Cyclomatic Complexity. Statements have the following effects on Cyclomatic Complexity:

    Construct Effect on CC Reasoning
    if +1 An if statement is a single decision.
    elif +1 The elif statement adds another decision.
    else +0 The else statement does not cause a new decision. The decision is at the if.
    for +1 There is a decision at the start of the loop.
    while +1 There is a decision at the while statement.
    except +1 Each except branch adds a new conditional path of execution.
    finally +0 The finally block is unconditionally executed.
    with +1 The with statement roughly corresponds to a try/except block (see PEP 343 for details).
    assert +1 The assert statement internally roughly equals a conditional statement.
    Comprehension +1 A list/set/dict comprehension of generator expression is equivalent to a for loop.
    Boolean Operator +1 Every boolean operator (and, or) adds a decision point.

    Source: http://radon.readthedocs.org/en/latest/intro.html

    Function Write has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
    Open

        def Write(self, data, timeout):
            if self.handle:
                try:
                    self.lockObject.acquire()
                    if eg.debugLevel:
    Severity: Minor
    Found in eg/WinApi/HID.py - About 2 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 GetDeviceDescriptions has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
    Open

    def GetDeviceDescriptions():
        """
        gets inforamtions about the available HID as a list of DeviceDescription objects
        """
        deviceList = []
    Severity: Minor
    Found in eg/WinApi/HID.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 GetDevicePath has 12 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def GetDevicePath(
    Severity: Major
    Found in eg/WinApi/HID.py - About 1 hr to fix

      Function __init__ has 6 arguments (exceeds 4 allowed). Consider refactoring.
      Open

          def __init__(self, devicePath, vendorId, vendorString, productId, productString, versionNumber):
      Severity: Minor
      Found in eg/WinApi/HID.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                                    if tmpIndex >= len(dataIndexType) or dataIndexType[tmpIndex] == 1:  #button
                                        #collect buttons pressed
                                        btnPressed.append(tmpIndex)
                                    elif dataIndexType[tmpIndex] == 2:  #control value
                                        values[tmpIndex] = int(data[i].Data.RawValue)
        Severity: Major
        Found in eg/WinApi/HID.py - About 45 mins to fix

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

          class HIDP_VALUE_CAPS(Structure):
              _fields_ = [
                  ("UsagePage", c_ushort),
                  ("ReportID", c_char),
                  ("IsAlias", BOOLEAN),
          Severity: Major
          Found in eg/WinApi/HID.py and 1 other location - About 4 hrs to fix
          plugins/XBCDRC/__init__.py on lines 172..196

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

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

                  for i in range(vCapsArrL.value):
                      if vCapsArr[i].IsRange:
                          for ii in range(
                              vCapsArr[i].Info.Range.DataIndexMin,
                              vCapsArr[i].Info.Range.DataIndexMax + 1
          Severity: Major
          Found in eg/WinApi/HID.py and 2 other locations - About 4 hrs to fix
          eg/WinApi/HID.py on lines 144..153
          plugins/XBCDRC/__init__.py on lines 553..562

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

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

                  for i in range(bCapsArrL.value):
                      if bCapsArr[i].IsRange:
                          for ii in range(
                              bCapsArr[i].Info.Range.DataIndexMin,
                              bCapsArr[i].Info.Range.DataIndexMax + 1
          Severity: Major
          Found in eg/WinApi/HID.py and 2 other locations - About 4 hrs to fix
          eg/WinApi/HID.py on lines 155..164
          plugins/XBCDRC/__init__.py on lines 553..562

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

          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

          class HIDP_CAPS_UNION(Union):
              class HIDP_BUTTON_CAPS_RANGE(Structure):
                  _fields_ = [
                      ("UsageMin", c_ushort),
                      ("UsageMax", c_ushort),
          Severity: Major
          Found in eg/WinApi/HID.py and 1 other location - About 4 hrs to fix
          plugins/XBCDRC/__init__.py on lines 125..152

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

          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

          class HIDP_CAPS(Structure):
              _fields_ = [
                  ("Usage", c_ushort),
                  ("UsagePage", c_ushort),
                  ("InputReportByteLength", c_ushort),
          Severity: Major
          Found in eg/WinApi/HID.py and 1 other location - About 2 hrs to fix
          plugins/XBCDRC/__init__.py on lines 105..122

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

          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

          class HIDP_BUTTON_CAPS(Structure):
              _fields_ = [
                  ("UsagePage", c_ushort),
                  ("ReportID", c_char),
                  ("IsAlias", BOOLEAN),
          Severity: Major
          Found in eg/WinApi/HID.py and 1 other location - About 1 hr to fix
          plugins/XBCDRC/__init__.py on lines 155..169

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

          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

                      regHandle = _winreg.OpenKey(
                          _winreg.HKEY_LOCAL_MACHINE,
                          "SYSTEM\\CurrentControlSet\\Enum\\" + devicePathSplit[0] +
                          "\\" + devicePathSplit[1] + "\\" + devicePathSplit[2])
          Severity: Minor
          Found in eg/WinApi/HID.py and 1 other location - About 40 mins to fix
          plugins/XBCDRC/__init__.py on lines 333..336

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

          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