zxc23/dcss-scoreboard

View on GitHub
scoreboard/model.py

Summary

Maintainability
D
2 days
Test Coverage

File model.py has 678 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""Defines the database models for this module."""

import functools
import datetime
from typing import Optional, Tuple, Callable, Sequence
Severity: Major
Found in scoreboard/model.py - About 1 day to fix

    Cyclomatic complexity is too high in function _games. (14)
    Open

    def _games(
        s: sqlalchemy.orm.session.Session,
        *,
        player: Optional[Player] = None,
        account: Optional[Account] = None,
    Severity: Minor
    Found in scoreboard/model.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 _games has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
    Open

    def _games(
        s: sqlalchemy.orm.session.Session,
        *,
        player: Optional[Player] = None,
        account: Optional[Account] = None,
    Severity: Minor
    Found in scoreboard/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

    Cyclomatic complexity is too high in function get_streaks. (6)
    Open

    def get_streaks(
        s: sqlalchemy.orm.session.Session,
        active: Optional[bool] = None,
        limit: Optional[int] = None,
        max_age: Optional[int] = None,
    Severity: Minor
    Found in scoreboard/model.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 _games has 10 arguments (exceeds 4 allowed). Consider refactoring.
    Open

    def _games(
    Severity: Major
    Found in scoreboard/model.py - About 1 hr to fix

      Function list_games has 10 arguments (exceeds 4 allowed). Consider refactoring.
      Open

      def list_games(
      Severity: Major
      Found in scoreboard/model.py - About 1 hr to fix

        Function count_games has 8 arguments (exceeds 4 allowed). Consider refactoring.
        Open

        def count_games(
        Severity: Major
        Found in scoreboard/model.py - About 1 hr to fix

          Function _reraise_dberror has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
          Open

          def _reraise_dberror(function: Callable) -> Callable:
              """Re-raise errors from decorated function as DBError or DBIntegrityError.
          
              Doesn't re-wrap DBError/DBIntegrityError exceptions.
              """
          Severity: Minor
          Found in scoreboard/model.py - About 55 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 fastest_wins has 5 arguments (exceeds 4 allowed). Consider refactoring.
          Open

          def fastest_wins(
          Severity: Minor
          Found in scoreboard/model.py - About 35 mins to fix

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

            def combo_highscores(s: sqlalchemy.orm.session.Session) -> Sequence[Game]:
                """Return the top score for each playable combo.
            
                Not every combo may have a game in the database.
                """
            Severity: Minor
            Found in scoreboard/model.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

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

            def fastest_wins(
                s: sqlalchemy.orm.session.Session,
                *,
                limit: int = const.GLOBAL_TABLE_LENGTH,
                exclude_bots: bool = True,
            Severity: Minor
            Found in scoreboard/model.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

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

            def setup_achievements(s: sqlalchemy.orm.session.Session) -> None:
                """Load manual achievements into the database."""
                for proto in const.ACHIEVEMENTS:
                    if (
                        not s.query(Achievement)
            Severity: Minor
            Found in scoreboard/model.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

            Line too long (88 > 79 characters)
            Open

                    s.query(LogfileProgress).filter(LogfileProgress.source_url == url).one_or_none()
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (82 > 79 characters)
            Open

                        Streak.active == (sqlalchemy.true() if active else sqlalchemy.false())
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (88 > 79 characters)
            Open

                    result = q.filter(game_column == i).order_by(Game.score.desc()).limit(1).first()
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (85 > 79 characters)
            Open

                        new.append({"short": sp.short, "name": sp.full, "playable": sp.playable})
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (82 > 79 characters)
            Open

            def list_achievements(s: sqlalchemy.orm.session.Session) -> Sequence[Achievement]:
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (83 > 79 characters)
            Open

                    .filter(func.lower(Account.name) == name.lower(), Account.server == server)
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (80 > 79 characters)
            Open

            def add_games(s: sqlalchemy.orm.session.Session, games: Sequence[dict]) -> None:
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (81 > 79 characters)
            Open

                    print("Warning: Found new ktyp %s, please add me to constants.py" % name)
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (80 > 79 characters)
            Open

                        Game.scored == (sqlalchemy.true() if scored else sqlalchemy.false())
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (83 > 79 characters)
            Open

            def updated_player_page(s: sqlalchemy.orm.session.Session, player: Player) -> None:
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (88 > 79 characters)
            Open

                    s.query(Player.id).filter(func.lower(Player.name) == name.lower()).one_or_none()
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (81 > 79 characters)
            Open

                return sorted(results.items(), key=lambda i: len(i[1]), reverse=True)[:limit]
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (88 > 79 characters)
            Open

            def get_account_id(s: sqlalchemy.orm.session.Session, name: str, server: Server) -> int:
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (85 > 79 characters)
            Open

                    s.query(Player).filter(func.lower(Player.name) == name.lower()).one_or_none()
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (80 > 79 characters)
            Open

                    q = q.order_by(Game.end.desc() if not reverse_order else Game.end.asc())
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (85 > 79 characters)
            Open

                        new.append({"short": bg.short, "name": bg.full, "playable": bg.playable})
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (84 > 79 characters)
            Open

            def get_place(s: sqlalchemy.orm.session.Session, branch: Branch, lvl: int) -> Place:
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (80 > 79 characters)
            Open

                    if not s.query(Background).filter(Background.short == bg.short).first():
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (85 > 79 characters)
            Open

                place = s.query(Place).filter(Place.branch == branch, Place.level == lvl).first()
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (83 > 79 characters)
            Open

                        cls.playable == (sqlalchemy.true() if playable else sqlalchemy.false())
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            Line too long (80 > 79 characters)
            Open

            def total_duration(s: sqlalchemy.orm.session.Session, *, player: Player) -> int:
            Severity: Minor
            Found in scoreboard/model.py by pep8

            Limit all lines to a maximum of 79 characters.

            There are still many devices around that are limited to 80 character
            lines; plus, limiting windows to 80 characters makes it possible to
            have several windows side-by-side.  The default wrapping on such
            devices looks ugly.  Therefore, please limit all lines to a maximum
            of 79 characters. For flowing long blocks of text (docstrings or
            comments), limiting the length to 72 characters is recommended.
            
            Reports error E501.

            There are no issues that match your filters.

            Category
            Status