HazyResearch/fonduer

View on GitHub
src/fonduer/packaging/fonduer_model.py

Summary

Maintainability
C
1 day
Test Coverage

File fonduer_model.py has 358 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""Customized MLflow model for Fonduer."""
import logging
import os
import sys
from io import BytesIO
Severity: Minor
Found in src/fonduer/packaging/fonduer_model.py - About 4 hrs to fix

    Cyclomatic complexity is too high in function save_model. (17)
    Open

    def save_model(
        fonduer_model: FonduerModel,
        path: str,
        preprocessor: DocPreprocessor,
        parser: Parser,

    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 save_model has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
    Open

    def save_model(
        fonduer_model: FonduerModel,
        path: str,
        preprocessor: DocPreprocessor,
        parser: Parser,
    Severity: Minor
    Found in src/fonduer/packaging/fonduer_model.py - About 2 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 save_model has 16 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def save_model(
    Severity: Major
    Found in src/fonduer/packaging/fonduer_model.py - About 2 hrs to fix

      Function log_model has 15 arguments (exceeds 4 allowed). Consider refactoring.
      Open

      def log_model(
      Severity: Major
      Found in src/fonduer/packaging/fonduer_model.py - About 1 hr to fix

        Function "save_model" has 16 parameters, which is greater than the 7 authorized.
        Open

            fonduer_model: FonduerModel,
            path: str,
            preprocessor: DocPreprocessor,
            parser: Parser,
            mention_extractor: MentionExtractor,

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

        Function "log_model" has 15 parameters, which is greater than the 7 authorized.
        Open

            fonduer_model: FonduerModel,
            artifact_path: str,
            preprocessor: DocPreprocessor,
            parser: Parser,
            mention_extractor: MentionExtractor,

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

        Refactor this function to reduce its Cognitive Complexity from 19 to the 15 allowed.
        Open

        def save_model(

        Cognitive Complexity is a measure of how hard the control flow of a function is to understand. Functions with high Cognitive Complexity will be difficult to maintain.

        See

        There are no issues that match your filters.

        Category
        Status