Godley/Music-Library

View on GitHub
implementation/primaries/ExtractMetadata/classes/DataLayer/musicdata.py

Summary

Maintainability
F
3 days
Test Coverage

File musicdata.py has 633 lines of code (exceeds 250 allowed). Consider refactoring.
Open

"""
This class handles very low level queries to the database file, including
creation of tables when files are first created (will do if not exists so
there are no clashes), handling connection and disconnection from the DB,
etc.

    MusicData has 39 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class MusicData(querylayer.QueryLayer):
        parsers = {"tempos": TempoParser(),
                   "time_signatures": MeterParser(),
                   "instruments": InstrumentParser()}
    
    

      Cyclomatic complexity is too high in method get_user_playlists_by_filename. (6)
      Open

          def get_user_playlists_by_filename(self, filename):
              data = self.query({'filename': filename})
              result = {}
              if len(data) > 0:
                  data = data[0]

      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 method getPieceByInstrumentsOrSimilar. (6)
      Open

          def getPieceByInstrumentsOrSimilar(
                  self,
                  instruments,
                  archived=False,
                  online=False):

      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 add_instruments_to_piece has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
      Open

          def add_instruments_to_piece(self, data, piece_id):
              result_data = copy.deepcopy(data)
              data_keys = ['keys', 'clefs']
              for instrument in result_data["instruments"]:
                  name = instrument['name']

      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 get_piece_by_all_ has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

          def get_piece_by_all_(self, elem='keys', online=False, archived=False):
              table = self.get_join(elem)
              elems = self.to_dict(table, self.get_all(table=table))
              sorted = self.order_by(
                  elems,

      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 get_user_playlists_by_filename has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

          def get_user_playlists_by_filename(self, filename):
              data = self.query({'filename': filename})
              result = {}
              if len(data) > 0:
                  data = data[0]

      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 add_piece_links has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Open

          def add_piece_links(self, piece_id, data):
              if "instruments" in data:
                  data = self.add_instruments_to_piece(data, piece_id)
              else:
                  raise BadPieceException(
      Severity: Minor
      Found in implementation/primaries/ExtractMetadata/classes/DataLayer/musicdata.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 getPieceByInstrumentsOrSimilar has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          def getPieceByInstrumentsOrSimilar(
                  self,
                  instruments,
                  archived=False,
                  online=False):
      Severity: Minor
      Found in implementation/primaries/ExtractMetadata/classes/DataLayer/musicdata.py - About 45 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 add_instrument_to_piece has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
      Open

          def add_instrument_to_piece(self, data, piece_id, clefs={}, keys={}):
              ins = self.get_or_add(data, table='instruments')[0]
              for clef_data in clefs:
                  clef = self.query(clef_data, table='clefs')
                  if len(clef) > 0:
      Severity: Minor
      Found in implementation/primaries/ExtractMetadata/classes/DataLayer/musicdata.py - About 45 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 getPieceByTitle has 5 arguments (exceeds 4 allowed). Consider refactoring.
      Open

          def getPieceByTitle(self, title, *args,
      Severity: Minor
      Found in implementation/primaries/ExtractMetadata/classes/DataLayer/musicdata.py - About 35 mins to fix

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

            def getPieceByMeter(self, meters, archived=False, online=False):
                results = set()
                for meter in meters:
                    if "/" in meter:
                        values = meter.split("/")
        Severity: Minor
        Found in implementation/primaries/ExtractMetadata/classes/DataLayer/musicdata.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 getPieceByInstrumentIn_ has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

            def getPieceByInstrumentIn_(
                    self,
                    data,
                    table="clefs",
                    archived=False,
        Severity: Minor
        Found in implementation/primaries/ExtractMetadata/classes/DataLayer/musicdata.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 get_piece_by_all_creators has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

            def get_piece_by_all_creators(
                    self,
                    elem="composer",
                    online=False,
                    archived=False):
        Severity: Minor
        Found in implementation/primaries/ExtractMetadata/classes/DataLayer/musicdata.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 get_pieces_by_row_id has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

            def get_pieces_by_row_id(self, rows, archived=False, online=False):
                """
                method which takes in a list of rows which are ROWIDs in the
                piece table and returns a list of files
                :param rows: list of tuples pertaining to ROWIDs in pieces table
        Severity: Minor
        Found in implementation/primaries/ExtractMetadata/classes/DataLayer/musicdata.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 add_piece has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

            def add_piece(self, filename, data):
                '''
                method which takes in stuff about a piece and adds it
                 to the relevant tables
                :param filename: filename the piece is talking about
        Severity: Minor
        Found in implementation/primaries/ExtractMetadata/classes/DataLayer/musicdata.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 add_playlist has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

            def add_playlist(self, name, files):
                id = self.add({"name": name}, table='playlists')
                if len(id) > 0:
                    id = id[0]
                    for file in files:
        Severity: Minor
        Found in implementation/primaries/ExtractMetadata/classes/DataLayer/musicdata.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

        TODO found
        Open

                        # TODO bounds check

        Line too long (84 > 79 characters)
        Open

                                ((elem, key), self.getInstrumentsByTransposition(transpos)))

        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

                method which searches first for any pieces containing the exact instrument,

        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 (90 > 79 characters)
        Open

                            {"beat": beat, "beat_type": b_type}, table="time_signatures")[0]['id']

        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 (90 > 79 characters)
        Open

                                    "each instrument should have atleast one {}".format(key[:-1]))

        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 (86 > 79 characters)
        Open

                                "each instrument should have atleast one {}".format(key[:-1]))

        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