Fix many TODOs

Author: martianbug

README.md

@@ -35,6 +35,9 @@ https://github.com/DIDONEproject/music_symbolic_features
 
 ## Changelog
 
+#### v1.1.6
+* fix bug on previoous release and add jsimbollic remove repetitions
+
 #### v1.1.5
 * fix minor bug that caused very unnecesary large memory usage
 

config_postprocess_example.yml

@@ -40,7 +40,6 @@ separate_intrumentation_column: False
 instruments_to_keep: []
   # Possible values are from abbreviations from musif.musicxml.constants.SOUND_TO_ABBREVIATION
   # Note that if an abbreviation is not available, the full instrument name is used
-  # TODO: why these instrument names are not capitalized?
   # Example:
   # - vnI
   # - bs

docs/source/Configuration.md

@@ -52,4 +52,4 @@ def update_part_objects(
 
 Also, have a look the [Configuration API page](./API/musif.config.html) to understand how
 the `Configuration` class works. You can subclass it for advanced handling of
-configurations; see, for instance, the [Didone feature project](//TODO).
+configurations; see, for instance, the [Didone feature project](./Custom_Configuration.html).

docs/source/Custom_Configuration.md

@@ -0,0 +1,30 @@
+# Custom Configuration for DIDONE PROJECT
+Here we present an example of using ExtracConfiguration class by subclassing it to create our own CustomConf class following specific needs. 
+
+In DIDONE project's case, It was needed to load many *.csv files contatining metadata information and include this inofrmation into the DataFrame that musif extracts. This metadata information loaded in our Custom conf, was later used by our custom modules to include it in the final DataFrame. Check how we inherit parent class 'ExtractConfiguration' and add some customized methods:
+
+## Code
+from glob import glob
+from os import path
+
+from musif.common._utils import read_dicts_from_csv
+from musif.config import ExtractConfiguration
+
+
+class CustomConf(ExtractConfiguration):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._load_metadata()
+
+    def _load_metadata(self) -> None:
+        self.scores_metadata = {
+            path.basename(file): read_dicts_from_csv(file)
+            for file in glob(path.join(self.metadata_dir, "score", "*.csv"))
+        }
+        if not self.scores_metadata:
+            print(
+                "\nMetadata could not be loaded properly!! Check metadata path in config file.\n"
+            )
+        self.characters_gender = read_dicts_from_csv(
+            path.join(self.internal_data_dir, "characters_gender.csv")
+        )

docs/source/index.md

@@ -50,3 +50,4 @@ repo](https://github.com/DIDONEproject/musif/).
   <a href="https://www.uc3m.es" target="_blank"><img src="./_static/imgs/uc3m.png" alt="Logo UC3M" align="middle"></a>
   <a href="https://erc.europa.eu/" target="_blank"><img src="./_static/imgs/erc.jpg" alt="Logo DIDONE ERC" align="middle"></a>
 </p>
+<link rel="icon" type="image/png" href="./_static/imgs/logo.png" alt="Logo DIDONE"/>

musif/config.py

@@ -4,7 +4,7 @@
 from musif.common._utils import read_object_from_yaml_file
 from musif.extract.constants import REQUIRE_MSCORE
 
-# TODO: add documentation for these variables
+"""Check config_extraction_example.yml file for the purpose of these variables, if needed."""
 LOGGER_NAME = "musif"
 LOG = "log"
 LOG_FILE_PATH = "log_file"

musif/extract/constants.py

@@ -17,6 +17,7 @@
 HARMONY_FEATURES = "harmony"
 SCALE_RELATIVE_FEATURES = "scale_relative"
 REQUIRE_MSCORE = [HARMONY_FEATURES, SCALE_RELATIVE_FEATURES]
+
 """Names of modules taht require harmonic analysis in a .mscx file"""
 
 VOICES_LIST = ["sop", "ten", "alt", "bar", "bbar", "bass"]

musif/extract/features/core/handler.py

@@ -88,8 +88,7 @@ def update_score_objects(
             score_key = key.Key(tonality_ms3)
             mode, key_name = get_name_from_key(score_key)
 
-    # score_features[FILE_NAME] = path.abspath(score_data[DATA_FILE])
-    score_features[FILE_NAME] = path.basename(score_data[DATA_FILE]) # TODO: KMore like this maybe???
+    score_features[FILE_NAME] = path.basename(score_data[DATA_FILE])
     num_measures = len(score.parts[0].getElementsByClass(Measure))
     key_signature = _get_key_signature(score_key)
 

musif/extract/features/density/handler.py

@@ -55,13 +55,11 @@ def update_part_objects(
 
     time_signatures = part_data[TIME_SIGNATURES]
 
-    ## TODO: cuando haya repeticiones, revisar esto. Lo hice por un error en la numeracion cuando hay 70x1 (celdillas)
     sounding_time_signatures = [time_signatures[i] for i in sounding_measures]
 
     part_features.update(
         {
-            SOUNDING_DENSITY: len(notes)
-            / _calculate_total_number_of_beats(sounding_time_signatures)
+            SOUNDING_DENSITY: len(notes) / _calculate_total_number_of_beats(sounding_time_signatures)
             if len(sounding_time_signatures) > 0
             else 0,
             DENSITY: len(notes)

musif/extract/features/jsymbolic/handler.py

@@ -41,7 +41,6 @@ def update_score_objects(
     # 1. create a temporary directory (if Linux, force RAM usig /dev/shm)
     with get_tmpdir() as tmpdirname:
         # 2. convert the score to MEI usiing music21
-        # TODO: if music21 implements export to MEI, use it
         midi_path = os.path.abspath(os.path.join(tmpdirname, "score.midi"))
         if cfg.jsymbolic_remove_repeats:
             score_without_repeats, _ = _remove_repetitions_from_score(score)

musif/musicxml/common.py

@@ -197,7 +197,6 @@ def _get_degrees_and_accidentals(key: str, notes: List[Note]) -> List[Tuple[str,
 
 
 def _get_intervals(notes: List[Note]) -> List[Interval]:
-    # TODO: this takes > 6% of the time
     return [
         Interval(notes[i].pitches[0], notes[i + 1].pitches[0])
         for i in range(len(notes) - 1)

musif/musicxml/repeat.py

@@ -11,8 +11,6 @@
 
 from musif.logs import ldebug
 
-# TODO: document this module
-
 
 def measure_ranges(
     instrument_measures,
@@ -83,7 +81,6 @@ def measure_ranges(
     return measures
 
 
-# TODO: This function is too long
 def expand_repeat_bars(score):
     final_score = Score()
     final_score.metadata = score.metadata
@@ -254,7 +251,6 @@ def expand_score_repetitions(score, repeat_elements):
     return final_score
 
 
-# TODO: this function seems alittle long as well
 def get_expanded_measures(part_measures, repeat_elements):
     repeat_bracket = (
         sum([1 if "repeat bracket" in item[1] else 0 for item in repeat_elements]) > 0