aburrell/apexpy

View on GitHub
apexpy/apex.py

Summary

Maintainability
F
6 days
Test Coverage

File apex.py has 997 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
"""Classes that make up the core of apexpy."""

import datetime as dt
import numpy as np
Severity: Major
Found in apexpy/apex.py - About 2 days to fix

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

        def convert(self, lat, lon, source, dest, height=0, datetime=None,
                    precision=1e-10, ssheight=50 * 6371):
            """Converts between geodetic, modified apex, quasi-dipole and MLT.
    
            Parameters
    Severity: Minor
    Found in apexpy/apex.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

    Cyclomatic complexity is too high in method convert. (19)
    Open

        def convert(self, lat, lon, source, dest, height=0, datetime=None,
                    precision=1e-10, ssheight=50 * 6371):
            """Converts between geodetic, modified apex, quasi-dipole and MLT.
    
            Parameters
    Severity: Minor
    Found in apexpy/apex.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 __eq__ has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
    Open

        def __eq__(self, comp_obj):
            """Performs equivalency evaluation.
    
            Parameters
            ----------
    Severity: Minor
    Found in apexpy/apex.py - About 3 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

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

    class Apex(object):
        """Calculates coordinate conversions, field-line mapping, and base vectors.
    
        Parameters
        ----------
    Severity: Minor
    Found in apexpy/apex.py - About 3 hrs to fix

      Cyclomatic complexity is too high in method _map_EV_to_height. (11)
      Open

          def _map_EV_to_height(self, alat, alon, height, newheight, data, ev_flag):
              """Maps electric field related values to a desired height
      
              Parameters
              ----------
      Severity: Minor
      Found in apexpy/apex.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

      Cyclomatic complexity is too high in method __init__. (8)
      Open

          def __init__(self, date=None, refh=0, datafile=None, fortranlib=None):
      
              if datafile is None:
                  datafile = os.path.join(os.path.dirname(__file__), 'apexsh.dat')
      
      
      Severity: Minor
      Found in apexpy/apex.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

      Cyclomatic complexity is too high in method basevectors_apex. (8)
      Open

          def basevectors_apex(self, lat, lon, height, coords='geo', precision=1e-10):
              """Returns base vectors in quasi-dipole and apex coordinates.
      
              Parameters
              ----------
      Severity: Minor
      Found in apexpy/apex.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

      Cyclomatic complexity is too high in method __eq__. (8)
      Open

          def __eq__(self, comp_obj):
              """Performs equivalency evaluation.
      
              Parameters
              ----------
      Severity: Minor
      Found in apexpy/apex.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 _map_EV_to_height has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

          def _map_EV_to_height(self, alat, alon, height, newheight, data, ev_flag):
              """Maps electric field related values to a desired height
      
              Parameters
              ----------
      Severity: Minor
      Found in apexpy/apex.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 basevectors_apex has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

          def basevectors_apex(self, lat, lon, height, coords='geo', precision=1e-10):
              """Returns base vectors in quasi-dipole and apex coordinates.
      
              Parameters
              ----------
      Severity: Minor
      Found in apexpy/apex.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 convert has 8 arguments (exceeds 4 allowed). Consider refactoring.
      Open

          def convert(self, lat, lon, source, dest, height=0, datetime=None,
      Severity: Major
      Found in apexpy/apex.py - About 1 hr to fix

        Function __init__ has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

            def __init__(self, date=None, refh=0, datafile=None, fortranlib=None):
        
                if datafile is None:
                    datafile = os.path.join(os.path.dirname(__file__), 'apexsh.dat')
        
        
        Severity: Minor
        Found in apexpy/apex.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

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

            def map_to_height(self, glat, glon, height, newheight, conjugate=False,
        Severity: Minor
        Found in apexpy/apex.py - About 45 mins to fix

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

              def _map_EV_to_height(self, alat, alon, height, newheight, data, ev_flag):
          Severity: Minor
          Found in apexpy/apex.py - About 45 mins to fix

            Avoid deeply nested control flow statements.
            Open

                                    if cval != aval:
                                        # Not equal, as the attribute values differ
                                        bad_attr = True
                                else:
            Severity: Major
            Found in apexpy/apex.py - About 45 mins to fix

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

                  def basevectors_qd(self, lat, lon, height, coords='geo', precision=1e-10):
              Severity: Minor
              Found in apexpy/apex.py - About 35 mins to fix

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

                    def basevectors_apex(self, lat, lon, height, coords='geo', precision=1e-10):
                Severity: Minor
                Found in apexpy/apex.py - About 35 mins to fix

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

                      def map_V_to_height(self, alat, alon, height, newheight, vdata):
                  Severity: Minor
                  Found in apexpy/apex.py - About 35 mins to fix

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

                        def bvectors_apex(self, lat, lon, height, coords='geo', precision=1e-10):
                    Severity: Minor
                    Found in apexpy/apex.py - About 35 mins to fix

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

                          def map_E_to_height(self, alat, alon, height, newheight, edata):
                      Severity: Minor
                      Found in apexpy/apex.py - About 35 mins to fix

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

                            def qd2apex(self, qlat, qlon, height):
                                """Converts quasi-dipole to modified apex coordinates.
                        
                                Parameters
                                ----------
                        Severity: Major
                        Found in apexpy/apex.py and 1 other location - About 1 hr to fix
                        apexpy/apex.py on lines 674..704

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

                        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

                            def apex2qd(self, alat, alon, height):
                                """Converts modified apex to quasi-dipole coordinates.
                        
                                Parameters
                                ----------
                        Severity: Major
                        Found in apexpy/apex.py and 1 other location - About 1 hr to fix
                        apexpy/apex.py on lines 706..735

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

                        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

                                    v2[-1] = np.reshape(v2[-1], (3, v2[-1].size // 3))
                        Severity: Major
                        Found in apexpy/apex.py and 1 other location - About 1 hr to fix
                        apexpy/apex.py on lines 379..379

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

                        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

                                    v1[-1] = np.reshape(v1[-1], (3, v1[-1].size // 3))
                        Severity: Major
                        Found in apexpy/apex.py and 1 other location - About 1 hr to fix
                        apexpy/apex.py on lines 380..380

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

                        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

                            def map_E_to_height(self, alat, alon, height, newheight, edata):
                                """Performs mapping of electric field along the magnetic field.
                        
                                It is assumed that the electric field is perpendicular to B.
                        
                        
                        Severity: Minor
                        Found in apexpy/apex.py and 1 other location - About 35 mins to fix
                        apexpy/apex.py on lines 908..937

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

                        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

                            def map_V_to_height(self, alat, alon, height, newheight, vdata):
                                """Performs mapping of electric drift velocity along the magnetic field.
                        
                                It is assumed that the electric field is perpendicular to B.
                        
                        
                        Severity: Minor
                        Found in apexpy/apex.py and 1 other location - About 35 mins to fix
                        apexpy/apex.py on lines 877..906

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

                        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