diff --git a/utils/organiser.py b/utils/organiser.py index 0c14741..1ee6edf 100644 --- a/utils/organiser.py +++ b/utils/organiser.py @@ -1,23 +1,21 @@ import os, shutil, re from collections import defaultdict - from utils.extractor import extract_file_to_dir from utils.settings import BAD_DIR_NAME, MULTIPLE_DIR_NAME, BB_GRADEBOOKS_DIR, IGNORE_DIRS, TRACKED_FILE_EXT -def parse_filename(filename: str): +def _parse_filename(file_path: str) -> tuple[str, str] | None: """Extract STUDENTNUMBER and DATETIME from the filename.""" pattern = r'^(.*?)_(\d+)_attempt_(\d{4}-\d{2}-\d{2}-\d{2}-\d{2}-\d{2})(?:_.*)?(?:\..+)?$' - match = re.match(pattern, filename) + match = re.match(pattern, file_path) if match: return match.group(2), match.group(3) # STUDENTNUMBER, DATETIME return None, None -def filter_latest_submissions(directory: str): +def _filter_multiple_attempts(directory: str) -> None: """Keep only the latest attempt for each student and move older attempts to MULTIPLE_DIR_NAME.""" submissions = defaultdict(list) - # ensure MULTIPLE_DIR_NAME folder exists multiple_folder = os.path.join(directory, MULTIPLE_DIR_NAME) os.makedirs(multiple_folder, exist_ok=True) @@ -25,7 +23,7 @@ def filter_latest_submissions(directory: str): for filename in os.listdir(directory): filepath = os.path.join(directory, filename) if os.path.isfile(filepath): - student_number, timestamp = parse_filename(filename) + student_number, timestamp = _parse_filename(filename) if student_number and timestamp: submissions[student_number].append((timestamp, filepath)) @@ -39,11 +37,11 @@ def filter_latest_submissions(directory: str): if timestamp != latest_timestamp: shutil.move(filepath, os.path.join(multiple_folder, os.path.basename(filepath))) - print(f"Filtering complete. Older submissions moved to folder {MULTIPLE_DIR_NAME}") + print(f"\n[Info] Multiple submission attempts filtering completed.\nOlder submissions moved to folder: {MULTIPLE_DIR_NAME}") -def validate_gradebook_dir_name(src_dir: str) -> None: +def _validate_gradebook_dir_name(src_dir: str) -> None: if not os.path.isdir(src_dir): # check if it exists and is a directory - print(f'\n[Error] Incorrect directory: {src_dir}\n[Info] Make sure the directory exists in "{BB_GRADEBOOKS_DIR}"') + print(f'\n[ERROR] Incorrect directory: {src_dir}\n[Info] Make sure the directory exists in "{BB_GRADEBOOKS_DIR}"') exit() if not os.listdir(src_dir): # check if there are any files in the directory print(f'\n[Info] No files found in this gradebook - nothing to organise') @@ -52,7 +50,7 @@ def validate_gradebook_dir_name(src_dir: str) -> None: print(f'\n[Info] Gradebook has only invalid compressed files in: {os.path.join(src_dir, BAD_DIR_NAME)}\n[Info] Nothing to organise') exit() -def get_comment_from_submission_txt(file_path: str) -> tuple[str, str] | None: +def _get_comment_from_submission_txt(file_path: str) -> tuple[str, str] | None: no_comment_regex = f'Comments:\nThere are no student comments for this assignment.' no_comment_pattern = re.compile(no_comment_regex) @@ -71,7 +69,7 @@ def get_comment_from_submission_txt(file_path: str) -> tuple[str, str] | None: return comment, name return None, None -def get_comment_from_submission_txt_BB_ultra(file_path: str) -> tuple[str, str] | None: +def _get_comment_from_submission_txt_BB_ultra(file_path: str) -> tuple[str, str] | None: with open(file_path, encoding='utf-8') as f: file_contents = f.read() @@ -98,8 +96,7 @@ def get_comment_from_submission_txt_BB_ultra(file_path: str) -> tuple[str, str] return cleaned_text.strip(), name # comment, name - -def get_gradebook_stats(src_dir: str) -> dict[str, int]: +def _get_gradebook_stats(src_dir: str) -> dict[str, int]: all_files = [ os.path.join(src_dir, f) for f in os.listdir(src_dir) if BAD_DIR_NAME not in f and MULTIPLE_DIR_NAME not in f ] dirs = [ f for f in all_files if os.path.isdir(f) and BAD_DIR_NAME not in f and MULTIPLE_DIR_NAME not in f ] normal_files = [ f for f in all_files if os.path.isfile(f) ] @@ -122,7 +119,7 @@ def get_gradebook_stats(src_dir: str) -> dict[str, int]: print(msg, flush=True) return files_counter -def organise_file_per_student(src_dir: str, dest_dir: str, file_name: str, student_no: str) -> None: +def _organise_file_per_student(src_dir: str, dest_dir: str, file_name: str, student_no: str) -> None: student_dir = os.path.join(dest_dir, student_no) os.makedirs(student_dir, exist_ok=True) # create student directory if it doesn't exist file_path = os.path.join(src_dir, file_name) @@ -135,7 +132,7 @@ def organise_file_per_student(src_dir: str, dest_dir: str, file_name: str, stude os.remove(file_path) # delete compressed file after successful extraction else: if file_path_lowercase.endswith('.txt'): - comment, name = get_comment_from_submission_txt_BB_ultra(file_path) # get student comment (if any), and name, from submission txt file + comment, name = _get_comment_from_submission_txt_BB_ultra(file_path) # get student comment (if any), and name, from submission txt file if comment and name: comments_filename = f'{dest_dir}_comments.txt' with open(comments_filename, 'a') as f: @@ -153,11 +150,11 @@ def organise_gradebook(src_dir: str, dest_dir: str) -> None: 2) organises all other files in gradebook into directories per student number 3) checks if there are any comments in submission text files and extracts them into a file """ - validate_gradebook_dir_name(src_dir) # check if dir exists, and has files in it - exits if not + _validate_gradebook_dir_name(src_dir) # check if dir exists, and has files in it - exits if not os.makedirs(dest_dir, exist_ok=True) # create the destination directory if it doesn't exist - filter_latest_submissions(src_dir) + _filter_multiple_attempts(src_dir) print('\nGetting gradebook stats...', flush=True) - files_counter = get_gradebook_stats(src_dir) # print stats about the files in gradebook and get files_counter dict to use later + files_counter = _get_gradebook_stats(src_dir) # print stats about the files in gradebook and get files_counter dict to use later students_numbers: list[str] = [] # list to add and count unique student numbers from all files in gradebook print('\nStart organising... (this may take a while depending on the number -and size- of submissions)\n', flush=True) @@ -165,7 +162,7 @@ def organise_gradebook(src_dir: str, dest_dir: str) -> None: if BAD_DIR_NAME not in file_name and MULTIPLE_DIR_NAME not in file_name: # ignore dirs BAD_DIR_NAME (created after first run if corrupt compressed files found) and MULTIPLE_DIR_NAME (dir with older attempts) student_no = file_name.split('_attempt_', 1)[0].split('_')[-1] # get student number from file name !! pattern might need adjusting if file name format from blackboard changes !! students_numbers.append(student_no) - organise_file_per_student(src_dir, dest_dir, file_name, student_no) + _organise_file_per_student(src_dir, dest_dir, file_name, student_no) ignored_str = ', '.join(IGNORE_DIRS) print(f'[Info] Skipped extracting files in dirs with name that includes any of the following strings: {ignored_str}\n', flush=True) @@ -177,7 +174,7 @@ def organise_gradebook(src_dir: str, dest_dir: str) -> None: else: print(f'[Info] Comments in file: {dest_dir}_comments.txt\n', flush=True) - print(f'[Note] Compressed files (.zip, .rar, .7z) are automatically deleted from the gradebook directory after successful extraction\n', flush=True) + print(f'[Info] Compressed files (.zip, .rar, .7z) are automatically deleted from the gradebook directory after successful extraction\n', flush=True) def check_submissions_dir_for_compressed(submissions_dir: str) -> None: """checks if any submitted compressed files contain more compressed files inside (they are not recursively extracted) @@ -194,5 +191,5 @@ def check_submissions_dir_for_compressed(submissions_dir: str) -> None: if compressed_files: compressed_files_str = '\n'.join(compressed_files) print(f'\n[Warning] One or more compressed files found in the extracted and organised submission files ({len(compressed_files)} found in total)') - print('\nSee below the organised per student compressed files, and extract them manually if necessary:\n') + print('\n[Info] See below the list of compressed files, organised per student, and extract them manually if necessary:\n') print(compressed_files_str)