Fix: Address state issue around annotations variable

app.py

@@ -230,7 +230,7 @@ start_annotating = """<h2>How to use the annotation interface?</h2>
     </div>
 
 </div>"""
-global file_list
+
 persistent_storage = Path('/data')
 
 password_files = os.getenv("password_files")
@@ -279,38 +279,35 @@ def get_storage(password):
         return gr.Warning("Please provide the correct password"), None
 
 
-def load_first_example(participant_id, ann_completed, current_index):
+def load_first_example(annotations_df, file_list_df, participant_id, ann_completed, current_index):
     """ Loads and first example and updates index"""
-    global annotations
-    
     path_ann = f'{persistent_storage}/{participant_id}_annotations.csv'
     print(path_ann)
     if os.path.exists(path_ann):
-        annotations = pd.read_csv(path_ann, keep_default_na=False)
+        annotations_df = pd.read_csv(path_ann, keep_default_na=False)
 
-        current_index = len(annotations)
+        current_index = len(annotations_df)
         print('path was found')
-        print(annotations)
-        print(len(annotations))
-        ann_completed = gr.Number(len(annotations) - 1, visible=False)
-        print(len(annotations))
+   
+        ann_completed = gr.Number(len(annotations_df) - 1, visible=False)
+
     else: 
         # Initialize an empty DataFrame to store annotations
-        annotations = pd.DataFrame(columns=['sample_id', 'sentence', 'emotion', 'confidence', 'comments', 'n_clicks'])
+        annotations_df = pd.DataFrame(columns=['sample_id', 'sentence', 'emotion', 'confidence', 'comments', 'n_clicks'])
 
-    return *load_example(current_index), ann_completed, current_index
+    return annotations_df, *load_example(annotations_df, file_list_df, current_index), ann_completed, current_index
     
-def load_example(index):
+def load_example(annotations_df, file_list_df, index):
     """Loads the example in row #index from dataframe file_list. 
     If there are any annotations it will give those values to the annotation dataframe"""
     
