Sign upLogin

apel/apel

View on GitHub
Star
apel/db/loader/loader.py

Summary

Maintainability
B
6 hrs
Test Coverage

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

    def load_all_msgs(self):
        """
        Get all the messages from the incoming queue and attempt to put them
        into the database, then purge the accept, incoming, and reject queues.
        """
Severity: Minor
Found in apel/db/loader/loader.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 shutdown. (6)
Open

    def shutdown(self):
        """
        Unlock current messsage queue element and remove pidfile.
        """
        # Check if self.current_msg is assigned as it may not have been before
Severity: Minor
Found in apel/db/loader/loader.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 load_all_msgs has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
Open

    def load_all_msgs(self):
        """
        Get all the messages from the incoming queue and attempt to put them
        into the database, then purge the accept, incoming, and reject queues.
        """
Severity: Minor
Found in apel/db/loader/loader.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 __init__ has 9 arguments (exceeds 4 allowed). Consider refactoring.
Open

    def __init__(self, qpath, save_msgs, backend, host, port, db, user, pwd, pidfile):
Severity: Major
Found in apel/db/loader/loader.py - About 1 hr to fix

    Function shutdown has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

        def shutdown(self):
        """
        Unlock current messsage queue element and remove pidfile.
        """
        # Check if self.current_msg is assigned as it may not have been before
    Severity: Minor
    Found in apel/db/loader/loader.py - About 35 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

    Too many instance attributes (13/7)
    Open

    class Loader(object):
    Severity: Info
    Found in apel/db/loader/loader.py by pylint

    Used when class has too many instance attributes, try to reduce this to get a simpler (and so easier to use) class.

    Class 'Loader' inherits from object, can be safely removed from bases in python3
    Open

    class Loader(object):
    Severity: Info
    Found in apel/db/loader/loader.py by pylint

    Used when a class inherit from object, which under python3 is implicit, hence can be safely removed from bases.

    Too many arguments (10/5)
    Open

        def __init__(self, qpath, save_msgs, backend, host, port, db, user, pwd, pidfile):
    Severity: Info
    Found in apel/db/loader/loader.py by pylint

    Used when a function or method takes too many arguments.

    Method "__init__" has 10 parameters, which is greater than the 7 authorized.
    Open

        def __init__(self, qpath, save_msgs, backend, host, port, db, user, pwd, pidfile):
    Severity: Major
    Found in apel/db/loader/loader.py by sonar-python

    A long parameter list can indicate that a new structure should be created to wrap the numerous parameters or that the function is doing too many things.

    Noncompliant Code Example

    With a maximum number of 4 parameters:

    def do_something(param1, param2, param3, param4, param5):
    ...

    Compliant Solution

    def do_something(param1, param2, param3, param4):
    ...

    Attribute 'current_msg' defined outside __init__
    Open

            self.current_msg = self._inq.first()
    Severity: Minor
    Found in apel/db/loader/loader.py by pylint

    Used when an instance attribute is defined outside the init method.

    Unnecessary pass statement
    Open

        pass
    Severity: Minor
    Found in apel/db/loader/loader.py by pylint

    Used when a pass statement that can be avoided is encountered.

    Attribute 'current_msg' defined outside __init__
    Open

                self.current_msg = self._inq.next()
    Severity: Minor
    Found in apel/db/loader/loader.py by pylint

    Used when an instance attribute is defined outside the init method.

    Unable to import 'dirq.queue'
    Open

    from dirq.queue import Queue
    Severity: Critical
    Found in apel/db/loader/loader.py by pylint

    Used when pylint has been unable to import a module.

    Attribute 'current_msg' defined outside __init__
    Open

                    self.current_msg = self._inq.next()
    Severity: Minor
    Found in apel/db/loader/loader.py by pylint

    Used when an instance attribute is defined outside the init method.

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

            try:
            if os.path.exists(pidfile):
                os.remove(pidfile)
            else:
                log.warning("pidfile %s not found.", pidfile)
    Severity: Major
    Found in apel/db/loader/loader.py and 1 other location - About 2 hrs to fix
    bin/summariser.py on lines 138..146

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

    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 (86 > 79 characters)
    Open

        def __init__(self, qpath, save_msgs, backend, host, port, db, user, pwd, pidfile):
    Severity: Minor
    Found in apel/db/loader/loader.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.

    Missing whitespace after ':'
    Open

    REJECT_SCHEMA = {"body": "string", "signer":"string?", "empaid":"string?", "error": "string"}
    Severity: Minor
    Found in apel/db/loader/loader.py by pep8

    Each comma, semicolon or colon should be followed by whitespace.

    Okay: [a, b]
Okay: (3,)
Okay: a[1:4]
Okay: a[:4]
Okay: a[1:]
Okay: a[1:4:2]
E231: ['a','b']
E231: foo(bar,baz)
E231: [{'a':'b'}]

    Missing whitespace after ':'
    Open

    REJECT_SCHEMA = {"body": "string", "signer":"string?", "empaid":"string?", "error": "string"}
    Severity: Minor
    Found in apel/db/loader/loader.py by pep8

    Each comma, semicolon or colon should be followed by whitespace.

    Okay: [a, b]
Okay: (3,)
Okay: a[1:4]
Okay: a[:4]
Okay: a[1:]
Okay: a[1:4:2]
E231: ['a','b']
E231: foo(bar,baz)
E231: [{'a':'b'}]

    Line too long (81 > 79 characters)
    Open

                    log.warning('OSError raised while purging message queues: %s', e)
    Severity: Minor
    Found in apel/db/loader/loader.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.

    Missing whitespace after ':'
    Open

    QSCHEMA = {"body": "string", "signer":"string", "empaid":"string?", "error": "string?"}
    Severity: Minor
    Found in apel/db/loader/loader.py by pep8

    Each comma, semicolon or colon should be followed by whitespace.

    Okay: [a, b]
