annotate scripts/comment_parser.py @ 1482:81e2a7162d18

Addition of HULTI-GEN interfaces to WAC paper.
author Dave <djmoffat@users.noreply.github.com>
date Wed, 23 Sep 2015 09:13:38 +0100
parents 8be2d08fbe15
children 1b6fa37d46a4 235594325b84 b5bf2f57187c
rev   line source
b@1481 1 #!/usr/bin/python
b@1481 2 # -*- coding: utf-8 -*-
b@1481 3
b@1481 4 import xml.etree.ElementTree as ET
b@1481 5 import os
b@1481 6 import csv
b@1481 7 import sys
b@1481 8
b@1481 9 # COMMAND LINE ARGUMENTS
b@1481 10
b@1481 11 assert len(sys.argv)<3, "comment_parser takes at most 1 command line argument\n"+\
b@1481 12 "Use: python score_parser.py [rating_folder_location]"
b@1481 13
b@1481 14 # XML results files location
b@1481 15 if len(sys.argv) == 1:
b@1481 16 folder_name = "../saves" # Looks in 'saves/' folder from 'scripts/' folder
b@1481 17 print "Use: python comment_parser.py [XML_files_location]"
b@1481 18 print "Using default path: " + folder_name
b@1481 19 elif len(sys.argv) == 2:
b@1481 20 folder_name = sys.argv[1] # First command line argument is folder
b@1481 21
b@1481 22 # check if folder_name exists
b@1481 23 if not os.path.exists(folder_name):
b@1481 24 #the file is not there
b@1481 25 print "Folder '"+folder_name+"' does not exist."
b@1481 26 sys.exit() # terminate script execution
b@1481 27 elif not os.access(os.path.dirname(folder_name), os.W_OK):
b@1481 28 #the file does exist but write privileges are not given
b@1481 29 print "No write privileges in folder '"+folder_name+"'."
b@1481 30
b@1481 31
b@1481 32 # CODE
b@1481 33
b@1481 34 # remember which files have been opened this time
b@1481 35 file_history = []
b@1481 36
b@1481 37 # get every XML file in folder
b@1481 38 for file in os.listdir(folder_name):
b@1481 39 if file.endswith(".xml"):
b@1481 40 tree = ET.parse(folder_name + '/' + file)
b@1481 41 root = tree.getroot()
b@1481 42
b@1481 43 # get list of all page names
b@1481 44 for audioholder in root.findall("./audioholder"): # iterate over pages
b@1481 45 page_name = audioholder.get('id') # get page name
b@1481 46
b@1481 47 if page_name is None: # ignore 'empty' audio_holders
b@1481 48 print "WARNING: " + file + " contains empty audio holder. (comment_parser.py)"
b@1481 49 break
b@1481 50
b@1481 51 # create folder [page_name] if not yet created
b@1481 52 if not os.path.exists(folder_name + "/" + page_name):
b@1481 53 os.makedirs(folder_name + "/" + page_name)
b@1481 54
b@1481 55 # for page [page_name], print comments related to fragment [id]
b@1481 56 for audioelement in audioholder.findall("./audioelement"):
b@1481 57 if audioelement is not None: # Check it exists
b@1481 58 audio_id = str(audioelement.get('id'))
b@1481 59
b@1481 60 csv_name = folder_name +'/' + page_name+'/'+page_name+'-comments-'+audio_id+'.csv'
b@1481 61
b@1481 62 # If file hasn't been opened yet this time, empty
b@1481 63 if csv_name not in file_history:
b@1481 64 csvfile = open(csv_name, 'w')
b@1481 65 file_history.append(csv_name) # remember this file has been written to this time around
b@1481 66 else:
b@1481 67 # append (!) to file [page_name]/[page_name]-comments-[id].csv
b@1481 68 csvfile = open(csv_name, 'a')
b@1481 69 writer = csv.writer(csvfile,
b@1481 70 delimiter=',',
b@1481 71 dialect="excel",
b@1481 72 quoting=csv.QUOTE_ALL)
b@1481 73 commentstr = audioelement.find("./comment/response").text
b@1481 74
b@1481 75 if commentstr is None:
b@1481 76 commentstr = ''
b@1481 77
b@1481 78 # anonymous comments:
b@1481 79 #writer.writerow([commentstr.encode("utf-8")])
b@1481 80 # comments with (file) name:
b@1481 81 writer.writerow([file[:-4]] + [commentstr.encode("utf-8")])
b@1481 82
b@1481 83 #TODO Replace 'new line' in comment with something else?
b@1481 84
b@1481 85 # PRO TIP: Change from csv to txt by running this in bash:
b@1481 86 # $ cd folder_where_csvs_are/
b@1481 87 # $ for i in *.csv; do mv "$i" "${i/.csv}".txt; done