mrtazz/simplenote.py

View on GitHub

Showing 8 of 11 total issues

File simplenote.py has 346 lines of code (exceeds 250 allowed). Consider refactoring.
Open

# -*- coding: utf-8 -*-
"""
    simplenote.py
    ~~~~~~~~~~~~~~

Severity: Minor
Found in simplenote/simplenote.py - About 4 hrs to fix

    Function get_note_list has a Cognitive Complexity of 25 (exceeds 5 allowed). Consider refactoring.
    Open

        def get_note_list(self, data=True, since=None, tags=[]):
            """ Method to get the note list
    
            The method can be passed optional arguments to limit the list to
            notes containing a certain tag, or only updated since a certain
    Severity: Minor
    Found in simplenote/simplenote.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 __remove_simplenote_api_fields has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
    Open

        def __remove_simplenote_api_fields(self, note):
            # We are not creating a copy of the note to work with as these are only
            # used internally and so doesn't matter if we alter "original"
    
            # These two should have already removed by this point since they are
    Severity: Minor
    Found in simplenote/simplenote.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

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

        def update_note(self, note):
            """ Method to update a specific note object, if the note object does not
            have a "key" field, a new note is created
    
            Arguments
    Severity: Minor
    Found in simplenote/simplenote.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 __init__ has 6 arguments (exceeds 4 allowed). Consider refactoring.
    Open

            def __init__(self, url, data=None, headers={}, origin_req_host=None,
    Severity: Minor
    Found in simplenote/simplenote.py - About 45 mins to fix

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

          def get_note(self, noteid, version=None):
              """ Method to get a specific note
      
              Arguments:
                  - noteid (string): ID of the note to get
      Severity: Minor
      Found in simplenote/simplenote.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 note_list, status
      Severity: Major
      Found in simplenote/simplenote.py - About 30 mins to fix

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

            def delete_note(self, note_id):
                """ Method to permanently delete a note
        
                Arguments:
                    - note_id (string): key of the note to trash
        Severity: Minor
        Found in simplenote/simplenote.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