Okay: (3,)
Okay: a[1:4]
Okay: a[:4]
Okay: a[1:]
Okay: a[1:4:2]
E231: ['a','b']
E231: foo(bar,baz)
E231: [{'a':'b'}]

    Continuation line under-indented for visual indent
    Open

                                        self._db_username, self._db_pwd,
    Severity: Minor
    Found in apel/db/loader/loader.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)

    Continuation line under-indented for visual indent
    Open

                                        self._db_name)
    Severity: Minor
    Found in apel/db/loader/loader.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)

    Line too long (88 > 79 characters)
    Open

                log.warning("Check that the dbloader is not running, then remove the file.")
    Severity: Minor
    Found in apel/db/loader/loader.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.

    Line too long (93 > 79 characters)
    Open

    REJECT_SCHEMA = {"body": "string", "signer":"string?", "empaid":"string?", "error": "string"}
    Severity: Minor
    Found in apel/db/loader/loader.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.

    Line too long (81 > 79 characters)
    Open

                    log.info("Loading message %s. ID = %s", self.current_msg, msg_id)
    Severity: Minor
    Found in apel/db/loader/loader.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.

    Missing whitespace after ':'
    Open

    QSCHEMA = {"body": "string", "signer":"string", "empaid":"string?", "error": "string?"}
    Severity: Minor
    Found in apel/db/loader/loader.py by pep8

    Each comma, semicolon or colon should be followed by whitespace.

    Okay: [a, b]
Okay: (3,)
Okay: a[1:4]
Okay: a[:4]
Okay: a[1:]
Okay: a[1:4:2]
E231: ['a','b']
E231: foo(bar,baz)
E231: [{'a':'b'}]

    Line too long (84 > 79 characters)
    Open

                raise LoaderException("The dbloader cannot start while pidfile exists.")
    Severity: Minor
    Found in apel/db/loader/loader.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.

    Line too long (87 > 79 characters)
    Open

    QSCHEMA = {"body": "string", "signer":"string", "empaid":"string?", "error": "string?"}
    Severity: Minor
    Found in apel/db/loader/loader.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.

    Wrong hanging indentation (remove 8 spaces).
    Open

                        apel.db.records.cloud_summary.CloudSummaryRecord:
    Severity: Info
    Found in apel/db/loader/loader.py by pylint

    TODO apel.db.records.cloud_summary.CloudSummaryRecord: | ^

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

            except IOError as e:
    Severity: Info
    Found in apel/db/loader/loader.py by pylint

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

    Wrong hanging indentation (remove 8 spaces).
    Open

                        apel.db.records.sync.SyncRecord: 'Sync',
    Severity: Info
    Found in apel/db/loader/loader.py by pylint

    TODO apel.db.records.sync.SyncRecord: 'Sync', | ^

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

                except OSError as e:
    Severity: Info
    Found in apel/db/loader/loader.py by pylint

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

    Wrong hanging indentation in dict value.
    Open

                        'Cloud Summary'}
    Severity: Info
    Found in apel/db/loader/loader.py by pylint

    TODO 'Cloud Summary'} | | ^

    Wrong hanging indentation (remove 8 spaces).
    Open

                        apel.db.records.summary.SummaryRecord: 'Summary',
    Severity: Info
    Found in apel/db/loader/loader.py by pylint

    TODO apel.db.records.summary.SummaryRecord: 'Summary', | ^

    Wrong hanging indentation in dict value.
    Open

                        'Normalised Summary',
    Severity: Info
    Found in apel/db/loader/loader.py by pylint

    TODO 'Normalised Summary', | | ^

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

                f = open(self._pidfile, "w")
    Severity: Info
    Found in apel/db/loader/loader.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('loader')
    Severity: Info
    Found in apel/db/loader/loader.py by pylint

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

    Wrong hanging indentation (remove 8 spaces).
    Open

                        apel.db.records.normalised_summary.NormalisedSummaryRecord:
    Severity: Info
    Found in apel/db/loader/loader.py by pylint

    TODO apel.db.records.normalised_summary.NormalisedSummaryRecord: | ^

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

            except IOError as e:
    Severity: Info
    Found in apel/db/loader/loader.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 OSError as e:
    Severity: Info
    Found in apel/db/loader/loader.py by pylint

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

    Wrong hanging indentation (remove 8 spaces).
    Open

                        apel.db.records.job.JobRecord: 'Job',
    Severity: Info
    Found in apel/db/loader/loader.py by pylint

    TODO apel.db.records.job.JobRecord: 'Job', | ^

    Wrong hanging indentation (remove 8 spaces).
    Open

                        apel.db.records.cloud.CloudRecord: 'Cloud',
    Severity: Info
    Found in apel/db/loader/loader.py by pylint

    TODO apel.db.records.cloud.CloudRecord: 'Cloud', | ^

    Wrong continued indentation (add 2 spaces).
    Open

                                        self._db_name)
    Severity: Info
    Found in apel/db/loader/loader.py by pylint

    TODO self.dbname) ^ |

    Wrong continued indentation (add 2 spaces).
    Open

                                        self._db_username, self._db_pwd,
    Severity: Info
    Found in apel/db/loader/loader.py by pylint

    TODO self.dbusername, self.dbpwd, ^ |

    There are no issues that match your filters.

    Category
    Status