annotate scripts/comment_parser.py @ 1089:3de455e48d70

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