albertyw/git-browse

View on GitHub

Showing 4 of 4 total issues

File browse.py has 295 lines of code (exceeds 250 allowed). Consider refactoring.
Open

#!/usr/bin/env python3

import argparse
import configparser
import os
Severity: Minor
Found in git_browse/browse.py - About 3 hrs to fix

    Cyclomatic complexity is too high in function get_git_object. (7)
    Open

    def get_git_object(focus_object: str, path: str, host: Any) -> GitObject:
        if not focus_object:
            return FocusObject.default()
        directory = path
        object_path = os.path.join(directory, focus_object)
    Severity: Minor
    Found in git_browse/browse.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 get_git_object has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

    def get_git_object(focus_object: str, path: str, host: Any) -> GitObject:
        if not focus_object:
            return FocusObject.default()
        directory = path
        object_path = os.path.join(directory, focus_object)
    Severity: Minor
    Found in git_browse/browse.py - About 45 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

    Function parse_git_url has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

    def parse_git_url(git_url: str, sourcegraph: bool = False) -> Any:
        for regex, host_class in HOST_REGEXES.items():
            match = re.search(regex, git_url)
            if match:
                break
    Severity: Minor
    Found in git_browse/browse.py - About 25 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

    Severity
    Category
    Status
    Source
    Language