Reports - user usefullness

sitescripts/reports/bin/parseNewReports.py

 # coding: utf-8
 
 # This Source Code is subject to the terms of the Mozilla Public License
 # version 2.0 (the "License"). You can obtain a copy of the License at
 # http://mozilla.org/MPL/2.0/.
 
 import os, sys, re, marshal, codecs
 from urlparse import urlparse
 from time import time
 from xml.parsers.expat import ParserCreate, ExpatError, ErrorString
@@ skipping 49 matching lines @@
   executeQuery(cursor,
               '''SELECT guid FROM #PFX#reports WHERE guid = %s''',
               (guid))
   report = cursor.fetchone()
 
   if report != None:
     os.remove(xmlFile)
     return
 
   source = open(xmlFile, 'rb')
-  reportData = {'status': '', 'utility': 0, 'warnings': {}, 'requests': [], 'filters': [], 'subscriptions': [], 'extensions': [], 'errors': [], 'time': time()}

[Wladimir Palant, 2012/10/18 15:41:24]

How about replacing "utility" by "helpfulness"?

[Andrey Novikov, 2012/10/18 15:51:29]

It's synonym and it's shorter, that's why I have chosen it.

[Wladimir Palant, 2012/10/19 10:26:06]

I don't think that "utility" is a synonym for "helpfulness" - only roughly and
in one of a dozen possible meanings. It's very non-obvious what you mean by it.
You should use a better term, regardless of length.

+  reportData = {'status': '', 'usefulness': 0, 'warnings': {}, 'requests': [], 'filters': [], 'subscriptions': [], 'extensions': [], 'errors': [], 'time': time()}
   tagStack = []
 
   parser = ParserCreate()
   parser.StartElementHandler = processElementStart
   parser.EndElementHandler = processElementEnd
   parser.CharacterDataHandler = processText
   try:
     parser.ParseFile(source)
   except ExpatError, error:
     reportData['warnings']['!parsing'] = 'Parsing error in the report: %s at line %i column %i' % (ErrorString(error.code), error.lineno, error.offset)
@@ skipping 181 matching lines @@
             reportData['warnings'][itemPath] = 'Field %s exceeded length limit and was truncated' % itemPath
     elif isinstance(data[key], basestring):
       limit = lengthRestrictions.get(keyPath, lengthRestrictions['default_string'])
       if len(data[key]) > limit:
         data[key] = data[key][0:limit] + u'…'
         reportData['warnings'][keyPath] = 'Field %s exceeded length limit and was truncated' % keyPath
 
 if __name__ == '__main__':
   setupStderr()
   scanReports(get_config().get('reports', 'dataPath'))