LiberTEM/LiberTEM

View on GitHub
src/libertem/io/dataset/cached.py

Summary

Maintainability
B
4 hrs
Test Coverage

File cached.py has 454 lines of code (exceeds 400 allowed). Consider refactoring.
Open

import os
import json
import hashlib
import sqlite3
import time
Severity: Minor
Found in src/libertem/io/dataset/cached.py - About 3 hrs to fix

    Cyclomatic complexity is too high in method get_victim_list. (6)
    Open

        def get_victim_list(self, cache_key: str, size: int, stats: CacheStats):
            """
            Return a list of `CacheItem`s that should be deleted to make
            place for `partition`.
            """
    Severity: Minor
    Found in src/libertem/io/dataset/cached.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 __init__ has 10 arguments (exceeds 8 allowed). Consider refactoring.
    Open

        def __init__(self, source_part, cluster_part, meta, partition_slice,
    Severity: Major
    Found in src/libertem/io/dataset/cached.py - About 45 mins to fix

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

          def __init__(self, source_part, cluster_part, meta, partition_slice,
                       cache_key, cache_strategy, db_path, idx, io_backend, decoder):

      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):
          ...
      

      Either remove or fill this block of code.
      Open

                  pass

      Most of the time a block of code is empty when a piece of code is really missing. So such empty block must be either filled or removed.

      Noncompliant Code Example

      for i in range(3):
          pass
      

      Exceptions

      When a block contains a comment, this block is not considered to be empty.

      Either remove or fill this block of code.
      Open

                      pass

      Most of the time a block of code is empty when a piece of code is really missing. So such empty block must be either filled or removed.

      Noncompliant Code Example

      for i in range(3):
          pass
      

      Exceptions

      When a block contains a comment, this block is not considered to be empty.

      Take the required action to fix the issue indicated by this "FIXME" comment.
      Open

                  )  # FIXME: exception class

      FIXME tags are commonly used to mark places where a bug is suspected, but which the developer wants to deal with later.

      Sometimes the developer will not have the time or will simply forget to get back to that tag.

      This rule is meant to track those tags and to ensure that they do not go unnoticed.

      Noncompliant Code Example

      def divide(numerator, denominator):
        return numerator / denominator              # FIXME denominator value might be 0
      

      See

      There are no issues that match your filters.

      Category
      Status