-    row = file_list.iloc[index]
+    row = file_list_df.iloc[index]
     audio_path = os.path.join(persistent_storage, 'files_to_annotate_2round', row["sample_id"].split('-')[0], row["sample_id"] + '.wav')
     sentence = row["sentence"]
 
     # If the user already made an annotation for this example, gradio will return said annotation
     previous_annotation = (
-        annotations.iloc[index].to_dict() if index < len(annotations) else {"sample_id": row["sample_id"], "emotion": 'Blank', "confidence": 'Blank',
+        annotations_df.iloc[index].to_dict() if index < len(annotations) else {"sample_id": row["sample_id"], "emotion": 'Blank', "confidence": 'Blank',
                                                                             "comments": '', "n_clicks": 0}
     )
 
@@ -318,10 +315,10 @@ def load_example(index):
     end = row['end']
     duration = get_audio_duration(audio_path)
     print(f'{start} {end} {duration}')
-    return (sentence, audio_path, previous_annotation['emotion'], previous_annotation['confidence'], previous_annotation["comments"], n_clicks, start, end, duration)
+    return sentence, audio_path, previous_annotation['emotion'], previous_annotation['confidence'], previous_annotation["comments"], n_clicks, start, end, duration
 
 
-def save_annotation(emotions, confidence, comments, n_clicks, participant_id, ann_completed, current_index):
+def save_annotation(annotations_df, file_list_df, emotions, confidence, comments, n_clicks, participant_id, ann_completed, current_index):
     """Save the annotation for the current example."""
 
     row = file_list.iloc[current_index]
@@ -329,17 +326,17 @@ def save_annotation(emotions, confidence, comments, n_clicks, participant_id, an
     sentence = row["sentence"]
 
     # Update or append annotation
-    if sample_id in annotations["sample_id"].values:
-        annotations.loc[annotations["sample_id"] == sample_id, ["emotion", "confidence", "comments", "n_clicks"]] = \
+    if sample_id in annotations_df["sample_id"].values:
+        annotations_df.loc[annotations_df["sample_id"] == sample_id, ["emotion", "confidence", "comments", "n_clicks"]] = \
             [emotions, confidence, comments, n_clicks]
     else:
-        annotations.loc[len(annotations)] = [sample_id, sentence, emotions, confidence, comments, n_clicks]
+        annotations_df.loc[len(annotations_df)] = [sample_id, sentence, emotions, confidence, comments, n_clicks]
         ann_completed = gr.Number(ann_completed + 1, visible=False)
-    annotations.to_csv(f"{persistent_storage}/{participant_id}_annotations.csv", index=False)  # Save to a CSV file
+    annotations_df.to_csv(f"{persistent_storage}/{participant_id}_annotations.csv", index=False)  # Save to a CSV file
     
-    return ann_completed
+    return annotations_df, ann_completed
 
-def next_example(emotions, confidence, comments, n_clicks, participant_id, ann_completed, current_index):
+def next_example(annotations_df, file_list_df, emotions, confidence, comments, n_clicks, participant_id, ann_completed, current_index):
     """Move to the next example."""
 
     if emotions == "Blank":
@@ -348,34 +345,32 @@ def next_example(emotions, confidence, comments, n_clicks, participant_id, ann_c
         gr.Warning("Please fill out the confidence section. 'Blank' is not a valid input.")
 
     else:  
-        ann_completed = save_annotation(emotions, confidence, comments, n_clicks, participant_id, ann_completed, current_index)
-        if current_index < len(file_list) - 1:
+        annotations_df, ann_completed = save_annotation(annotations_df, file_list_df, emotions, confidence, comments, n_clicks, participant_id, ann_completed, current_index)
+        if current_index < len(file_list_df) - 1:
             current_index += 1
-    return *load_example(current_index), ann_completed, current_index
+    return annotations_df, *load_example(annotations_df, file_list_df, current_index), ann_completed, current_index
 
-def previous_example(emotion, confidence, comments, n_clicks, participant_id,  ann_completed, current_index):
+def previous_example(annotations_df, file_list_df, emotion, confidence, comments, n_clicks, participant_id,  ann_completed, current_index):
     """Move to the previous example."""
   
     if emotion != "Blank":
-        ann_completed = save_annotation(emotion, confidence, comments, n_clicks, participant_id,  ann_completed, current_index)
+        annotations_df, ann_completed = save_annotation(annotations_df, file_list_df, emotion, confidence, comments, n_clicks, participant_id,  ann_completed, current_index)
     if current_index > 0:
         current_index -= 1
             
-    return *load_example(current_index), ann_completed, current_index
+    return annotations_df, *load_example(annotations_df, file_list_df, current_index), ann_completed, current_index
 
-def deactivate_participant_id(participant_id, lets_go, total, previous_button, next_button, sentence_text, audio_player, emotions, confidence, comments, n_clicks, ann_completed, current_index):
-    global file_list
-    global total_annotations
+def deactivate_participant_id(annotations_df, file_list_df, total_annotations, participant_id, lets_go, total, previous_button, next_button, sentence_text, audio_player, emotions, confidence, comments, n_clicks, ann_completed, current_index):
+    print(possible_ids.keys())
     if participant_id in possible_ids.keys():
-        file_list = pd.read_csv(os.path.join(persistent_storage, 'files_to_annotate_2round', f'group_{possible_ids[participant_id]}_v2.csv'), keep_default_na=False)
+        file_list_df = pd.read_csv(os.path.join(persistent_storage, 'files_to_annotate_2round', f'group_{possible_ids[participant_id]}_v2.csv'), keep_default_na=False)
 
-        
-        
-        total_annotations = len(file_list)
+          
+        total_annotations = len(file_list_df)
         total = gr.Number(total_annotations, visible=False)
         
 
-        sentence, audio_player, emotions, confidence, comments, n_clicks, start, end, duration, ann_completed, current_index = load_first_example(participant_id, ann_completed, current_index)
+        annotations_df, sentence, audio_player, emotions, confidence, comments, n_clicks, start, end, duration, ann_completed, current_index = load_first_example(annotations_df, file_list_df, participant_id, ann_completed, current_index)
         print(sentence)
         print(start, end, duration)
         participant_id = gr.Textbox(label='What is your participant ID?', value = participant_id, interactive = False)
@@ -387,11 +382,12 @@ def deactivate_participant_id(participant_id, lets_go, total, previous_button, n
         comments = gr.Textbox(label="Comments", visible =True, value = comments)
         previous_button = gr.Button("Previous Example", visible = True)
         next_button = gr.Button("Next Example",visible = True)
+        
+        return annotations_df, file_list_df, participant_id, lets_go, total, previous_button, next_button, sentence_text, audio_player, emotions, confidence, comments, n_clicks, start, end, duration, ann_completed, current_index
 
     else:
-        gr.Warning("Please insert a valid participant ID")
-    return participant_id, lets_go, total, previous_button, next_button, sentence_text, audio_player, emotions, confidence, comments, n_clicks, start, end, duration, ann_completed, current_index
-
+        raise gr.Error("Please insert a valid participant ID")
+    
 def count_clicks(n_clicks):
     n_clicks = gr.Number(n_clicks + 1, visible = False)
 
@@ -441,13 +437,16 @@ with (gr.Blocks(theme=gr.themes.Soft(), css = css) as demo):
         
     
     with gr.Tab("Annotation Interface"):
-        ann_completed = gr.Number(0, visible=False)
-        total = gr.Number(0, visible=False)
-        current_index = gr.Number(0, visible = False)
-        start = gr.Number(0, visible = False)
-        end = gr.Number(0, visible = False)
-        duration = gr.Number(0, visible = False)
-        n_clicks = gr.Number(0, visible = False)
+        ann_completed = gr.State(0)
+        total = gr.State(0)
+        current_index = gr.State(0)
+        start = gr.State(0)
+        end = gr.State(0)
+        duration = gr.State(0)
+        n_clicks = gr.State(0)
+        annotations = gr.State(pd.DataFrame())
+        file_list = gr.State(pd.DataFrame())
+
 
         # Row with progress bar
         
@@ -487,18 +486,18 @@ with (gr.Blocks(theme=gr.themes.Soft(), css = css) as demo):
         # Go back
         previous_button.click(
             previous_example,
-            inputs=[emotions, confidence, comments, n_clicks, participant_id,  ann_completed, current_index],
-            outputs=[sentence_text, audio_player, emotions, confidence, comments, n_clicks, start, end, duration, ann_completed, current_index],).then(None, [], [start, end, duration, current_index,ann_completed, total], js = js_progress_bar)
+            inputs=[annotations, file_list, emotions, confidence, comments, n_clicks, participant_id,  ann_completed, current_index],
+            outputs=[annotations, sentence_text, audio_player, emotions, confidence, comments, n_clicks, start, end, duration, ann_completed, current_index],).then(None, [], [start, end, duration, current_index,ann_completed, total], js = js_progress_bar)
 
         # Go to the next example
         next_button.click(
             next_example,
-            inputs=[emotions, confidence, comments, n_clicks, participant_id, ann_completed, current_index],
-            outputs=[sentence_text, audio_player, emotions, confidence, comments, n_clicks, start, end, duration, ann_completed, current_index],).then(None, [], [start, end, duration, current_index,ann_completed, total], js = js_progress_bar)
+            inputs=[annotations, file_list,emotions, confidence, comments, n_clicks, participant_id, ann_completed, current_index],
+            outputs=[annotations,sentence_text, audio_player, emotions, confidence, comments, n_clicks, start, end, duration, ann_completed, current_index],).then(None, [], [start, end, duration, current_index,ann_completed, total], js = js_progress_bar)
         
         buttons = [previous_button, next_button]
         data = [sentence_text, audio_player, emotions, confidence, comments]
-        lets_go.click(deactivate_participant_id, [participant_id, lets_go, total, *buttons, *data, n_clicks, ann_completed, current_index], [participant_id, lets_go, total, *buttons, *data, n_clicks, start, end, duration, ann_completed, current_index]).then( None, [], [start, end, duration, current_index, ann_completed, total], js = js_progress_bar)
+        lets_go.click(deactivate_participant_id, [annotations, file_list,  total, participant_id, lets_go, *buttons, *data, n_clicks, ann_completed, current_index], [annotations, file_list, participant_id, lets_go, total, *buttons, *data, n_clicks, start, end, duration, ann_completed, current_index]).then( None, [], [start, end, duration, current_index, ann_completed, total], js = js_progress_bar)
         audio_player.play(count_clicks, [n_clicks], [n_clicks])
 
         sidebar.collapse(None, [], [start, end, duration, current_index,ann_completed, total], js = js_progress_bar)