gwsumm/__main__.py

Summary

Maintainability
F
4 days
Test Coverage

Function main has a Cognitive Complexity of 96 (exceeds 5 allowed). Consider refactoring.
Open

def main(args=None):
    """Run the GWSumm command-line interface
    """
    parser = create_parser()
    args = parser.parse_args(args=args)
Severity: Minor
Found in gwsumm/__main__.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 __main__.py has 692 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# coding=utf-8
# Copyright (C) Duncan Macleod (2013)
#
# This file is part of GWSumm.
#
Severity: Major
Found in gwsumm/__main__.py - About 1 day to fix

    Cyclomatic complexity is too high in function main. (68)
    Open

    def main(args=None):
        """Run the GWSumm command-line interface
        """
        parser = create_parser()
        args = parser.parse_args(args=args)
    Severity: Minor
    Found in gwsumm/__main__.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 main has 56 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    def main(args=None):
        """Run the GWSumm command-line interface
        """
        parser = create_parser()
        args = parser.parse_args(args=args)
    Severity: Major
    Found in gwsumm/__main__.py - About 2 hrs to fix

      Function create_parser has 43 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      def create_parser():
          """Create a command-line parser for this entry point
          """
          # initialize top-level argument parser
          parser = GWArgumentParser(
      Severity: Minor
      Found in gwsumm/__main__.py - About 1 hr to fix

        Avoid deeply nested control flow statements.
        Open

                            if plot.type in ['timeseries', 'spectrogram', 'spectrum',
                                             'histogram']:
                                allts.update(plot.channels)
                            elif plot.type in ['statevector']:
                                allsv.update(plot.channels)
        Severity: Major
        Found in gwsumm/__main__.py - About 45 mins to fix

          Avoid deeply nested control flow statements.
          Open

                              if plot.state is not None:
                                  continue
                              if plot.type in ['timeseries', 'spectrogram', 'spectrum',
          Severity: Major
          Found in gwsumm/__main__.py - About 45 mins to fix

            XXX found
            Open

            # XXX HACK XXX
            Severity: Minor
            Found in gwsumm/__main__.py by fixme

            XXX found
            Open

            # XXX HACK XXX
            Severity: Minor
            Found in gwsumm/__main__.py by fixme

            XXX found
            Open

                # XXX: bulk data reading could optimise things
            Severity: Minor
            Found in gwsumm/__main__.py by fixme

            XXX found
            Open

                # XXX: but has never been used, so should remove (DMM 18/01/16)
            Severity: Minor
            Found in gwsumm/__main__.py by fixme

            There are no issues that match your filters.

            Category
            Status