setokinto/slack-shogi

View on GitHub
app/modules/shogi_output.py

Summary

Maintainability
F
4 days
Test Coverage

Function make_board_info_text has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
Open

def make_board_info_text(board_info, reverse=False):
    return_text = ""
    x_labels = [1, 2, 3, 4, 5, 6, 7, 8, 9]
    y_labels = [9, 8, 7, 6, 5, 4, 3, 2, 1]

Severity: Minor
Found in app/modules/shogi_output.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 make_user_text has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

def make_user_text(user_name, motigoma,
                   is_first=True, is_turn=True, reverse=False):
    return_text = ""
    if is_turn:
        return_text = "[手番]"
Severity: Minor
Found in app/modules/shogi_output.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

Function make_user_text has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

def make_user_text(user_name, motigoma,
Severity: Minor
Found in app/modules/shogi_output.py - About 35 mins to fix

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

    y_number2emoji = {
        1: emoji_separetor + emoji_prefix + "one" + emoji_separetor,
        2: emoji_separetor + emoji_prefix + "two" + emoji_separetor,
        3: emoji_separetor + emoji_prefix + "three" + emoji_separetor,
        4: emoji_separetor + emoji_prefix + "four" + emoji_separetor,
    Severity: Major
    Found in app/modules/shogi_output.py and 1 other location - About 1 day to fix
    app/modules/shogi_output.py on lines 40..49

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 187.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

    x_number2emoji = {
        1: emoji_separetor + emoji_prefix + "iti" + emoji_separetor,
        2: emoji_separetor + emoji_prefix + "ni" + emoji_separetor,
        3: emoji_separetor + emoji_prefix + "san" + emoji_separetor,
        4: emoji_separetor + emoji_prefix + "yon" + emoji_separetor,
    Severity: Major
    Found in app/modules/shogi_output.py and 1 other location - About 1 day to fix
    app/modules/shogi_output.py on lines 52..61

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 187.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    There are no issues that match your filters.

    Category
    Status