HazyResearch/fonduer

View on GitHub
src/fonduer/parser/visual_parser/pdf_visual_parser.py

Summary

Maintainability
D
1 day
Test Coverage

Function _link_lists has a Cognitive Complexity of 47 (exceeds 5 allowed). Consider refactoring.
Open

    def _link_lists(
        self, search_max: int = 100, edit_cost: int = 20, offset_cost: int = 1
    ) -> None:
        # NOTE: there are probably some inefficiencies here from rehashing words
        # multiple times, but we're not going to worry about that for now
Severity: Minor
Found in src/fonduer/parser/visual_parser/pdf_visual_parser.py - About 7 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

File pdf_visual_parser.py has 304 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""Fonduer visual parser that parses visual information from PDF."""
import logging
import os
import re
import shutil
Severity: Minor
Found in src/fonduer/parser/visual_parser/pdf_visual_parser.py - About 3 hrs to fix

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

        def _link_lists(
            self, search_max: int = 100, edit_cost: int = 20, offset_cost: int = 1
        ) -> None:
            # NOTE: there are probably some inefficiencies here from rehashing words
            # multiple times, but we're not going to worry about that for now

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

        def _coordinates_from_HTML(
            self, page: Tag, page_num: int
        ) -> Tuple[List[PdfWord], Dict[PdfWordId, Bbox]]:
            pdf_word_list: List[PdfWord] = []
            coordinate_map: Dict[PdfWordId, Bbox] = {}
    Severity: Minor
    Found in src/fonduer/parser/visual_parser/pdf_visual_parser.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

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

        def _coordinates_from_HTML(
            self, page: Tag, page_num: int
        ) -> Tuple[List[PdfWord], Dict[PdfWordId, Bbox]]:
            pdf_word_list: List[PdfWord] = []
            coordinate_map: Dict[PdfWordId, Bbox] = {}

    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

    Avoid deeply nested control flow statements.
    Open

                            if len(content) > 0:  # Ignore empty characters
                                word_id: PdfWordId = (page_num, i)
                                pdf_word_list.append((word_id, content))
                                coordinate_map[word_id] = Bbox(
                                    page_num,
    Severity: Major
    Found in src/fonduer/parser/visual_parser/pdf_visual_parser.py - About 45 mins to fix

      There are no issues that match your filters.

      Category
      Status