Sign upLogin

schwehr/libais

View on GitHub
Star
ais/stream/__init__.py

Summary

Maintainability
D
2 days
Test Coverage

Function normalize has a Cognitive Complexity of 84 (exceeds 5 allowed). Consider refactoring.
Open

def normalize(nmea=sys.stdin,
              uscg=True,
              validate_checksum=True,
              allow_unknown=False,
              window=2,
Severity: Minor
Found in ais/stream/__init__.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 __init__.py has 263 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# Based on ais_normalize.py from https://github.com/schwehr/noaadata

import sys
import traceback
import warnings
Severity: Minor
Found in ais/stream/__init__.py - About 2 hrs to fix

    Function parseTagBlock has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

    def parseTagBlock(line):
  if not line.startswith("\\"):
    return {}, line
  tagblock, line = line[1:].split("\\", 1)
  tagblock, checksum = tagblock.rsplit("*", 1)
    Severity: Minor
    Found in ais/stream/__init__.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 normalize has 12 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def normalize(nmea=sys.stdin,
    Severity: Major
    Found in ais/stream/__init__.py - About 1 hr to fix

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

      def ErrorPrinter(e,
      Severity: Minor
      Found in ais/stream/__init__.py - About 45 mins to fix

        Function decode has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

        def decode(nmea=sys.stdin,
           errorcb=ErrorPrinter,
           keep_nmea=False,
           stats=None,
           **kw):
        Severity: Minor
        Found in ais/stream/__init__.py - About 45 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 decode has 5 arguments (exceeds 4 allowed). Consider refactoring.
        Open

        def decode(nmea=sys.stdin,
        Severity: Minor
        Found in ais/stream/__init__.py - About 35 mins to fix

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

                      report_error(DifferingTimestampsError(line_num=stats["line_num"],
                                                  line=line.strip(),
          Severity: Minor
          Found in ais/stream/__init__.py and 1 other location - About 30 mins to fix
          ais/stream/__init__.py on lines 272..273

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

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

                          report_error(MissingTimestampsError(line_num=stats["line_num"],
                                                    line=line.strip(),
          Severity: Minor
          Found in ais/stream/__init__.py and 1 other location - About 30 mins to fix
          ais/stream/__init__.py on lines 278..279

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

          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