annotate scripts/comment_parser.py @ 1946:1d08f8aee098

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