EventGhost/EventGhost

View on GitHub
plugins/Serial/__init__.py

Summary

Maintainability
F
3 days
Test Coverage

File __init__.py has 342 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
#
# This file is a plugin for EventGhost.
# Copyright © 2005-2020 EventGhost Project <http://www.eventghost.net/>
#
Severity: Minor
Found in plugins/Serial/__init__.py - About 4 hrs to fix

    Function ReceiveThread has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
    Open

        def ReceiveThread(self):
            from win32event import (
                ResetEvent,
                MsgWaitForMultipleObjects,
                QS_ALLINPUT,
    Severity: Minor
    Found in plugins/Serial/__init__.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 Configure has 10 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        def Configure(
    Severity: Major
    Found in plugins/Serial/__init__.py - About 1 hr to fix

      Function __start__ has 10 arguments (exceeds 4 allowed). Consider refactoring.
      Open

          def __start__(
      Severity: Major
      Found in plugins/Serial/__init__.py - About 1 hr to fix

        Function Configure has 26 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            def Configure(
                self,
                port=0,
                baudrate=9600,
                bytesize=3,
        Severity: Minor
        Found in plugins/Serial/__init__.py - About 1 hr to fix

          Function Configure has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

              def Configure(self, count=None, timeout=1.0):
                  text = self.text
                  panel = eg.ConfigPanel()
                  if count is None:
                      count = 1
          Severity: Minor
          Found in plugins/Serial/__init__.py - About 35 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

          TODO found
          Open

          # TODO: Use of eg.SerialThread instead of eg.SerialPort
          Severity: Minor
          Found in plugins/Serial/__init__.py by fixme

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

              def ReceiveThread(self):
                  from win32event import (
                      ResetEvent,
                      MsgWaitForMultipleObjects,
                      QS_ALLINPUT,
          Severity: Major
          Found in plugins/Serial/__init__.py and 1 other location - About 2 days to fix
          plugins/HarmanKardon/__init__.py on lines 223..274

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

          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

                  try:
                      self.serial = eg.SerialPort(
                          port,
                          baudrate=baudrate,
                          bytesize=(5, 6, 7, 8)[bytesize],
          Severity: Major
          Found in plugins/Serial/__init__.py and 1 other location - About 2 hrs to fix
          plugins/HarmanKardon/__init__.py on lines 157..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 81.

          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

              def __stop__(self):
                  if self.serial is not None:
                      if self.receiveThread:
                          win32event.SetEvent(self.stopEvent)
                          self.receiveThread.join(1.0)
          Severity: Minor
          Found in plugins/Serial/__init__.py and 1 other location - About 40 mins to fix
          plugins/HarmanKardon/__init__.py on lines 182..188

          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