Sign upLogin

tjcsl/ion

View on GitHub
Star
intranet/utils/helpers.py

Summary

Maintainability
B
6 hrs
Test Coverage

Cyclomatic complexity is too high in function get_theme_name. (16)
Open

def get_theme_name() -> str:
    """Get the name of the currently active special event theme."""
    today = timezone.localdate()
    if today.month in (12, 1):
        first_monday_of_month = (8 - datetime.date(today.year, today.month, 1).weekday()) % 7
Severity: Minor
Found in intranet/utils/helpers.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_theme_name has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
Open

def get_theme_name() -> str:
    """Get the name of the currently active special event theme."""
    today = timezone.localdate()
    if today.month in (12, 1):
        first_monday_of_month = (8 - datetime.date(today.year, today.month, 1).weekday()) % 7
Severity: Minor
Found in intranet/utils/helpers.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

Consider simplifying this complex logical expression.
Open

    if today.month in (12, 1):
        first_monday_of_month = (8 - datetime.date(today.year, today.month, 1).weekday()) % 7
        if (today.month == 12 and today.day >= first_monday_of_month) or (today.month == 1 and today.day < first_monday_of_month + 7):
            return "snow"
    elif today.month == 3 and (14 <= today.day <= 16):
Severity: Critical
Found in intranet/utils/helpers.py - About 1 hr to fix

    Function debug_toolbar_callback has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

    def debug_toolbar_callback(request):
    """
    In development:
        Show the debug toolbar to all users.
    In production:
    Severity: Minor
    Found in intranet/utils/helpers.py - About 35 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

    Avoid too many return statements within this function.
    Open

        return None
    Severity: Major
    Found in intranet/utils/helpers.py - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

              return False
      Severity: Major
      Found in intranet/utils/helpers.py - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

                return False
        Severity: Major
        Found in intranet/utils/helpers.py - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

              return "debug" in request.GET or settings.DEBUG
          Severity: Major
          Found in intranet/utils/helpers.py - About 30 mins to fix

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

                def __contains__(self, key):
        """Check if a string matches a glob in the list."""

        # request.HTTP_X_FORWARDED_FOR contains can contain a comma delimited
        # list of IP addresses, if the user is using a proxy
            Severity: Minor
            Found in intranet/utils/helpers.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 (134 > 79 characters)
            Open

                    if (today.month == 12 and today.day >= first_monday_of_month) or (today.month == 1 and today.day < first_monday_of_month + 7):
            Severity: Minor
            Found in intranet/utils/helpers.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 (104 > 79 characters)
            Open

                elif (today.month == 3 and (30 <= today.day <= 31)) or (today.month == 4 and (1 <= today.day <= 7)):
            Severity: Minor
            Found in intranet/utils/helpers.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 (93 > 79 characters)
            Open

                    first_monday_of_month = (8 - datetime.date(today.year, today.month, 1).weekday()) % 7
            Severity: Minor
            Found in intranet/utils/helpers.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 (108 > 79 characters)
            Open

                "april_fools": {"js": "themes/april_fools/april_fools.js", "css": "themes/april_fools/april_fools.css"},
            Severity: Minor
            Found in intranet/utils/helpers.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 (96 > 79 characters)
            Open

                        {'<i class="fa fa-chevron-down warning-toggle-icon"></i>' if counter == 0 else ''} \
            Severity: Minor
            Found in intranet/utils/helpers.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 (101 > 79 characters)
            Open

                    Show the debug toolbar to those with the Django staff permission, excluding the Eighth Period
            Severity: Minor
            Found in intranet/utils/helpers.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 (98 > 79 characters)
            Open

                            if ipaddress.ip_address(key) in ipaddress.ip_network(item) and key != "127.0.0.1":
            Severity: Minor
            Found in intranet/utils/helpers.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 (96 > 79 characters)
            Open

                Dashboard and login logic is processed here because they cannot be filtered using .filter().
            Severity: Minor
            Found in intranet/utils/helpers.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 (97 > 79 characters)
            Open

                elif (today.month == 10 and 27 <= today.day <= 31) or (today.month == 11 and today.day == 1):
            Severity: Minor
            Found in intranet/utils/helpers.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 (101 > 79 characters)
            Open

                Global warnings are pre-filtered and passed directly to this function from the context processor.
            Severity: Minor
            Found in intranet/utils/helpers.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

                return timezone.localtime().replace(hour=0, minute=0, second=0, microsecond=0)
            Severity: Minor
            Found in intranet/utils/helpers.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 (103 > 79 characters)
            Open

                return {name: {"source_filenames": ["css/%s.scss" % name], "output_filename": "css/%s.css" % name}}
            Severity: Minor
            Found in intranet/utils/helpers.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 (97 > 79 characters)
            Open

                if get_theme_name() == "halloween" and request.COOKIES.get("disable-halloween", None) != "1":
            Severity: Minor
            Found in intranet/utils/helpers.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

                    warnings = [warning for warning in warnings if warning.show_on_dashboard]
            Severity: Minor
            Found in intranet/utils/helpers.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 (98 > 79 characters)
            Open

                "halloween": {"js": "themes/halloween/halloween.js", "css": "themes/halloween/halloween.css"},
            Severity: Minor
            Found in intranet/utils/helpers.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

                args = {"NAME": url.path[1:], "USER": url.username, "PASSWORD": url.password}
            Severity: Minor
            Found in intranet/utils/helpers.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 (99 > 79 characters)
            Open

                return " and ".join(items) if len(items) <= 2 else ", ".join(items[:-1]) + ", and " + items[-1]
            Severity: Minor
            Found in intranet/utils/helpers.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 (102 > 79 characters)
            Open

                # Note that date objects are always naive, so we have to use datetime for proper timezone support.
            Severity: Minor
            Found in intranet/utils/helpers.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 (98 > 79 characters)
            Open

                return "https://github.com/tjcsl/ion/commit/{}".format(get_current_commit_short_hash(workdir))
            Severity: Minor
            Found in intranet/utils/helpers.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