Sign upLogin

6uhrmittag/taskbutler

View on GitHub
Star

Showing 24 of 24 total issues

Function main has a Cognitive Complexity of 178 (exceeds 5 allowed). Consider refactoring.
Open

def main():
    # create config
    if not os.path.exists(getConfigPaths().config()):
        os.mkdir(getConfigPaths().app(), mode=0o750)
        os.mkdir(getConfigPaths().config(), mode=0o750)
Severity: Minor
Found in taskbutler/taskbutler.py - About 3 days 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 main. (76)
Open

def main():
    # create config
    if not os.path.exists(getConfigPaths().config()):
        os.mkdir(getConfigPaths().app(), mode=0o750)
        os.mkdir(getConfigPaths().config(), mode=0o750)
Severity: Minor
Found in taskbutler/taskbutler.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

File taskbutler.py has 503 lines of code (exceeds 250 allowed). Consider refactoring.
Open

#!/usr/bin/env python
# -*- coding: utf-8 -*-

import codecs
import logging
Severity: Major
Found in taskbutler/taskbutler.py - About 1 day to fix

    Cyclomatic complexity is too high in function getprogresssymbols. (12)
    Open

    def getprogresssymbols(progress_done, secrets):
    """
    Returns unicode bar based on given percentage.

    :param secrets:
    Severity: Minor
    Found in taskbutler/taskbutler.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

    Cyclomatic complexity is too high in function gettaskwithlabelid. (9)
    Open

    def gettaskwithlabelid(labelid, api):
    """
    Returns a list of Task IDs found with given label-ID

    :param labelid: (str) label ID of label to search for
    Severity: Minor
    Found in taskbutler/taskbutler.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

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

    def createdropboxfile(title, dbx, templatefile, dropbox_prepart_files, folder) -> str:
    """
    Creates new dropbox file with given name. Returns a office online URL
    Requires a authorized dropbox -> office365 connection
    Severity: Minor
    Found in taskbutler/taskbutler.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 gettaskwithlabelid has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
    Open

    def gettaskwithlabelid(labelid, api):
    """
    Returns a list of Task IDs found with given label-ID

    :param labelid: (str) label ID of label to search for
    Severity: Minor
    Found in taskbutler/taskbutler.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

    Avoid deeply nested control flow statements.
    Open

                        for label in task['labels']:
                        if label == label_grocery_id:
                            logger.debug("Found grocery list: {}".format(task['content']))

                            grocery_value_total_old = float(0)
    Severity: Major
    Found in taskbutler/taskbutler.py - About 45 mins to fix

      Avoid deeply nested control flow statements.
      Open

                          if label == label_progress_id:
                        logger.debug("Found task to track: {}".format(task['content']))

                        counter_progress = counter_progress + 1
                        subtasks_total = 0
      Severity: Major
      Found in taskbutler/taskbutler.py - About 45 mins to fix

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

        def createpaperdocument(title, dbx, todoistfolderid, todoistpaperurl, sharing) -> str:
        Severity: Minor
        Found in taskbutler/taskbutler.py - About 35 mins to fix

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

          def createdropboxfile(title, dbx, templatefile, dropbox_prepart_files, folder) -> str:
          Severity: Minor
          Found in taskbutler/taskbutler.py - About 35 mins to fix

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

            def getprogresssymbols(progress_done, secrets):
    """
    Returns unicode bar based on given percentage.

    :param secrets:
            Severity: Minor
            Found in taskbutler/taskbutler.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

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

            def gettodoistfolderid(foldername: str, dbx):
    """

    Dropbox - Get Folder ID of folder "todoist" from user account
    Note : only finds folder once a paper is created in. create test paper first.
            Severity: Minor
            Found in taskbutler/taskbutler.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 1
            Severity: Major
            Found in taskbutler/taskbutler.py - About 30 mins to fix

              Merge this if statement with the enclosing one.
              Open

                          if folder_meta.folders[0].name == foldername:
              Severity: Major
              Found in taskbutler/taskbutler.py by sonar-python

              Merging collapsible if statements increases the code's readability.

              Noncompliant Code Example

              if condition1:
    if condition2:
        # ...

              Compliant Solution

              if condition1 and condition2:
    # ...

              Rename function "addToTitle" to match the regular expression ^[a-z_][a-z0-9_]{2,}$.
              Open

              def addToTitle(title, valueToAdd, seperator):
              Severity: Major
              Found in taskbutler/taskbutler.py by sonar-python

              Shared coding conventions allow teams to collaborate efficiently. This rule checks that all function names match a provided regular expression.

              Noncompliant Code Example

              With the default provided regular expression: ^[a-z_][a-z0-9_]{2,30}$

              def MyFunction(a,b):
    ...

              Compliant Solution

              def my_function(a,b):
    ...

              Rename function "getRawPriceFromGrocery" to match the regular expression ^[a-z_][a-z0-9_]{2,}$.
              Open

              def getRawPriceFromGrocery(title, grocery_currency, grocery_seperator, isTitle=True) -> float:
              Severity: Major
              Found in taskbutler/taskbutler.py by sonar-python

              Shared coding conventions allow teams to collaborate efficiently. This rule checks that all function names match a provided regular expression.

              Noncompliant Code Example

              With the default provided regular expression: ^[a-z_][a-z0-9_]{2,30}$

              def MyFunction(a,b):
    ...

              Compliant Solution

              def my_function(a,b):
    ...

              Either remove or fill this block of code.
              Open

                      pass
              Severity: Major
              Found in taskbutler/cli.py by sonar-python

              Most of the time a block of code is empty when a piece of code is really missing. So such empty block must be either filled or removed.

              Noncompliant Code Example

              for i in range(3):
    pass

              Exceptions

              When a block contains a comment, this block is not considered to be empty.

              Merge this if statement with the enclosing one.
              Open

                                              if not subTask['is_deleted'] and subTask['parent_id'] == task['id']:
              Severity: Major
              Found in taskbutler/taskbutler.py by sonar-python

              Merging collapsible if statements increases the code's readability.

              Noncompliant Code Example

              if condition1:
    if condition2:
        # ...

              Compliant Solution

              if condition1 and condition2:
    # ...

              Remove this commented out code.
              Open

                          # print(document_meta.title + "in Folder: " + folder_meta.folders[0].name + "id: " + folder_meta.folders[0].id)
              Severity: Major
              Found in taskbutler/taskbutler.py by sonar-python

              Programmers should not comment out code as it bloats programs and reduces readability.

              Unused code should be deleted and can be retrieved from source control history if required.

              See

              • MISRA C:2004, 2.4 - Sections of code should not be "commented out".
              • MISRA C++:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
              • MISRA C++:2008, 2-7-3 - Sections of code should not be "commented out" using C++ comments.
              • MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"
              Severity
              Category
              Status
              Source
              Language