digidotcom/python-suitcase

View on GitHub

Showing 16 of 31 total issues

File fields.py has 1155 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# Copyright (c) 2019 Digi International Inc. All Rights Reserved.
Severity: Major
Found in suitcase/fields.py - About 2 days to fix

    Function unpack_stream has a Cognitive Complexity of 42 (exceeds 5 allowed). Consider refactoring.
    Open

        def unpack_stream(self, stream):
            # type: (BytesIO) -> None
            """Unpack bytes from a stream of data field-by-field
    
            In the most basic case, the basic algorithm here is as follows::
    Severity: Minor
    Found in suitcase/structure.py - About 6 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 _create_packet_generator has a Cognitive Complexity of 30 (exceeds 5 allowed). Consider refactoring.
    Open

        def _create_packet_generator(self):
            while True:
                curmsg = self.message_schema()
                for i, (_name, field) in enumerate(curmsg):
                    bytes_required = field.bytes_required
    Severity: Minor
    Found in suitcase/protocol.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 structure.py has 282 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    # This Source Code Form is subject to the terms of the Mozilla Public
    # License, v. 2.0. If a copy of the MPL was not distributed with this
    # file, You can obtain one at http://mozilla.org/MPL/2.0/.
    #
    # Copyright (c) 2019 Digi International Inc. All Rights Reserved.
    Severity: Minor
    Found in suitcase/structure.py - About 2 hrs to fix

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

          def write(self, stream):
              # type: (BytesIO) -> None
              # now, pack everything in
              crc_fields = []
              for name, field in self.ordered_fields:
      Severity: Minor
      Found in suitcase/structure.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 unpack has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

          def unpack(self, data, **kwargs):
              length = self.bytes_required
              if length == 0 or (data == b"" and length is None) or self.num_elements == 0:
                  # Array is empty.
                  return data
      Severity: Minor
      Found in suitcase/fields.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 __new__ has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Open

          def __new__(cls, name, bases, dct):
              #  find all the placeholders in this class declaration and store
              # them away.  Add name mangling to the original fields so they
              # do not get in the way.
              dct['_field_placeholders'] = {}
      Severity: Minor
      Found in suitcase/structure.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

      Avoid deeply nested control flow statements.
      Open

                              if idx == -1:  # no match in buffer
                                  # Since we know the entire magic_seq is not here, there can be at most
                                  # bytes_required - 1 bytes of the magic_seq available.  Thus we keep
                                  # that many bytes around in case it is the start of the magic field.
                                  self._available_bytes = self._available_bytes[-(bytes_required - 1):]
      Severity: Major
      Found in suitcase/protocol.py - About 45 mins to fix

        Avoid deeply nested control flow statements.
        Open

                                if len(self._available_bytes) < bytes_required:
                                    yield None
                                    continue
        
        
        Severity: Major
        Found in suitcase/protocol.py - About 45 mins to fix

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

              def __init__(self, field, algo, start, end, **kwargs):
          Severity: Minor
          Found in suitcase/fields.py - About 35 mins to fix

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

                def __init__(self, length_field, get_length=None, set_length=None, multiplier=1, **kwargs):
            Severity: Minor
            Found in suitcase/fields.py - About 35 mins to fix

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

                  def __init__(self, length_provider, dispatch_field,
              Severity: Minor
              Found in suitcase/fields.py - About 35 mins to fix

                Function pack has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                Open

                    def pack(self, stream):
                        try:
                            keep_bytes = getattr(self, 'KEEP_BYTES', None)
                            if keep_bytes is not None:
                                if self.PACK_FORMAT[0] == b">"[0]:  # The element access makes this compatible with Python 2 and 3
                Severity: Minor
                Found in suitcase/fields.py - About 25 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 a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                Open

                    def __init__(self, number_bits, field=None, **kwargs):
                        BaseField.__init__(self, **kwargs)
                        self._ordered_bitfields = []
                        self._bitfield_map = {}
                        if number_bits % 8 != 0:
                Severity: Minor
                Found in suitcase/fields.py - About 25 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 feed has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                Open

                    def feed(self, new_bytes):
                        """Feed a new set of bytes into the protocol handler
                
                        These bytes will be immediately fed into the parsing state machine and
                        if new packets are found, the ``packet_callback`` will be executed
                Severity: Minor
                Found in suitcase/protocol.py - About 25 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 unpack has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
                Open

                    def unpack(self, data, **kwargs):
                        value = 0
                        if self.UNPACK_FORMAT[0] == b">"[0]:  # The element access makes this compatible with Python 2 and 3
                            for i, byte in enumerate(reversed(struct.unpack(self.UNPACK_FORMAT, data))):
                                value |= (byte << (i * 8))
                Severity: Minor
                Found in suitcase/fields.py - About 25 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

                Severity
                Category
                Status
                Source
                Language