apel/db/loader/star_parser.py

Summary

Maintainability
A
2 hrs
Test Coverage

Cyclomatic complexity is too high in method parseStarRecord. (9)
Open

    def parseStarRecord(self, xml_storage_record):
        """
        Parses single entry for Storage Accounting Record.

        Uses a dictionary containing fields from the storage record and methods
Severity: Minor
Found in apel/db/loader/star_parser.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 parseStarRecord has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

    def parseStarRecord(self, xml_storage_record):
        """
        Parses single entry for Storage Accounting Record.

        Uses a dictionary containing fields from the storage record and methods
Severity: Minor
Found in apel/db/loader/star_parser.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

Unnecessary use of a comprehension
Open

                                'RecordIdentity' or f for f in [S for S in functions]])
Severity: Info
Found in apel/db/loader/star_parser.py by pylint

Instead of using an identitiy comprehension, consider using the list, dict or set constructor. It is faster and simpler.

Remove this commented out code.
Open

        # nodes = {}.fromkeys(functions.keys())
Severity: Major
Found in apel/db/loader/star_parser.py by sonar-python

Programmers should not comment out code as it bloats programs and reduces readability.

Unused code should be deleted and can be retrieved from source control history if required.

See

  • MISRA C:2004, 2.4 - Sections of code should not be "commented out".
  • MISRA C++:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
  • MISRA C++:2008, 2-7-3 - Sections of code should not be "commented out" using C++ comments.
  • MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"

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

            'Role': lambda nodes: self.getText(self.getTagByAttr(
                nodes['Role'], 'attributeType', 'role')[0].childNodes),
Severity: Major
Found in apel/db/loader/star_parser.py and 4 other locations - About 45 mins to fix
apel/db/loader/car_parser.py on lines 115..117
apel/db/loader/car_parser.py on lines 119..121
apel/db/loader/car_parser.py on lines 122..124
apel/db/loader/star_parser.py on lines 103..104

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

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

            'SubGroup': lambda nodes: self.getText(self.getTagByAttr(
                nodes['SubGroup'], 'attributeType', 'subgroup')[0].childNodes),
Severity: Major
Found in apel/db/loader/star_parser.py and 4 other locations - About 45 mins to fix
apel/db/loader/car_parser.py on lines 115..117
apel/db/loader/car_parser.py on lines 119..121
apel/db/loader/car_parser.py on lines 122..124
apel/db/loader/star_parser.py on lines 105..106

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

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

Line too long (87 > 79 characters)
Open

                                'RecordIdentity' or f for f in [S for S in functions]])
Severity: Minor
Found in apel/db/loader/star_parser.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.

Continuation line over-indented for visual indent
Open

                                'RecordIdentity' or f for f in [S for S in functions]])
Severity: Minor
Found in apel/db/loader/star_parser.py by pep8

Continuation lines indentation.

Continuation lines should align wrapped elements either vertically
using Python's implicit line joining inside parentheses, brackets
and braces, or using a hanging indent.

When using a hanging indent these considerations should be applied:
- there should be no arguments on the first line, and
- further indentation should be used to clearly distinguish itself
  as a continuation line.

Okay: a = (\n)
E123: a = (\n    )

Okay: a = (\n    42)
E121: a = (\n   42)
E122: a = (\n42)
E123: a = (\n    42\n    )
E124: a = (24,\n     42\n)
E125: if (\n    b):\n    pass
E126: a = (\n        42)
E127: a = (24,\n      42)
E128: a = (24,\n    42)
E129: if (a or\n    b):\n    pass
E131: a = (\n    42\n 24)

Variable name sr doesn't conform to snake_case naming style
Open

        sr = StorageRecord()
Severity: Info
Found in apel/db/loader/star_parser.py by pylint

Used when the name doesn't conform to naming rules associated to its type (constant, variable, class...).

Constant name log doesn't conform to UPPER_CASE naming style
Open

log = logging.getLogger(__name__)
Severity: Info
Found in apel/db/loader/star_parser.py by pylint

Used when the name doesn't conform to naming rules associated to its type (constant, variable, class...).

Wrong continued indentation (remove 3 spaces).
Open

                                'RecordIdentity' or f for f in [S for S in functions]])
Severity: Info
Found in apel/db/loader/star_parser.py by pylint

TODO 'RecordIdentity' or f for f in [S for S in functions]]) | ^

Method name parseStarRecord doesn't conform to snake_case naming style
Open

    def parseStarRecord(self, xml_storage_record):
Severity: Info
Found in apel/db/loader/star_parser.py by pylint

Used when the name doesn't conform to naming rules associated to its type (constant, variable, class...).

Method name parseGroupAttributes doesn't conform to snake_case naming style
Open

    def parseGroupAttributes(self, nodes, star_record_id):
Severity: Info
Found in apel/db/loader/star_parser.py by pylint

Used when the name doesn't conform to naming rules associated to its type (constant, variable, class...).

Variable name e doesn't conform to snake_case naming style
Open

            except (IndexError, KeyError) as e:
Severity: Info
Found in apel/db/loader/star_parser.py by pylint

Used when the name doesn't conform to naming rules associated to its type (constant, variable, class...).

There are no issues that match your filters.

Category
Status