Sign upLogin

bparzella/secsgem

View on GitHub
Star

Showing 83 of 83 total issues

Function _on_s02f35 has a Cognitive Complexity of 36 (exceeds 5 allowed). Consider refactoring.
Open

    def _on_s02f35(self,  # noqa: C901, pylint: disable=too-many-branches
                   handler: secsgem.secs.SecsHandler,
                   message: secsgem.common.Message) -> secsgem.secs.SecsStreamFunction | None:
        """Handle Stream 2, Function 35, Link event report.
Severity: Minor
Found in secsgem/gem/collection_event_capability.py - About 5 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 _on_s02f33 has a Cognitive Complexity of 33 (exceeds 5 allowed). Consider refactoring.
Open

    def _on_s02f33(self,  # noqa: C901, pylint: disable=too-many-branches
                   handler: secsgem.secs.SecsHandler,
                   message: secsgem.common.Message) -> secsgem.secs.SecsStreamFunction | None:
        """Handle Stream 2, Function 33, Define Report.
Severity: Minor
Found in secsgem/gem/collection_event_capability.py - About 4 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

File protocol.py has 362 lines of code (exceeds 250 allowed). Consider refactoring.
Open

#####################################################################
# protocol.py
#
# (c) Copyright 2013-2023, Benjamin Parzella. All rights reserved.
#
Severity: Minor
Found in secsgem/hsms/protocol.py - About 4 hrs to fix

    HsmsProtocol has 31 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class HsmsProtocol(secsgem.common.Protocol[HsmsMessage, HsmsBlock]):  # pylint: disable=too-many-instance-attributes
    """Baseclass for creating Host/Equipment models.

    This layer contains the HSMS functionality.
    Inherit from this class and override required functions.
    Severity: Minor
    Found in secsgem/hsms/protocol.py - About 3 hrs to fix

      SecsHandler has 28 functions (exceeds 20 allowed). Consider refactoring.
      Open

      class SecsHandler:  # pylint: disable=too-many-instance-attributes,too-many-public-methods
    """Baseclass for creating Host/Equipment models. This layer contains the SECS functionality.

    Inherit from this class and override required functions.
    """
      Severity: Minor
      Found in secsgem/secs/handler.py - About 3 hrs to fix

        Function has 27 functions (exceeds 20 allowed). Consider refactoring.
        Open

        class Function:  # pylint: disable=too-many-instance-attributes
    """Function configuration from yaml."""

    sf_regex = re.compile(r"[sS](\d+)[fF](\d+)")
        Severity: Minor
        Found in data/function.py - About 3 hrs to fix

          Protocol has 26 functions (exceeds 20 allowed). Consider refactoring.
          Open

          class Protocol(abc.ABC, typing.Generic[MessageT, BlockT]):  # pylint: disable=too-many-instance-attributes
    """Abstract base class for a protocol."""

    message_type: type[MessageT]
          Severity: Minor
          Found in secsgem/common/protocol.py - About 3 hrs to fix

            Function _on_s02f29 has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
            Open

                def _on_s02f29(self,
                   handler: secsgem.secs.SecsHandler,
                   message: secsgem.common.Message) -> secsgem.secs.SecsStreamFunction | None:
        """Handle Stream 2, Function 29, EC namelist request.
            Severity: Minor
            Found in secsgem/gem/equipment_constants_capability.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

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

            #####################################################################
# __init__.py
#
# (c) Copyright 2013-2023, Benjamin Parzella. All rights reserved.
#
            Severity: Minor
            Found in secsgem/secs/functions/__init__.py - About 2 hrs to fix

              File _all.py has 271 lines of code (exceeds 250 allowed). Consider refactoring.
              Open

              #####################################################################
# _all.py
#
# (c) Copyright 2023, Benjamin Parzella. All rights reserved.
#
              Severity: Minor
              Found in secsgem/secs/functions/_all.py - About 2 hrs to fix

                Cyclomatic complexity is too high in method _on_s02f33. (15)
                Open

                    def _on_s02f33(self,  # noqa: C901, pylint: disable=too-many-branches
                   handler: secsgem.secs.SecsHandler,
                   message: secsgem.common.Message) -> secsgem.secs.SecsStreamFunction | None:
        """Handle Stream 2, Function 33, Define Report.
                Severity: Minor
                Found in secsgem/gem/collection_event_capability.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

                File function.py has 266 lines of code (exceeds 250 allowed). Consider refactoring.
                Open

                """Function class definition."""
import collections
import re
import typing
                Severity: Minor
                Found in data/function.py - About 2 hrs to fix

                  Cyclomatic complexity is too high in method _on_s02f35. (13)
                  Open

                      def _on_s02f35(self,  # noqa: C901, pylint: disable=too-many-branches
                   handler: secsgem.secs.SecsHandler,
                   message: secsgem.common.Message) -> secsgem.secs.SecsStreamFunction | None:
        """Handle Stream 2, Function 35, Link event report.
                  Severity: Minor
                  Found in secsgem/gem/collection_event_capability.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

                  DataItem has 21 functions (exceeds 20 allowed). Consider refactoring.
                  Open

                  class DataItem:
    """Data item configuration from yaml."""

    def __init__(self, name, data) -> None:
        """Initialize item config."""
                  Severity: Minor
                  Found in data/data_item.py - About 2 hrs to fix

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

                        def get_format(data_format, showname=False):
        """Get the format of the variable.

        :returns: returns the string representation of the function
        :rtype: string
                    Severity: Minor
                    Found in secsgem/secs/variables/list_type.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

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

                    #####################################################################
# __init__.py
#
# (c) Copyright 2013-2023, Benjamin Parzella. All rights reserved.
#
                    Severity: Minor
                    Found in secsgem/secs/data_items/__init__.py - About 2 hrs to fix

                      Function __receiver_thread_read_data has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
                      Open

                          def __receiver_thread_read_data(self):
        # check if shutdown requested
        while not self._stop_thread:
            # check if data available
            select_result = select.select([self._socket], [], [self._socket], self.select_timeout)
                      Severity: Minor
                      Found in secsgem/common/tcp_connection.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 _on_s02f15 has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
                      Open

                          def _on_s02f15(self,
                   handler: secsgem.secs.SecsHandler,
                   message: secsgem.common.Message) -> secsgem.secs.SecsStreamFunction | None:
        """Handle Stream 2, Function 15, Equipment constant send.
                      Severity: Minor
                      Found in secsgem/gem/equipment_constants_capability.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 __repr__ has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
                      Open

                          def __repr__(self):
        """Generate textual representation for an object of this class."""
        if len(self.value) == 0:
            return f"<{self.text_code}>"
                      Severity: Minor
                      Found in secsgem/secs/variables/base_text.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 has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
                      Open

                          def set(self, value):
        """Set the internal value to the provided value.

        :param value: new value
        :type value: list/boolean
                      Severity: Minor
                      Found in secsgem/secs/variables/boolean.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

                      Severity
                      Category
                      Status
                      Source
                      Language