Sign upLogin

vpoulailleau/pydxl

View on GitHub
Star

Showing 13 of 13 total issues

Cyclomatic complexity is too high in method read. (10)
Open

    def read(self):
        """Read a packet with the port handler."""
        # TODO check error code in packet.error
        data = []
        length_to_read = 6  # minimum packet size
Severity: Minor
Found in pydxl/protocol1.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 read has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
Open

    def read(self):
        """Read a packet with the port handler."""
        # TODO check error code in packet.error
        data = []
        length_to_read = 6  # minimum packet size
Severity: Minor
Found in pydxl/protocol1.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 write_bytes has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def write_bytes(self, identifier, address, data, size):
Severity: Minor
Found in pydxl/protocol1.py - About 35 mins to fix

    Whitespace before ':'
    Open

            for word in self.data[2 : self.total_length - 1]:
    Severity: Minor
    Found in pydxl/packet.py by pep8

    Avoid extraneous whitespace.

    Avoid extraneous whitespace in these situations:
- Immediately inside parentheses, brackets or braces.
- Immediately before a comma, semicolon, or colon.

Okay: spam(ham[1], {eggs: 2})
E201: spam( ham[1], {eggs: 2})
E201: spam(ham[ 1], {eggs: 2})
E201: spam(ham[1], { eggs: 2})
E202: spam(ham[1], {eggs: 2} )
E202: spam(ham[1 ], {eggs: 2})
E202: spam(ham[1], {eggs: 2 })

E203: if x == 4: print x, y; x, y = y , x
E203: if x == 4: print x, y ; x, y = y, x
E203: if x == 4 : print x, y; x, y = y, x

    Whitespace before ':'
    Open

            return self.data[6 : self.total_length - 1]
    Severity: Minor
    Found in pydxl/packet.py by pep8

    Avoid extraneous whitespace.

    Avoid extraneous whitespace in these situations:
- Immediately inside parentheses, brackets or braces.
- Immediately before a comma, semicolon, or colon.

Okay: spam(ham[1], {eggs: 2})
E201: spam( ham[1], {eggs: 2})
E201: spam(ham[ 1], {eggs: 2})
E201: spam(ham[1], { eggs: 2})
E202: spam(ham[1], {eggs: 2} )
E202: spam(ham[1 ], {eggs: 2})
E202: spam(ham[1], {eggs: 2 })

E203: if x == 4: print x, y; x, y = y , x
E203: if x == 4: print x, y ; x, y = y, x
E203: if x == 4 : print x, y; x, y = y, x

    Line too long (85 > 79 characters)
    Open

        description="Python package to use Dynamixel servos through a serial interface.",
    Severity: Minor
    Found in setup.py by pep8

    Limit all lines to a maximum of 79 characters.

    There are still many devices around that are limited to 80 character
lines; plus, limiting windows to 80 characters makes it possible to
have several windows side-by-side.  The default wrapping on such
devices looks ugly.  Therefore, please limit all lines to a maximum
of 79 characters. For flowing long blocks of text (docstrings or
comments), limiting the length to 72 characters is recommended.

Reports error E501.

    TODO found
    Open

    * TODO: implement protocol 2.0
    Severity: Minor
    Found in README.rst by fixme

    TODO found
    Open

            # TODO check error code in packet.error
    Severity: Minor
    Found in pydxl/protocol1.py by fixme

    Merge this if statement with the enclosing one.
    Open

                if not packet._check_checksum():
    Severity: Major
    Found in pydxl/packet.py by sonar-python

    Merging collapsible if statements increases the code's readability.

    Noncompliant Code Example

    if condition1:
    if condition2:
        # ...

    Compliant Solution

    if condition1 and condition2:
    # ...

    TODO found
    Open

        $ flake8 pydxl tests (TODO use whatalinter from python-dev-tools)
    Severity: Minor
    Found in CONTRIBUTING.rst by fixme

    TODO found
    Open

    # TODO from dynamixel.protocol2 import PacketHandler as PacketHandler2
    Severity: Minor
    Found in pydxl/seriallink.py by fixme

    TODO found
    Open

    * TODO: add more servo types
    Severity: Minor
    Found in README.rst by fixme

    TODO found
    Open

    # TODO
    Severity: Minor
    Found in pydxl/protocol1.py by fixme
    Severity
    Category
    Status
    Source
    Language