emory-libraries/eulfedora

View on GitHub
eulfedora/server.py

Summary

Maintainability
D
2 days
Test Coverage

File server.py has 343 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# file eulfedora/server.py
#
#   Copyright 2010,2011 Emory University Libraries
#
#   Licensed under the Apache License, Version 2.0 (the "License");
Severity: Minor
Found in eulfedora/server.py - About 4 hrs to fix

    Function find_objects has a Cognitive Complexity of 27 (exceeds 5 allowed). Consider refactoring.
    Open

        def find_objects(self, terms=None, type=None, chunksize=None, **kwargs):
            """
            Find objects in Fedora.  Find query should be generated via keyword
            args, based on the fields in Fedora documentation.  By default, the
            query uses a contains (~) search for all search terms.  Calls
    Severity: Minor
    Found in eulfedora/server.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

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

        def __init__(self, root=None, username=None, password=None, request=None,
                     retries=default_retry_option):
    
            # when initialized via django, settings should be pulled from django conf
            if root is None:
    Severity: Minor
    Found in eulfedora/server.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 a Cognitive Complexity of 25 (exceeds 5 allowed). Consider refactoring.
    Open

        def __init__(self, root=None, username=None, password=None, request=None,
                     retries=default_retry_option):
    
            # when initialized via django, settings should be pulled from django conf
            if root is None:
    Severity: Minor
    Found in eulfedora/server.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

    Function best_subtype_for_object has a Cognitive Complexity of 25 (exceeds 5 allowed). Consider refactoring.
    Open

        def best_subtype_for_object(self, obj, content_models=None):
            """Given a :class:`~eulfedora.models.DigitalObject`, examine the
            object to select the most appropriate subclass to instantiate. This
            generic implementation examines the object's content models and
            compares them against the defined subclasses of
    Severity: Minor
    Found in eulfedora/server.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

    Cyclomatic complexity is too high in method best_subtype_for_object. (14)
    Open

        def best_subtype_for_object(self, obj, content_models=None):
            """Given a :class:`~eulfedora.models.DigitalObject`, examine the
            object to select the most appropriate subclass to instantiate. This
            generic implementation examines the object's content models and
            compares them against the defined subclasses of
    Severity: Minor
    Found in eulfedora/server.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 find_objects. (12)
    Open

        def find_objects(self, terms=None, type=None, chunksize=None, **kwargs):
            """
            Find objects in Fedora.  Find query should be generated via keyword
            args, based on the fields in Fedora documentation.  By default, the
            query uses a contains (~) search for all search terms.  Calls
    Severity: Minor
    Found in eulfedora/server.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 class Repository. (6)
    Open

    class Repository(object):
        """Pythonic interface to a single Fedora Commons repository instance.
    
        Connect to a single Fedora Repository by passing in connection
        parameters or based on configuration in a Django settings file.
    Severity: Minor
    Found in eulfedora/server.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 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

        def __init__(self, root=None, username=None, password=None, request=None,
    Severity: Minor
    Found in eulfedora/server.py - About 35 mins to fix

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

          def get_object(self, pid=None, type=None, create=None):
              """
              Initialize a single object from Fedora, or create a new one, with the
              same Fedora configuration and credentials.
      
      
      Severity: Minor
      Found in eulfedora/server.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

      TODO found
      Open

              # TODO: eventually we want to handle the case where a DigitalObject
      Severity: Minor
      Found in eulfedora/server.py by fixme

      TODO found
      Open

              # TODO: store these at registration in a way that doesn't require
      Severity: Minor
      Found in eulfedora/server.py by fixme

      There are no issues that match your filters.

      Category
      Status