source: CCCC/trunk/ceda_cc/utils_c4.py @ 343

Subversion URL: http://proj.badc.rl.ac.uk/svn/exarch/CCCC/trunk/ceda_cc/utils_c4.py@343
Revision 343, 50.5 KB checked in by mjuckes, 6 years ago (diff)

cleared rogue print statement

Line 
1"""A set of classes running checks and providing utilities to support checks"""
2import string, re, os, sys, traceback, ctypes
3
4def strmm3( mm ):
5  return string.join( map( lambda x: '%s="%s" [correct: "%s"]' % x, mm ), '; ' )
6
7from fcc_utils import mipTableScan
8from xceptions import *
9
10class timeInt(object):
11
12   vc = {'gregorian':0, 'standard':0, 'proleptic_gregorian':0, 'noleap':1, '365_day':1, 'all_leap':2, '366_day':2, '360_day':3, 'julian':0, 'none':None}
13   mnmx = [ (365,366),(365,365),(366,366),(360,360) ]
14   mmnmmx = [ (28,31),(28,31),(29,31),(30,30) ]
15   def __init__(self,cal='proleptic_gregorian',dpymn=None, dpymx=None,dpmmn=None,dpmmx=None,tol=1.e-6):
16     self.tol = tol
17     if not self.vc.has_key(cal) or cal == None:
18       assert dpymx != None and dpymn != None, 'If standard calendar is not use, dpymn and dpymx must be set'
19       assert dpmmx != None and dpmmn != None, 'If standard calendar is not use, dpmmn and dpmmx must be set'
20       self.dpymn = dpymn - tol
21       self.dpymx = dpymx + tol
22       self.dpmmn = dpmmn - tol
23       self.dpmmx = dpmmx + tol
24     else:
25       self.dpymn = self.mnmx[self.vc[cal]][0] - tol
26       self.dpymx = self.mnmx[self.vc[cal]][1] + tol
27       self.dpmmn = self.mmnmmx[self.vc[cal]][0] - tol
28       self.dpmmx = self.mmnmmx[self.vc[cal]][1] + tol
29     self.map = { 'yr':'P1Y','monClim':'P1M','mon':'P1M','day':'P1D','6hr':'P6H','3hr':'P3H'}
30     self.nd = { 'x':'y' }
31
32   def setUnit(self,u):
33     if u not in ['days','months','years']:
34         print  'Time unit %s not supported' % u
35         self.u = None
36     else:
37         self.u = u
38
39   def chk(self,v,u,f):
40      if not self.map.has_key(f):
41         return (0,'No frequency check available for f = %s' % f )
42      if u not in ['days']:
43         return (0,'No frequency check available for units = %s' % u )
44      x = self.map(f)
45      if x == 'P1Y':
46        return (v > self.dpymn) and (v < self.dpymx)
47      elif x == 'P1M':
48        return (v > self.dpmmn) and (v < self.dpmmx)
49      elif x == 'P1D':
50        return (v > 1.-self.tol) and (v < 1.+self.tol)
51      elif x == 'P6H':
52        return (v > 0.25-self.tol) and (v < 0.25+self.tol)
53      elif x == 'P3H':
54        return (v > 0.125-self.tol) and (v < 0.125+self.tol)
55     
56
57class reportSection(object):
58
59  def __init__(self,id,cls,parent=None, description=None):
60    self.id = id
61    self.cls = cls
62    self.parent = parent
63    self.description = description
64    self.records = []
65    self.subsections = []
66    self.closed = False
67    self.npass = 0
68    self.fail = 0
69    self.auditDone = True
70
71  def addSubSection( self, id, cls, description=None):
72    assert not self.closed, 'Attempt to add sub-section to closed report section'
73    self.subsections.append( reportSection(id, cls, parent=self, description=description )  )
74    self.auditDone = False
75    return self.subsections[-1]
76
77  def addRecord( self, id, cls, res, msg ):
78    assert not self.closed, 'Attempt to add record to closed report section'
79    self.records.append( (id, cls, res, msg) )
80    self.auditDone = False
81
82  def close(self):
83    self.closed = True
84
85  def reopen(self):
86    self.closed = False
87
88  def audit(self):
89    if self.auditDone:
90      return
91    self.closed = True
92    self.fail = 0
93    self.npass = 0
94    for ss in self.subsections:
95      ss.audit()
96      self.fail += ss.fail
97      self.npass += ss.npass
98
99    for r in self.records:
100      if r[2]:
101        self.npass += 1
102      else:
103        self.fail += 1
104
105class checkSeq(object):
106  def __init__(self):
107    pass
108
109  def check(self,x):
110    d = map( lambda i: x[i+1] - x[i], range(len(x)-1) )
111    self.delt = sum(d)/len(d)
112    self.dmx = max(d)
113    self.dmn = min(d)
114    return self.dmx - self.dmn < abs(self.delt)*1.e-4
115
116cs = checkSeq()
117
118class checkBase(object):
119  """Base class for checks, containing a set of standard methods for managing operation of checks and logging of results"""
120
121  def  __init__(self,cls="CORDEX",reportPass=True,parent=None,monitor=None):
122    """Creat class instance: set defaults, link arguments to instance, create a range of compiled regular expressions"""
123    self.cls = cls
124    self.project = cls
125    self.abortMessageCount = parent.abortMessageCount
126    self.monitor = monitor
127    self.re_isInt = re.compile( '[0-9]+' )
128    self.errorCount = 0
129    self.passCount = 0
130    self.missingValue = 1.e20
131    self.missingValue = ctypes.c_float(1.00000002004e+20).value
132    from file_utils import ncLib
133    if ncLib == 'netCDF4':
134      import numpy
135      self.missingValue = numpy.float32(self.missingValue)
136    self.parent = parent
137    self.reportPass=reportPass
138    self.pcfg = parent.pcfg
139################################
140    self.requiredGlobalAttributes = self.pcfg.requiredGlobalAttributes
141    self.controlledGlobalAttributes = self.pcfg.controlledGlobalAttributes
142    self.globalAttributesInFn = self.pcfg.globalAttributesInFn
143    self.requiredVarAttributes = self.pcfg.requiredVarAttributes
144    self.drsMappings = self.pcfg.drsMappings
145#######################################
146    self.checks = ()
147    self.messageCount = 0
148    self.init()
149    if not hasattr( self.parent, 'amapListDraft' ):
150      self.parent.amapListDraft = []
151
152  def isInt(self,x):
153    """Check that a string is a representation of an integer"""
154    return self.re_isInt.match( x ) != None
155
156  def logMessage(self, msg, error=False ):
157    """Log messages and count messages"""
158    self.messageCount += 1
159    assert self.abortMessageCount < 0 or self.abortMessageCount > self.messageCount, 'Raising error [TESTX01], perhaps for testing'
160    if self.parent != None and self.parent.log != None:
161       if error:
162         self.parent.log.error( msg )
163       else:
164         self.parent.log.info( msg )
165    else:
166       print msg
167
168    doThis = True
169    if self.appendLogfile[0] != None and doThis:
170      if self.monitor != None:
171         nofh0 = self.monitor.get_open_fds()
172      xlog = self.c4i.getFileLog( self.appendLogfile[1], flf=self.appendLogfile[0] )
173      if error:
174         xlog.error( msg )
175      else:
176         xlog.info( msg )
177      self.c4i.closeFileLog()
178      if self.monitor != None:
179         nofh9 = self.monitor.get_open_fds()
180         if nofh9 > nofh0:
181           print 'Leaking file handles [1]: %s --- %s' % (nofh0, nofh9)
182
183  def log_exception( self, msg):
184    """Logging of exceptions -- putting trace information in log files"""
185    if self.parent != None and self.parent.log != None:
186        self.parent.log.error("Exception has occured" ,exc_info=1)
187    else:
188        traceback.print_exc(file=sys.stdout)
189
190  def log_error( self, msg ):
191    """Create an error log message and call logMessage; count errors;"""
192    self.lastError = msg
193    self.errorCount += 1
194    self.logMessage( '%s.%s: FAILED:: %s' % (self.id,self.getCheckId(),msg), error=True )
195
196  def log_pass( self ):
197    """Create a pass log message and call logMessage; count passes;"""
198    self.passCount = True
199    if self.reportPass:
200      self.logMessage(  '%s.%s: OK' % (self.id,self.getCheckId()) )
201
202  def log_abort( self ):
203    self.completed = False
204    self.logMessage(   '%s.%s: ABORTED:: Errors too severe to complete further checks in this module' % (self.id,'xxx') )
205    raise abortChecks
206
207  def status(self):
208    return '%s.%s' % (self.id,self.getCheckId())
209
210  def getCheckId(self,full=True):
211    if type( self.checkId ) == type( 'x' ):
212      return self.checkId
213    else:
214      if full:
215        return '%s: [%s]' % self.checkId
216      else:
217        return self.checkId[0]
218
219  def test(self,res,msg,abort=False,part=False,appendLogfile=(None,None)):
220    """Handle test results.
221      :param res: [True/False] result of test;
222      :param msg: Message describing the test;
223      :param abort: {optional} Set True if checks should be aborted when test fails;
224      :param part: {optional} Set True if this is a component of a test (logging of pass suppressed);
225      :param appendLogfile: {optional} Allows results to be appended to pre-existing log file;
226    """
227    self.appendLogfile = appendLogfile
228    if res:
229      if not part:
230         self.log_pass()
231    else:
232      self.log_error(msg)
233      if abort:
234        self.log_abort()
235    return res
236
237  def runChecks(self):
238    """Run all the checks registered in this instance (in self.checks) and handle exceptions"""
239
240    try:
241      for c in self.checks:
242        c()  # run check
243      self.completed = True
244    except abortChecks:
245      ## error logging done before raising this exception
246      return
247    except:
248      self.log_exception( 'Exception caught by runChecks' )
249      raise loggedException
250   
251class checkFileName(checkBase):
252  """Check basic syntax of file names (i.e. checks properties of the text string, it does not attempt to access the file).
253Inherits :class:`checkBase` class. Checks are run by the :meth:`check` method."""
254
255  def init(self):
256    self.id = 'C4.001'
257    self.checkId = 'unset'
258    self.isFixed = False
259    self.step = 'Initialised'
260    self.checks = (self.do_check_fn,self.do_check_fnextra)
261    self.re_c1 = re.compile( '^[0-9]*$' )
262    self.fnDict = {}
263####
264
265  def check(self,fn):
266    """Initiate checks: manage arguments and then call *runChecks* (inherited from checkBase class).
267  Arguments: fn: file name: the file name to be checked."""
268    self.errorCount = 0
269    assert type(fn) in [type('x'),type(u'x')], '1st argument to "check" method of checkGrids shound be a string variable name (not %s)' % type(fn)
270    self.fn = fn
271    self.fnsep = self.pcfg.fNameSep
272
273    self.runChecks()
274    self.parent.fnDict = self.fnDict
275###
276  def do_check_fn(self):
277    """Basic file name checks:
278       (1) Check suffix;
279       (1b) [for ESA-CCI files] check presence of "ESACCI" and identify file naming convention;
280       (2) Split file name into components and check number of such components;
281       (3) Additional specialist checks for ESA-CCI, CORDEX, CMIP-type (for the time range).
282    """
283    fn = self.fn
284    self.errorCount = 0
285    self.completed = False
286
287## check basic parsing of file name
288    self.checkId = ('001','parse_filename')
289    self.test( fn[-3:] == '.nc', 'File name ending ".nc" expected', abort=True, part=True )
290    bits = string.split( fn[:-3], self.fnsep )
291
292    self.fnParts = bits[:]
293    if self.pcfg.domainIndex != None:
294      self.domain = self.fnParts[self.pcfg.domainIndex]
295    else:
296      self.domain = None
297
298
299    if self.pcfg.projectV.id in ['ESA-CCI']:
300      self.test( 'ESACCI' in bits[:2] or 'ESA' == bits[0], 'File name not a valid ESA-CCI file name: %s' % fn, abort=True )
301      if bits[0] == 'ESA':
302        self.esaFnId = 2
303      elif bits[0] == 'ESACCI':
304        self.esaFnId = 1
305      else:
306        self.esaFnId = 0
307        bb = string.split( bits[2], '_' )
308        self.test( bits[2][0] == 'L' and len(bb) == 2, 'Cannot parse ESA-CCI file name: %s' % fn, abort=True )
309        bits = bits[:2] + bb + bits[3:]
310        self.fnParts = bits[:]
311       
312      self.pcfg.setEsaCciFNType(self.esaFnId)
313    self.test( len(bits) in self.pcfg.fnPartsOkLen, 'File name not parsed in %s elements [%s]' % (str(self.pcfg.fnPartsOkLen),str(bits)), abort=True )
314
315    self.fnDict = {}
316    if self.pcfg.projectV.id in ['ESA-CCI']:
317      l0 = {0:6, 1:5, 2:5}[self.esaFnId] 
318      for i in range(l0):
319        x = self.pcfg.globalAttributesInFn[i]
320        if x != None and x[0] == '*':
321          self.fnDict[x[1:]] = bits[i]
322      self.fnDict['version'] = bits[-1]
323      self.fnDict['gdsv'] = 'na'
324      if self.esaFnId == 0:
325        if len(bits) == 9:
326          self.fnDict['additional'] = bits[-3]
327          self.fnDict['gdsv'] = bits[-2]
328        elif len(bits) == 8:
329          if bits[-2][0] == 'v':
330            self.fnDict['gdsv'] = bits[-2]
331          else:
332            self.fnDict['additional'] = bits[-2]
333      elif self.esaFnId in [1,2]:
334        if len(bits) == 8:
335          self.fnDict['additional'] = bits[-3]
336
337         
338   
339    if self.pcfg.groupIndex != None:
340      self.group = self.fnParts[self.pcfg.groupIndex]
341    else:
342      self.group = None
343
344    if self.pcfg.freqIndex != None:
345      self.freq = self.fnParts[self.pcfg.freqIndex]
346    elif self.group in ['fx','fixed']:
347      self.freq = 'fx'
348    else:
349      self.freq = None
350
351    ##if self.cls == 'CORDEX':
352      ##self.freq = self.fnParts[7]
353    ##elif self.cls == 'SPECS':
354      ##self.freq = self.fnParts[1]
355
356    self.var = self.fnParts[self.pcfg.varIndex]
357    if self.pcfg.projectV.id in ['ESA-CCI']:
358      if  self.fnDict['project'] == 'GlobSnow':
359        if self.fnDict['additional'] == 'weekly':
360          self.var += 'weekly'
361
362    if self.pcfg.fnvdict != None:
363      if self.pcfg.fnvdict.has_key( self.var ):
364        self.var = self.pcfg.fnvdict.get( self.var )['v']
365
366    self.isFixed = self.freq in ['fx','fixed']
367    self.parent.fileIsFixed = True
368    if self.isFixed:
369      self.test( len(self.fnParts) in self.pcfg.fnPartsOkFixedLen, 'Number of file name elements not acceptable for fixed data' )
370
371    self.checkId = ('002','parse_filename_timerange')
372    if not self.isFixed:
373
374## test time segment
375      if self.pcfg.trangeType == 'CMIP':
376        bits = string.split( self.fnParts[-1], '-' )
377        self.test( len(bits) == 2, 'File time segment [%s] will not parse into 2 elements' % (self.fnParts[-1] ), abort=True, part=True )
378
379        self.test(  len(bits[0]) == len(bits[1]), 'Start and end time specified in file name [%s] of unequal length' % (self.fnParts[-1] ), abort=True, part=True  )
380        self.test(  int(bits[0]) <= int(bits[1]), 'Start and end time specified in file name [%s] in wrong order' % (self.fnParts[-1] ), abort=True, part=True  )
381
382        for b in bits:
383          self.test( self.isInt(b), 'Time segment in filename [%s] contains non integer characters' % (self.fnParts[-1] ),  abort=True, part=True  )
384        self.log_pass()
385        self.fnTimeParts = bits[:]
386      elif self.pcfg.trangeType == 'ESA-CCI':
387        self.pcfg.checkTrangeLen = False
388        tt = self.fnParts[self.pcfg.trangeIndex] 
389        if self.test( len(tt) in [4,6,8,10,12,14] and self.re_c1.match(tt) != None, 'Length of indicative date/time not consistent with YYYY[MM[DD[HH[MM[SS]]]]] specification: %s' % self.fnParts[-1], part=True  ):
390          ll = [tt[:4],]
391          tt = tt[4:]
392          for j in range(5):
393            if len(tt) > 0:
394              ll.append( tt[:2] )
395              tt = tt[2:]
396            elif j in [1,2]:
397              ll.append( '01' )
398            else:
399              ll.append( '00' )
400          indDateTime = map( int, ll )
401          self.test( indDateTime[1] in range(1,13), 'Invalid Month in indicative date time %s' % str(ll), part=True )
402          self.test( indDateTime[2] in range(1,32), 'Invalid Day in indicative date time %s' % str(ll), part=True )
403          self.test( indDateTime[3] in range(25), 'Invalid hour in indicative date time %s' % str(ll), part=True )
404          self.test( indDateTime[4] in range(60), 'Invalid minute in indicative date time %s' % str(ll), part=True )
405          self.test( indDateTime[5] in range(60), 'Invalid second in indicative date time %s' % str(ll), part=True )
406
407    self.checkId = '003'
408
409    self.checkId, ok = (('004','filename_timerange_length'),True)
410    if (not self.isFixed) and self.pcfg.checkTrangeLen:
411      ltr = { 'mon':6, 'sem':6, 'day':8, '3hr':[10,12], '6hr':10 }
412      ok &=self.test( self.freq in ltr.keys(), 'Frequency [%s] not recognised' % self.freq, part=True )
413      if ok:
414        if type( ltr[self.freq] ) == type(0):
415          msg = 'Length of time range parts [%s,%s] not equal to required length [%s] for frequency %s' % (self.fnTimeParts[0],self.fnTimeParts[1],ltr[self.freq],self.freq)
416          ok &= self.test( len(self.fnTimeParts[0]) == ltr[self.freq], msg, part=True )
417        elif type( ltr[self.freq] ) in [type([]),type( () )]:
418          msg = 'Length of time range parts [%s,%s] not in acceptable list [%s] for frequency %s' % (self.fnTimeParts[0],self.fnTimeParts[1],str(ltr[self.freq]),self.freq)
419          ok &= self.test( len(self.fnTimeParts[0]) in ltr[self.freq], msg, part=True )
420
421      if ok:
422        self.log_pass()
423
424  def do_check_fnextra(self):
425    """Check whether file name components match constraints -- but only if those constraints are not implicitly verified through comparison with global attributes in later checks"""
426    self.checkId = ('004','file_name_extra' )
427    vocabs = self.pcfg.vocabs
428    m = []
429    for a in self.pcfg.controlledFnParts:
430      if self.fnDict.has_key(a):
431        try:
432          if not vocabs[a].check( str(self.fnDict[a]) ):
433            m.append( (a,self.fnDict[a],vocabs[a].note) )
434        except:
435          print 'failed trying to check file name component %s' % a
436          raise baseException( 'failed trying to check file name component %s' % a )
437
438    self.test( len(m)  == 0, 'File name components do not match constraints: %s' % str(m) )
439
440
441class checkGlobalAttributes(checkBase):
442  """Check global and variable attributes, using tables of valid values"""
443
444  def init(self):
445    self.id = 'C4.002'
446    self.checkId = 'unset'
447    self.step = 'Initialised'
448    self.checks = (self.do_check_ga,)
449    self.fileId = None
450
451  def check(self,globalAts, varAts,varName,varGroup, vocabs, fnParts):
452    self.errorCount = 0
453    assert type(varName) in [type('x'),type(u'x')], '1st argument to "check" method of checkGrids shound be a string variable name (not %s)' % type(varName)
454    self.var = varName
455    self.globalAts = globalAts
456    self.varAts = varAts
457    self.varGroup = varGroup
458    self.vocabs = vocabs
459    self.fnParts = fnParts
460    self.runChecks()
461
462  def getId(self):
463    if self.fileId == None:
464      self.fileId = '%s.%s' % (self.globalAts['naming_authority'],self.globalAts['id'])
465      if self.globalAts['naming_authority'] == 'uk.ac.pml':
466        i0 = string.find(self.globalAts['id'],'OC4v6_QAA')
467        if i0 != -1:
468          self.fileId = '%s.%s' % (self.globalAts['naming_authority'],self.globalAts['id'][:i0+9])
469
470  def getDrs( self ):
471    assert self.completed, 'method getDrs should not be called if checks have not been completed successfully'
472    ee = {}
473    drsDefaults = { 'convention_version':'n/a'}
474    if not self.globalAts.has_key('product'):
475        self.globalAts['product'] = 'output'
476    for k in self.drsMappings:
477      if self.drsMappings[k] == '@var':
478        ee[k] = self.var
479      elif self.drsMappings[k][0] == '=':
480        ee[k] = self.drsMappings[k][1:]
481      elif self.drsMappings[k] == '@ensemble':
482        ee[k] = "r%si%sp%s" % (self.globalAts["realization"],self.globalAts["initialization_method"],self.globalAts["physics_version"])
483      elif self.drsMappings[k] == '@forecast_reference_time':
484        x = self.globalAts.get("forecast_reference_time",'yyyy-mm-dd Thh:mm:ssZ' )
485        ee[k] = "%s%s%s" % (x[:4],x[5:7],x[8:10])
486      elif self.drsMappings[k] == '@mip_id':
487        ee[k] = string.split( self.globalAts["table_id"] )[1]
488      elif self.drsMappings[k] == '@ecv':
489        ee[k] = self.pcfg.ecvMappings[ self.parent.fnDict['project'] ]
490      elif self.drsMappings[k][0] == '$':
491        self.pcfg.getExtraAtts()
492        self.getId()
493        if string.find(self.drsMappings[k],':') != -1:
494          k2,dflt = string.split( self.drsMappings[k][1:],':')
495          ee[k] = self.pcfg.extraAtts[self.fileId].get( k2, dflt )
496        else:
497          ee[k] = self.pcfg.extraAtts[self.fileId][self.drsMappings[k][1:]]
498      elif self.drsMappings[k][0] == '*':
499        thisk = self.drsMappings[k][1:]
500        ee[k] = self.varAts[self.var][thisk]
501      elif self.drsMappings[k][0] == '#':
502        thisk = self.drsMappings[k][1:]
503        if drsDefaults.has_key( thisk ):
504          ee[k] = self.parent.fnDict.get(thisk, drsDefaults[thisk] )
505        else:
506          ee[k] = self.parent.fnDict[thisk]
507      else:
508        ee[k] = self.globalAts[ self.drsMappings[k] ]
509
510    for k in ['creation_date','tracking_id']:
511      if k in self.globalAts.keys():
512        ee[k] = self.globalAts[k]
513
514    return ee
515
516  def do_check_ga(self):
517    varName = self.var
518    globalAts = self.globalAts
519    varAts = self.varAts
520    varGroup = self.varGroup
521    vocabs = self.vocabs
522    fnParts = self.fnParts
523
524    self.completed = False
525    self.checkId = ('001','global_ncattribute_present')
526    m = []
527    for k in self.requiredGlobalAttributes:
528      if not globalAts.has_key(k):
529         m.append(k)
530         self.globalAts[k] = '__errorReported__'
531
532    if not self.test( len(m)  == 0, 'Required global attributes missing: %s' % str(m) ):
533      gaerr = True
534      for k in m:
535        self.parent.amapListDraft.append( '#@;%s=%s|%s=%s' % (k,'__absent__',k,'<insert attribute value and uncomment>') )
536
537    self.checkId = ('002','variable_in_group')
538
539    self.test( varAts.has_key( varName ), 'Expected variable [%s] not present' % varName, abort=True, part=True )
540    msg = 'Variable %s not in table %s' % (varName,varGroup)
541    self.test( vocabs['variable'].isInTable( varName, varGroup ), msg, abort=True, part=True )
542
543    if self.pcfg.checkVarType:
544      self.checkId = ('003','variable_type')
545
546      mipType = vocabs['variable'].getAttr( varName, varGroup, 'type' )
547      thisType = {'real':'float32', 'integer':'int32', 'float':'float32', 'double':'float64' }.get( mipType, mipType )
548      self.test( mipType == None or varAts[varName]['_type'] == thisType, 'Variable [%s/%s] not of type %s [%s]' % (varName,varGroup,str(thisType),varAts[varName]['_type']) )
549    else:
550      mipType = None
551
552    self.checkId = ('004','variable_ncattribute_present')
553    m = []
554    reqAts = self.requiredVarAttributes[:]
555    if (not self.parent.fileIsFixed) and self.pcfg.projectV.id in ['CORDEX']:
556      reqAts.append( 'cell_methods' )
557    for k in reqAts + vocabs['variable'].lists(varName, 'addRequiredAttributes'):
558      if not varAts[varName].has_key(k):
559         m.append(k)
560    if not self.test( len(m)  == 0, 'Required variable attributes missing: %s' % str(m) ):
561      vaerr = True
562      for k in m:
563        self.parent.amapListDraft.append( '#@var=%s;%s=%s|%s=%s' % (varName,k,'__absent__',k,'<insert attribute value and uncomment>') )
564        ## print self.parent.amapListDraft[-1]
565
566## need to insert a check that variable is present
567    self.checkId = ('005','variable_ncattribute_mipvalues')
568    ok = True
569    hm = varAts[varName].get( 'missing_value', None ) != None
570    hf = varAts[varName].has_key( '_FillValue' )
571    if hm or hf:
572      if self.pcfg.varTables=='CMIP':
573        ok &= self.test( hm, 'missing_value must be present if _FillValue is [%s]' % varName )
574        ok &= self.test( hf, '_FillValue must be present if missing_value is [%s]' % varName )
575      else:
576        ok = True
577      if mipType == 'real':
578        if varAts[varName].has_key( 'missing_value' ):
579           msg = 'Variable [%s] has incorrect attribute missing_value=%s [correct: %s]' % (varName,varAts[varName]['missing_value'],self.missingValue)
580### need to use ctypes here when using ncq3 to read files -- appears OK for other libraries.
581           ok &= self.test( ctypes.c_float(varAts[varName]['missing_value']).value == ctypes.c_float(self.missingValue).value, msg, part=True )
582        if varAts[varName].has_key( '_FillValue' ):
583           msg = 'Variable [%s] has incorrect attribute _FillValue=%s [correct: %s]' % (varName,varAts[varName]['_FillValue'],self.missingValue)
584           ok &= self.test( varAts[varName]['_FillValue'] == self.missingValue, msg, part=True )
585
586    mm = []
587   
588    if self.pcfg.varTables=='CMIP':
589      contAts = ['long_name', 'standard_name', 'units']
590      if not self.parent.fileIsFixed:
591      ##if varGroup not in ['fx','fixed']:
592        contAts.append( 'cell_methods' )
593    else:
594      contAts = ['standard_name']
595    hcm = varAts[varName].has_key( "cell_methods" )
596    for k in contAts + vocabs['variable'].lists(varName,'addControlledAttributes'):
597      targ = varAts[varName].get( k, 'Attribute not present' )
598      val = vocabs['variable'].getAttr( varName, varGroup, k )
599
600      if k == "cell_methods":
601        if val != None:
602          parenthesies1 = []
603          targ0 = targ[:]
604          while string.find( targ, '(' ) != -1:
605            i0 = targ.index( '(' )
606            i1 = targ.index( ')' )
607            parenthesies1.append( targ[i0:i1+1] )
608            targ = targ[:i0-1] + targ[i1+1:]
609          parenthesies2 = []
610          val0 = val[:]
611          while string.find( val, '(' ) != -1:
612            i0 = val.index( '(' )
613            i1 = val.index( ')' )
614            parenthesies2.append( val[i0:i1+1] )
615            val = val[:i0-1] + val[i1+1:]
616          for p in parenthesies2:
617            if p not in parenthesies1:
618              mm.append( (k,parenthesies1,p) )
619          if string.find( targ, val):
620             mm.append( (k,targ,val) )
621      elif targ != 'Attribute not present' and targ != val:
622        mm.append( (k,targ,val) )
623
624    ok &= self.test( len(mm)  == 0, 'Variable [%s] has incorrect attributes: %s' % (varName, strmm3(mm)), part=True )
625    if len( mm  ) != 0:
626      if self.parent.amapListDraft == None:
627        self.parent.amapListDraft = []
628      for m in mm:
629          if m[2] == None:
630            self.parent.amapListDraft.append( '## @var=%s;%s=%s|@delete=%s -- not supported yet' % (varName,m[0],m[1],m[0]) )
631          else:
632            self.parent.amapListDraft.append( '@var=%s;%s=%s|%s=%s' % (varName,m[0],m[1],m[0],m[2]) )
633
634    if ok:
635       self.log_pass()
636
637    if (not self.parent.fileIsFixed) and hcm:
638    ## if (varGroup not in ['fx','fixed']) and hcm:
639      self.isInstantaneous = string.find( varAts[varName]['cell_methods'], 'time: point' ) != -1
640    else:
641      self.isInstantaneous = True
642
643    self.checkId = ('006','global_ncattribute_cv' )
644    m = []
645    for a in self.controlledGlobalAttributes:
646      if globalAts.has_key(a):
647        try:
648          if not vocabs[a].check( str(globalAts[a]) ):
649            m.append( (a,globalAts[a],vocabs[a].note) )
650        except:
651          print 'failed trying to check global attribute %s' % a
652          raise baseException( 'failed trying to check global attribute %s' % a )
653
654    if not self.test( len(m)  == 0, 'Global attributes do not match constraints: %s' % str(m) ):
655      for t in m:
656        self.parent.amapListDraft.append( '#@;%s=%s|%s=%s' % (t[0],str(t[1]),t[0],'<insert attribute value and uncomment>' + str(t[2]) ) )
657
658    self.checkId = ('007','filename_filemetadata_consistency')
659    m = []
660    for i in range(len(self.globalAttributesInFn)):
661       gaif = self.globalAttributesInFn[i]
662       if gaif != None and gaif[0] != '*':
663         if gaif[-1] == ':':
664           bits = string.split(gaif,':')
665           gaif0 = gaif
666           gaif = bits[0]
667           ix = int(bits[1])
668         else:
669           ix = i
670
671         targVal = fnParts[ix]
672         if gaif[0] == "@":
673           if gaif[1:] == "mip_id":
674               bits = string.split( globalAts[ "table_id" ] ) 
675               if len( bits ) > 2 and bits[0] == "Table":
676                 thisVal = bits[1]
677               else:
678                 thisVal = globalAts[ "table_id" ]
679                 self.test( False, 'Global attribute table_id does not conform to CMOR pattern ["Table ......"]: %s' % thisVal, part=True)
680           elif gaif[1:] == "ensemble":
681               thisVal = "r%si%sp%s" % (globalAts["realization"],globalAts["initialization_method"],globalAts["physics_version"])
682## following mappings are depricated -- introduced for SPECS and withdrawn ---
683           elif gaif[1:] == "experiment_family":
684               thisVal = globalAts["experiment_id"][:-4]
685           elif gaif[1:] == "forecast_reference_time":
686               x = self.globalAts.get("forecast_reference_time",'yyyy-mm-dd Thh:mm:ssZ' )
687               thisVal = "S%s%s%s" % (x[:4],x[5:7],x[8:10])
688           elif gaif[1:] == "series":
689               thisVal = 'series%s' % globalAts["series"]
690           else:
691               assert False, "Not coded to deal with this configuration: globalAttributesInFn[%s]=%s" % (i,self.globalAttributesInFn[i])
692         
693         else:
694             thisVal = globalAts[gaif]
695
696         if thisVal not in [targVal,'__errorReported__']:
697             m.append( (i,self.globalAttributesInFn[i]) )
698
699    self.test( len(m)  == 0,'File name segments do not match corresponding global attributes: %s' % str(m) )
700
701    self.completed = True
702       
703class checkStandardDims(checkBase):
704  """Check the dimensions which are defined in the specifications"""
705
706  def init(self):
707    self.id = 'C4.003'
708    self.checkId = 'unset'
709    self.step = 'Initialised'
710    self.checks = (self.do_check,)
711    self.plevRequired = self.pcfg.plevRequired
712    self.plevValues = self.pcfg.plevValues
713    self.heightRequired = self.pcfg.heightRequired
714    self.heightValues = self.pcfg.heightValues
715    self.heightRange = self.pcfg.heightRange
716
717  def check(self,varName,varGroup, da, va, isInsta,vocabs):
718    self.errorCount = 0
719    assert type(varName) in [type('x'),type(u'x')], '1st argument to "check" method of checkGrids shound be a string variable name (not %s)' % type(varName)
720    self.var = varName
721    self.varGroup = varGroup
722    self.da = da
723    self.va = va
724    self.isInsta = isInsta
725    self.vocabs = vocabs
726    self.runChecks()
727
728  def do_check(self):
729    varName = self.var
730    varGroup = self.varGroup
731    da = self.da
732    va = self.va
733    isInsta = self.isInsta
734
735    self.errorCount = 0
736    self.completed = False
737    self.checkId = ('001','time_attributes')
738    self.calendar = 'None'
739    if not self.parent.fileIsFixed:
740    ## if varGroup not in ['fx','fixed']:
741      ok = True
742      self.test( 'time' in da.keys(), 'Time dimension not found' , abort=True, part=True )
743      if self.pcfg.varTables=='CMIP':
744        if not isInsta:
745          ok &= self.test(  da['time'].get( 'bounds', 'xxx' ) == 'time_bnds', 'Required bounds attribute not present or not correct value', part=True )
746
747## is time zone designator needed?
748        tunits = da['time'].get( 'units', 'xxx' )
749        if self.project  == 'CORDEX':
750          ok &= self.test( tunits in ["days since 1949-12-01 00:00:00Z", "days since 1949-12-01 00:00:00", "days since 1949-12-01"],
751               'Time units [%s] attribute not set correctly to "days since 1949-12-01 00:00:00Z"' % tunits, part=True )
752        else:
753          ok &= self.test( tunits[:10] == "days since", 'time units [%s] attribute not set correctly to "days since ....."' % tunits, part=True )
754
755        ok &= self.test(  da['time'].has_key( 'calendar' ), 'Time: required attribute calendar missing', part=True )
756
757        ok &= self.test( da['time']['_type'] in ["float64","double"], 'Time: data type not float64 [%s]' % da['time']['_type'], part=True )
758       
759        if ok:
760          self.log_pass()
761        self.calendar = da['time'].get( 'calendar', 'None' )
762
763    self.checkId = ('002','pressure_levels')
764    if varName in self.plevRequired:
765      ok = True
766      self.test( 'plev' in va.keys(), 'plev coordinate not found %s' % str(va.keys()), abort=True, part=True )
767
768      ok &= self.test( int( va['plev']['_data'][0] ) == self.plevValues[varName],  \
769                  'plev value [%s] does not match required [%s]' % (va['plev']['_data'],self.plevValues[varName] ), part=True )
770     
771      plevAtDict = {'standard_name':"air_pressure", \
772                    'long_name':"pressure", \
773                    'units':"Pa", \
774                    'positive':"down", \
775                    'axis':"Z" }
776
777      if varName in ['clh','clm','cll']:
778        plevAtDict['bounds']= "plev_bnds"
779
780      for k in plevAtDict.keys():
781        ok &= self.test( va['plev'].get( k, None ) == plevAtDict[k], 
782                     'plev attribute %s absent or wrong value (should be %s)' % (k,plevAtDict[k]), part=True )
783
784      if varName in ['clh','clm','cll']:
785         self.test( "plev_bnds" in va.keys(), 'plev_bnds variable not found %s' % str(va.keys()), abort=True, part=True )
786         mm = []
787         for k in plevAtDict.keys():
788            if k != 'bounds' and k in va['plev_bnds'].keys():
789               if va['plev_bnds'][k] != va['plev'][k]:
790                 mm.append(k)
791         ok &= self.test( len(mm) == 0, 'Attributes of plev_bnds do not match those of plev: %s' % str(mm), part=True )
792
793         bndsVals = {'clh':[44000, 0], 'clm':[68000, 44000], 'cll':[100000, 68000] }
794         res = self.test( len( va['plev_bnds']['_data'] ) == 2, 'plev_bnds array is of wrong length', part=True )
795         ok &= res
796         if res:
797            kk = 0
798            for i in [0,1]:
799               if int(va['plev_bnds']['_data'][i]) != bndsVals[varName][i]:
800                  kk+=1
801            ok &= self.test( kk == 0, 'plev_bnds values not correct: should be %s' % str(bndsVals[varName]), part=True )
802
803      if ok:
804        self.log_pass()
805
806    self.checkId = ('003','height_levels')
807    hreq = varName in self.heightRequired
808    if self.parent.experimental:
809      print 'utils_c4: ', varName, self.vocabs['variable'].varcons[varGroup][varName].get( '_dimension',[])
810      hreq = "height2m" in self.vocabs['variable'].varcons[varGroup][varName].get( '_dimension',[])
811      if hreq:
812        print 'testing height, var=%s' % varName
813    if hreq:
814      heightAtDict = {'long_name':"height", 'standard_name':"height", 'units':"m", 'positive':"up", 'axis':"Z" }
815      ok = True
816      ok &= self.test( 'height' in va.keys(), 'height coordinate not found %s' % str(va.keys()), abort=True, part=True )
817      ##ok &= self.test( abs( va['height']['_data'] - self.heightValues[varName]) < 0.001, \
818                ##'height value [%s] does not match required [%s]' % (va['height']['_data'],self.heightValues[varName] ), part=True )
819
820      ok1 = self.test( len( va['height']['_data'] ) == 1, 'More height values (%s) than expected (1)' % (len( va['height']['_data'])), part=True )
821      if ok1:
822        r = self.heightRange[varName]
823        ok1 &= self.test( r[0] <= va['height']['_data'][0] <= r[1], \
824                'height value [%s] not in specified range [%s]' % (va['height']['_data'], (self.heightRange[varName] ) ), part=True )
825
826      ok &= ok1
827     
828      for k in heightAtDict.keys():
829        val =  va['height'].get( k, "none" )
830        if not self.test( val == heightAtDict[k], \
831                         'height attribute %s absent or wrong value (should be %s)' % (k,heightAtDict[k]), part=True ):
832          self.parent.amapListDraft.append( '@var=%s;%s=%s|%s=%s' % ('height',k,val,k,heightAtDict[k]) )
833          ok = False
834
835      if ok:
836        self.log_pass()
837
838    self.completed = True
839
840class checkGrids(checkBase):
841
842  def init(self):
843    self.id = 'C4.004'
844    self.checkId = 'unset'
845    self.step = 'Initialised'
846    self.checks = (self.do_check_rp,self.do_check_intd)
847
848  def check(self,varName, domain, da, va):
849    self.errorCount = 0
850    assert type(varName) in [type('x'),type(u'x')], '1st argument to "check" method of checkGrids shound be a string variable name (not %s)' % type(varName)
851    self.var = varName
852    self.domain = domain
853    self.da = da
854    self.va = va
855
856    self.runChecks()
857    ##for c in self.checks:
858      ##c()
859    ##self.do_check_rp()
860    ##self.do_check_intd()
861
862  def do_check_rp(self):
863    varName = self.var
864    domain = self.domain
865    da = self.da
866    va = self.va
867    if va[varName].get( 'grid_mapping', None ) == "rotated_pole":
868      self.checkId = ('001','grid_mapping')
869      atDict = { 'grid_mapping_name':'rotated_latitude_longitude' }
870      atDict['grid_north_pole_latitude'] = self.pcfg.rotatedPoleGrids[domain]['grid_np_lat']
871      if self.pcfg.rotatedPoleGrids[domain]['grid_np_lon'] != 'N/A':
872        atDict['grid_north_pole_longitude'] = self.pcfg.rotatedPoleGrids[domain]['grid_np_lon']
873
874      self.checkId = ('002','rotated_latlon_attributes')
875      self.test( 'rlat' in da.keys() and 'rlon' in da.keys(), 'rlat and rlon not found (required for grid_mapping = rotated_pole )', abort=True, part=True )
876
877      atDict = {'rlat':{'long_name':"rotated latitude", 'standard_name':"grid_latitude", 'units':"degrees", 'axis':"Y", '_type':'float64'},
878                'rlon':{'long_name':"rotated longitude", 'standard_name':"grid_longitude", 'units':"degrees", 'axis':"X", '_type':'float64'} }
879      mm = []
880      for k in ['rlat','rlon']:
881        for k2 in atDict[k].keys():
882          if atDict[k][k2] != da[k].get(k2, None ):
883            mm.append( (k,k2) )
884            record = '#@ax=%s;%s=%s|%s=%s <uncomment if correct>' % (k,k2,da[k].get(k2, '__missing__'),k2,atDict[k][k2]   )
885            self.parent.amapListDraft.append( record )
886      self.test( len(mm) == 0, 'Required attributes of grid coordinate arrays not correct: %s' % str(mm) )
887
888      self.checkId = ('003','rotated_latlon_domain')
889      ok = True
890      for k in ['rlat','rlon']:
891        res = len(da[k]['_data']) == self.pcfg.rotatedPoleGrids[domain][ {'rlat':'nlat','rlon':'nlon' }[k] ]
892        if not res:
893          self.test( res, 'Size of %s dimension does not match specification (%s,%s)' % (k,a,b), part=True  )
894          ok = False
895
896      a = ( da['rlat']['_data'][0], da['rlat']['_data'][-1], da['rlon']['_data'][0], da['rlon']['_data'][-1] )
897      b = map( lambda x: self.pcfg.rotatedPoleGrids[domain][x], ['s','n','w','e'] )
898      mm = []
899      for i in range(4):
900        if abs(a[i] - b[i]) > self.pcfg.gridSpecTol:
901          mm.append( (a[i],b[i]) )
902
903      ok &= self.test( len(mm) == 0, 'Domain boundaries for rotated pole grid do not match %s within tolerance (%s)' % (str(mm),self.pcfg.gridSpecTol), part=True )
904
905      for k in ['rlat','rlon']:
906        ok &= self.test( cs.check( da[k]['_data'] ), '%s values not evenly spaced -- min/max delta = %s, %s' % (k,cs.dmn,cs.dmx), part=True )
907
908      if ok:
909        self.log_pass()
910
911  def do_check_intd(self):
912    varName = self.var
913    domain = self.domain
914    da = self.da
915    va = self.va
916    if domain[-1] == 'i':
917      self.checkId = ('004','regular_grid_attributes')
918      self.test( 'lat' in da.keys() and 'lon' in da.keys(), 'lat and lon not found (required for interpolated data)', abort=True, part=True )
919
920      atDict = {'lat':{'long_name':"latitude", 'standard_name':"latitude", 'units':"degrees_north", '_type':'float64'},
921                'lon':{'long_name':"longitude", 'standard_name':"longitude", 'units':"degrees_east", '_type':'float64'} }
922      mm = []
923      for k in ['lat','lon']:
924        for k2 in atDict[k].keys():
925          if atDict[k][k2] != da[k].get(k2, None ):
926            mm.append( (k,k2) )
927            record = '#@ax=%s;%s=%s|%s=%s <uncomment if correct>' % (k,k2,da[k].get(k2, '__missing__'),k2,atDict[k][k2]   )
928            self.parent.amapListDraft.append( record )
929
930      self.test( len(mm) == 0,  'Required attributes of grid coordinate arrays not correct: %s' % str(mm), part=True )
931
932      ok = True
933      self.checkId = ('005','regular_grid_domain')
934      for k in ['lat','lon']:
935        res = len(da[k]['_data']) >= self.pcfg.interpolatedGrids[domain][ {'lat':'nlat','lon':'nlon' }[k] ]
936        if not res:
937          a,b =  len(da[k]['_data']), self.pcfg.interpolatedGrids[domain][ {'lat':'nlat','lon':'nlon' }[k] ]
938          self.test( res, 'Size of %s dimension does not match specification (%s,%s)' % (k,a,b), part=True )
939          ok = False
940
941      a = ( da['lat']['_data'][0], da['lat']['_data'][-1], da['lon']['_data'][0], da['lon']['_data'][-1] )
942      b = map( lambda x: self.pcfg.interpolatedGrids[domain][x], ['s','n','w','e'] )
943      rs = self.pcfg.interpolatedGrids[domain]['res']
944      c = [-rs,rs,-rs,rs]
945      mm = []
946      for i in range(4):
947        if a[i] != b[i]:
948          x = (a[i]-b[i])/c[i]
949          if x < 0 or abs( x - int(x) ) > 0.001:
950             skipThis = False
951             if self.project  == 'CORDEX':
952               if domain[:3] == 'ANT':
953                 if i == 2 and abs( a[i] - 0.25 ) < 0.001:
954                    skipThis = True
955                 elif i == 3 and abs( a[i] - 359.75 ) < 0.001:
956                    skipThis = True
957             if not skipThis:
958               mm.append( (a[i],b[i]) )
959
960      ok &= self.test( len(mm) == 0, 'Interpolated grid boundary error: File %s; Req. %s' % (str(a),str(b)), part=True )
961
962      for k in ['lat','lon']:
963        ok &= self.test( cs.check( da[k]['_data'] ), '%s values not evenly spaced -- min/max delta = %s, %s' % (k,cs.dmn,cs.dmx), part=True )
964      if ok:
965        self.log_pass()
966
967class mipVocab(object):
968
969  def __init__(self,pcfg,dummy=False):
970     self.pcfg = pcfg
971     if dummy:
972       self.dummyMipTable()
973     elif pcfg.varTables=='CMIP':
974       self.ingestMipTables()
975     elif pcfg.varTables=='FLAT':
976       self.flatTable()
977   
978  def ingestMipTables(self):
979     dir, tl, vgmap, fnpat = self.pcfg.mipVocabPars
980     ms = mipTableScan()
981     self.varInfo = {}
982     self.varcons = {}
983     for f in tl:
984        vg = vgmap.get( f, f )
985        self.varcons[vg] = {}
986        fn = fnpat % f
987        ll = open( '%s%s' % (dir,fn) ).readlines()
988        ee = ms.scan_table(ll,None,asDict=True)
989        for v in ee.keys():
990## set global default: type float
991          eeee = { 'type':self.pcfg.defaults.get( 'variableDataType', 'float' ) }
992          eeee['_dimension'] = ee[v][0]
993          ar = []
994          ac = []
995          for a in ee[v][1].keys():
996            eeee[a] = ee[v][1][a]
997          ##if 'positive' in eeee.keys():
998            ##ar.append( 'positive' )
999            ##ac.append( 'positive' )
1000          self.varInfo[v] = {'ar':ar, 'ac':ac }
1001          self.varcons[vg][v] = eeee
1002           
1003  def dummyMipTable(self):
1004     self.varInfo = {}
1005     self.varcons = {}
1006     ee = { 'standard_name':'sn%s', 'long_name':'n%s', 'units':'1' }
1007     dir, tl, vgmap, fnpat = self.pcfg.mipVocabPars
1008     for f in tl:
1009        vg = vgmap.get( f, f )
1010        self.varcons[vg] = {}
1011        for i in range(12):
1012          v = 'v%s' % i
1013          eeee = {}
1014          eeee['standard_name'] = ee['standard_name'] % i
1015          eeee['long_name'] = ee['long_name'] % i
1016          eeee['cell_methods'] = 'time: point'
1017          eeee['units'] = ee['units']
1018          eeee['type'] = 'float'
1019          ar = []
1020          ac = []
1021          self.varInfo[v] = {'ar':ar, 'ac':ac }
1022          self.varcons[vg][v] = eeee
1023
1024  def flatTable(self):
1025     self.varInfo = {}
1026     self.varcons = {}
1027     dir, tl, vgm, fn = self.pcfg.mipVocabPars
1028     vg = vgm.keys()[0]
1029     ee = { 'standard_name':'sn%s', 'long_name':'n%s', 'units':'1' }
1030     ll = open( '%s%s' % (dir,fn) ).readlines()
1031     self.varcons[vg] = {}
1032     for l in ll:
1033       if l[0] != '#':
1034          dt, v, sn = string.split( string.strip(l) )
1035          self.pcfg.fnvdict[dt] = { 'v':v, 'sn':sn }
1036          ar = []
1037          ac = []
1038          self.varInfo[v] = {'ar':ar, 'ac':ac }
1039          self.varcons[vg][v] = {'standard_name':sn, 'type':'float' }
1040
1041  def lists( self, k, k2 ):
1042     if k2 == 'addRequiredAttributes':
1043       return self.varInfo[k]['ar']
1044     elif k2 == 'addControlledAttributes':
1045       return self.varInfo[k]['ac']
1046     else:
1047       raise baseException( 'mipVocab.lists called with bad list specifier %s' % k2 )
1048
1049  def isInTable( self, v, vg1 ):
1050    vg = vg1
1051    if vg == 'ESA':
1052      vg = 'ESACCI'
1053    assert vg in self.varcons.keys(), '%s not found in  self.varcons.keys() [%s]' % (vg,str(self.varcons.keys()) )
1054    return (v in self.varcons[vg].keys())
1055     
1056  def getAttr( self, v, vg1, a ):
1057    vg = vg1
1058    if vg == 'ESA':
1059      vg = 'ESACCI'
1060    assert vg in self.varcons.keys(), '%s not found in  self.varcons.keys()'
1061    assert v in self.varcons[vg].keys(), '%s not found in self.varcons[%s].keys()' % (v,vg)
1062     
1063    return self.varcons[vg][v][a]
1064     
1065class patternControl(object):
1066
1067  def __init__(self,tag,pattern,list=None,cls=None,examples=None,badExamples=None,runTest=True):
1068    if cls != None:
1069      assert cls in ['ISO'], 'value of cls [%s] not recognised' % cls
1070      if cls == 'ISO':
1071        assert pattern in ['ISO8601 duration'], 'value of pattern [%s] for ISO constraint not recognised' % pattern
1072        if pattern == 'ISO8601 duration':
1073          thispat = '^(P([0-9]+Y){0,1}([0-9]+M){0,1}([0-9]+D){0,1}(T([0-9]+H){0,1}([0-9]+M){0,1}([0-9]+(.[0-9]+){0,1}S){0,1}){0,1})$|^(P[0-9]+W)$'
1074        self.re_pat = re.compile( thispat )
1075        self.pattern = thispat
1076        self.pattern_src = pattern
1077    else:
1078      try:
1079        self.re_pat = re.compile( pattern )
1080      except:
1081        print "Failed to compile pattern >>%s<< (%s)" % (pattern, tag)
1082      self.pattern = pattern
1083   
1084    self.examples = examples
1085    self.badExamples = badExamples
1086    self.list = list
1087    self.cls = cls
1088
1089    if runTest:
1090      if examples != None:
1091        for e in examples:
1092          assert self.check(e), 'Internal check failed: example %s does not fit pattern %s' % (e,self.pattern)
1093
1094  def check(self,val):
1095    self.note = '-'
1096    m = self.re_pat.match( val )
1097    if self.list == None:
1098      self.note = "simple test"
1099      return m != None
1100    else:
1101      if m == None:
1102        self.note = "no match %s::%s" % (val,self.pattern)
1103        return False
1104      if not m.groupdict().has_key("val"):
1105        self.note = "no 'val' in match"
1106        return False
1107      self.note = "val=%s" % m.groupdict()["val"]
1108      return m.groupdict()["val"] in self.list
1109   
1110class listControl(object):
1111  def __init__(self,tag,list,split=False,splitVal=None,enumeration=False):
1112    self.list = list
1113    self.tag = tag
1114    self.split = split
1115    self.splitVal = splitVal
1116    self.enumeration = enumeration
1117    self.etest = re.compile( '(.*)<([0-9]+(,[0-9]+)*)>' )
1118    self.essplit = re.compile(r'(?:[^\s,<]|<(?:\\.|[^>])*>)+')
1119
1120  def check(self,val):
1121    self.note = '-'
1122    if len(self.list) < 4:
1123      self.note = str( self.list )
1124    else:
1125      self.note = str( self.list[:4] )
1126    if self.split:
1127      if self.splitVal == None:
1128        vs = string.split( val )
1129      elif self.enumeration:
1130        vs = map( string.strip, self.essplit.findall( val ) )
1131      else:
1132        vs = map( string.strip, string.split( val, self.splitVal ) )
1133    else:
1134      vs = [val,]
1135    if self.enumeration:
1136      vs2 = []
1137      for v in vs:
1138        m = self.etest.findall( v )
1139        if m in [None,[]]:
1140          vs2.append( v )
1141        else:
1142          opts = string.split( m[0][1], ',' )
1143          for o in opts:
1144            vs2.append( '%s%s' % (m[0][0],o) )
1145      vs = vs2[:]
1146       
1147    return all( map( lambda x: x in self.list, vs ) )
1148
1149
1150class checkByVar(checkBase):
1151  """Run some checks on groups of files with a common variable. Checks for continuity of time in group"""
1152
1153  def init(self,fileNameSeparator='_'):
1154    self.id = 'C5.001'
1155    self.checkId = 'unset'
1156    self.step = 'Initialised'
1157    self.checks = (self.checkTrange,)
1158    self.fnsep = fileNameSeparator
1159
1160  def setLogDict( self,fLogDict ):
1161    self.fLogDict = fLogDict
1162
1163  def impt(self,flist):
1164    """Scan a list of files and identify groups which a common variable and extract time ranges into a dictionary of lists, keyed on group identifiers.
1165     :param flist: List of file names.
1166
1167 This routine has rather obscure nested logical tests used to identify the group to which a file belongs. The complexity arises from the fact that the identification of the files that should form a continuous time series from the file names alone is not a standardised feature of the file names."""
1168    ee = {}
1169    elist = []
1170    for f in flist:
1171      fn = string.split(f, '/' )[-1]
1172      fnParts = string.split( fn[:-3], self.fnsep )
1173     
1174      try:
1175        if self.pcfg.freqIndex != None:
1176          freq = fnParts[self.pcfg.freqIndex]
1177        else:
1178          freq = None
1179
1180        group = fnParts[ self.pcfg.groupIndex ]
1181
1182        if self.parent.fileIsFixed:
1183          trange = None
1184        else:
1185          trange = string.split( fnParts[-1], '-' )
1186        var = fnParts[self.pcfg.varIndex]
1187        thisKey = string.join( fnParts[:-1], '.' )
1188        if group not in ee.keys():
1189          ee[group] = {}
1190        if thisKey not in ee[group].keys():
1191          ee[group][thisKey] = []
1192        ee[group][thisKey].append( (f,fn,group,trange) )
1193      except:
1194        print 'Cannot parse file name: %s' % (f) 
1195        elist.append(f)
1196## this ee entry is not used, except in bookkeeping check below.
1197## parsing of file name is repeated later, and a error log entry is created at that stage -- this could be improved.
1198## in order to improve, need to clarify flow of program: the list here is used to provide preliminary info before log files etc are set up.
1199        group = '__error__'
1200        thisKey = fn
1201        if group not in ee.keys():
1202          ee[group] = {}
1203        if thisKey not in ee[group].keys():
1204          ee[group][thisKey] = []
1205        ee[group][thisKey].append( (f,fn,group) )
1206
1207    nn = len(flist)
1208    n2 = 0
1209    for k in ee.keys():
1210      for k2 in ee[k].keys():
1211        n2 += len( ee[k][k2] )
1212
1213    assert nn==n2, 'some file lost!!!!!!'
1214    if len(elist) == 0:
1215      self.info =  '%s files, %s' % (nn,str(ee.keys()) )
1216    else:
1217      self.info =  '%s files, %s frequencies, severe errors in file names: %s' % (nn,len(ee.keys()),len(elist) )
1218      for e in elist:
1219        self.info += '\n%s' % e
1220    self.ee = ee
1221
1222  def check(self, recorder=None,calendar='None',norun=False):
1223    self.errorCount = 0
1224    self.recorder=recorder
1225    self.calendar=calendar
1226    if calendar == '360-day':
1227      self.enddec = 30
1228    else:
1229      self.enddec = 31
1230    mm = { 'enddec':self.enddec }
1231    self.pats = {'mon':('(?P<d>[0-9]{3})101','(?P<e>[0-9]{3})012'), \
1232            'sem':('(?P<d>[0-9]{3})(012|101)','(?P<e>[0-9]{3})(011|010)'), \
1233            'day':('(?P<d>[0-9]{3}[16])0101','(?P<e>[0-9]{3}[50])12%(enddec)s' % mm), \
1234            'subd':('(?P<d>[0-9]{4})0101(?P<h1>[0-9]{2})(?P<mm>[30]0){0,1}$', '(?P<e>[0-9]{4})12%(enddec)s(?P<h2>[0-9]{2})([30]0){0,1}$' % mm ), \
1235            'subd2':('(?P<d>[0-9]{4})0101(?P<h1>[0-9]{2})', '(?P<e>[0-9]{4})010100' ) }
1236
1237    if not norun:
1238      self.runChecks()
1239
1240  def checkTrange(self):
1241    """Manage time range checks: loop over groups of files identified by :meth:`impt`"""
1242    keys = self.ee.keys()
1243    keys.sort()
1244    for k in keys:
1245      if k not in ['fx','fixed']:
1246        keys2 = self.ee[k].keys()
1247        keys2.sort()
1248        for k2 in keys2:
1249          self.checkThisTrange( self.ee[k][k2], k )
1250
1251  def checkThisTrange( self, tt, group):
1252    """Check consistency across a list of time ranges"""
1253
1254    if group in ['3hr','6hr']:
1255       kg = 'subd'
1256    else:
1257       kg = group
1258    ps = self.pats[kg]
1259    rere = (re.compile( ps[0] ), re.compile( ps[1] ) )
1260
1261    n = len(tt)
1262    self.checkId = ('001','filename_timerange_value')
1263    for j in range(n):
1264      if self.monitor != None:
1265         nofh0 = self.monitor.get_open_fds()
1266      t = tt[j]
1267      fn = t[1]
1268      isFirst = j == 0
1269      isLast = j == n-1
1270      lok = True
1271      for i in [0,1]:
1272        if not (i==0 and isFirst or i==1 and isLast):
1273          x = rere[i].match( t[3][i] )
1274          lok &= self.test( x != None, 'Cannot match time range %s: %s [%s/%s]' % (i,fn,j,n), part=True, appendLogfile=(self.fLogDict.get(fn,None),fn) )
1275        if not lok:
1276          if self.recorder != None:
1277            self.recorder.modify( t[1], 'ERROR: time range' )
1278      if self.monitor != None:
1279         nofh9 = self.monitor.get_open_fds()
1280         if nofh9 > nofh0:
1281           print 'Open file handles: %s --- %s [%s]' % (nofh0, nofh9, j )
1282
1283### http://stackoverflow.com/questions/2023608/check-what-files-are-open-in-python
1284class sysMonitor(object):
1285
1286  def __init__(self):
1287    self.fhCountMax = 0
1288
1289  def get_open_fds(self):
1290    '''
1291    return the number of open file descriptors for current process
1292    .. warning: will only work on UNIX-like os-es.
1293    '''
1294    import subprocess
1295    import os
1296
1297    pid = os.getpid()
1298    self.procs = subprocess.check_output( 
1299        [ "lsof", '-w', '-Ff', "-p", str( pid ) ] )
1300
1301    self.ps = filter( 
1302            lambda s: s and s[ 0 ] == 'f' and s[1: ].isdigit(),
1303            self.procs.split( '\n' ) )
1304    self.fhCountMax = max( self.fhCountMax, len(self.ps) )
1305    return len( self.ps )
Note: See TracBrowser for help on using the repository browser.