mrtazz/simplenote.py

View on GitHub
simplenote/simplenote.py

Summary

Maintainability
D
2 days
Test Coverage

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

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

                try:
                    response = urllib2.urlopen(request)
                except HTTPError as e:
                    if e.code == 401:
                        raise SimplenoteLoginFailed('Login to Simplenote API failed! Check Token.')
        Severity: Major
        Found in simplenote/simplenote.py and 1 other location - About 2 hrs to fix
        simplenote/simplenote.py on lines 189..197

        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 61.

        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

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

                try:
                    response = urllib2.urlopen(request)
                except HTTPError as e:
                    if e.code == 401:
                        raise SimplenoteLoginFailed('Login to Simplenote API failed! Check Token.')
        Severity: Major
        Found in simplenote/simplenote.py and 1 other location - About 2 hrs to fix
        simplenote/simplenote.py on lines 131..139

        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 61.

        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

                if sys.version_info < (3, 0):
                    for k,v in mappings.iteritems():
                        if k in note:
                            note[v] = note.pop(k)
        Severity: Major
        Found in simplenote/simplenote.py and 1 other location - About 1 hr to fix
        simplenote/simplenote.py on lines 416..423

        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 40.

        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