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

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

updates to iso 8601 check and esa-cci config

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    print self.fnDict
358    if self.pcfg.projectV.id in ['ESA-CCI']:
359      if  self.fnDict['project'] == 'GlobSnow':
360        if self.fnDict['additional'] == 'weekly':
361          self.var += 'weekly'
362
363    if self.pcfg.fnvdict != None:
364      if self.pcfg.fnvdict.has_key( self.var ):
365        self.var = self.pcfg.fnvdict.get( self.var )['v']
366
367    self.isFixed = self.freq in ['fx','fixed']
368    self.parent.fileIsFixed = True
369    if self.isFixed:
370      self.test( len(self.fnParts) in self.pcfg.fnPartsOkFixedLen, 'Number of file name elements not acceptable for fixed data' )
371
372    self.checkId = ('002','parse_filename_timerange')
373    if not self.isFixed:
374
375## test time segment
376      if self.pcfg.trangeType == 'CMIP':
377        bits = string.split( self.fnParts[-1], '-' )
378        self.test( len(bits) == 2, 'File time segment [%s] will not parse into 2 elements' % (self.fnParts[-1] ), abort=True, part=True )
379
380        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  )
381        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  )
382
383        for b in bits:
384          self.test( self.isInt(b), 'Time segment in filename [%s] contains non integer characters' % (self.fnParts[-1] ),  abort=True, part=True  )
385        self.log_pass()
386        self.fnTimeParts = bits[:]
387      elif self.pcfg.trangeType == 'ESA-CCI':
388        self.pcfg.checkTrangeLen = False
389        tt = self.fnParts[self.pcfg.trangeIndex] 
390        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  ):
391          ll = [tt[:4],]
392          tt = tt[4:]
393          for j in range(5):
394            if len(tt) > 0:
395              ll.append( tt[:2] )
396              tt = tt[2:]
397            elif j in [1,2]:
398              ll.append( '01' )
399            else:
400              ll.append( '00' )
401          indDateTime = map( int, ll )
402          self.test( indDateTime[1] in range(1,13), 'Invalid Month in indicative date time %s' % str(ll), part=True )
403          self.test( indDateTime[2] in range(1,32), 'Invalid Day in indicative date time %s' % str(ll), part=True )
404          self.test( indDateTime[3] in range(25), 'Invalid hour in indicative date time %s' % str(ll), part=True )
405          self.test( indDateTime[4] in range(60), 'Invalid minute in indicative date time %s' % str(ll), part=True )
406          self.test( indDateTime[5] in range(60), 'Invalid second in indicative date time %s' % str(ll), part=True )
407
408    self.checkId = '003'
409
410    self.checkId, ok = (('004','filename_timerange_length'),True)
411    if (not self.isFixed) and self.pcfg.checkTrangeLen:
412      ltr = { 'mon':6, 'sem':6, 'day':8, '3hr':[10,12], '6hr':10 }
413      ok &=self.test( self.freq in ltr.keys(), 'Frequency [%s] not recognised' % self.freq, part=True )
414      if ok:
415        if type( ltr[self.freq] ) == type(0):
416          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)
417          ok &= self.test( len(self.fnTimeParts[0]) == ltr[self.freq], msg, part=True )
418        elif type( ltr[self.freq] ) in [type([]),type( () )]:
419          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)
420          ok &= self.test( len(self.fnTimeParts[0]) in ltr[self.freq], msg, part=True )
421
422      if ok:
423        self.log_pass()
424
425  def do_check_fnextra(self):
426    """Check whether file name components match constraints -- but only if those constraints are not implicitly verified through comparison with global attributes in later checks"""
427    self.checkId = ('004','file_name_extra' )
428    vocabs = self.pcfg.vocabs
429    m = []
430    for a in self.pcfg.controlledFnParts:
431      if self.fnDict.has_key(a):
432        try:
433          if not vocabs[a].check( str(self.fnDict[a]) ):
434            m.append( (a,self.fnDict[a],vocabs[a].note) )
435        except:
436          print 'failed trying to check file name component %s' % a
437          raise baseException( 'failed trying to check file name component %s' % a )
438
439    self.test( len(m)  == 0, 'File name components do not match constraints: %s' % str(m) )
440
441
442class checkGlobalAttributes(checkBase):
443  """Check global and variable attributes, using tables of valid values"""
444
445  def init(self):
446    self.id = 'C4.002'
447    self.checkId = 'unset'
448    self.step = 'Initialised'
449    self.checks = (self.do_check_ga,)
450    self.fileId = None
451
452  def check(self,globalAts, varAts,varName,varGroup, vocabs, fnParts):
453    self.errorCount = 0
454    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)
455    self.var = varName
456    self.globalAts = globalAts
457    self.varAts = varAts
458    self.varGroup = varGroup
459    self.vocabs = vocabs
460    self.fnParts = fnParts
461    self.runChecks()
462
463  def getId(self):
464    if self.fileId == None:
465      self.fileId = '%s.%s' % (self.globalAts['naming_authority'],self.globalAts['id'])
466      if self.globalAts['naming_authority'] == 'uk.ac.pml':
467        i0 = string.find(self.globalAts['id'],'OC4v6_QAA')
468        if i0 != -1:
469          self.fileId = '%s.%s' % (self.globalAts['naming_authority'],self.globalAts['id'][:i0+9])
470
471  def getDrs( self ):
472    assert self.completed, 'method getDrs should not be called if checks have not been completed successfully'
473    ee = {}
474    drsDefaults = { 'convention_version':'n/a'}
475    if not self.globalAts.has_key('product'):
476        self.globalAts['product'] = 'output'
477    for k in self.drsMappings:
478      if self.drsMappings[k] == '@var':
479        ee[k] = self.var
480      elif self.drsMappings[k][0] == '=':
481        ee[k] = self.drsMappings[k][1:]
482      elif self.drsMappings[k] == '@ensemble':
483        ee[k] = "r%si%sp%s" % (self.globalAts["realization"],self.globalAts["initialization_method"],self.globalAts["physics_version"])
484      elif self.drsMappings[k] == '@forecast_reference_time':
485        x = self.globalAts.get("forecast_reference_time",'yyyy-mm-dd Thh:mm:ssZ' )
486        ee[k] = "%s%s%s" % (x[:4],x[5:7],x[8:10])
487      elif self.drsMappings[k] == '@mip_id':
488        ee[k] = string.split( self.globalAts["table_id"] )[1]
489      elif self.drsMappings[k] == '@ecv':
490        ee[k] = self.pcfg.ecvMappings[ self.parent.fnDict['project'] ]
491      elif self.drsMappings[k][0] == '$':
492        self.pcfg.getExtraAtts()
493        self.getId()
494        if string.find(self.drsMappings[k],':') != -1:
495          k2,dflt = string.split( self.drsMappings[k][1:],':')
496          ee[k] = self.pcfg.extraAtts[self.fileId].get( k2, dflt )
497        else:
498          ee[k] = self.pcfg.extraAtts[self.fileId][self.drsMappings[k][1:]]
499      elif self.drsMappings[k][0] == '*':
500        thisk = self.drsMappings[k][1:]
501        ee[k] = self.varAts[self.var][thisk]
502      elif self.drsMappings[k][0] == '#':
503        thisk = self.drsMappings[k][1:]
504        if drsDefaults.has_key( thisk ):
505          ee[k] = self.parent.fnDict.get(thisk, drsDefaults[thisk] )
506        else:
507          ee[k] = self.parent.fnDict[thisk]
508      else:
509        ee[k] = self.globalAts[ self.drsMappings[k] ]
510
511    for k in ['creation_date','tracking_id']:
512      if k in self.globalAts.keys():
513        ee[k] = self.globalAts[k]
514
515    return ee
516
517  def do_check_ga(self):
518    varName = self.var
519    globalAts = self.globalAts
520    varAts = self.varAts
521    varGroup = self.varGroup
522    vocabs = self.vocabs
523    fnParts = self.fnParts
524
525    self.completed = False
526    self.checkId = ('001','global_ncattribute_present')
527    m = []
528    for k in self.requiredGlobalAttributes:
529      if not globalAts.has_key(k):
530         m.append(k)
531         self.globalAts[k] = '__errorReported__'
532
533    if not self.test( len(m)  == 0, 'Required global attributes missing: %s' % str(m) ):
534      gaerr = True
535      for k in m:
536        self.parent.amapListDraft.append( '#@;%s=%s|%s=%s' % (k,'__absent__',k,'<insert attribute value and uncomment>') )
537
538    self.checkId = ('002','variable_in_group')
539
540    self.test( varAts.has_key( varName ), 'Expected variable [%s] not present' % varName, abort=True, part=True )
541    msg = 'Variable %s not in table %s' % (varName,varGroup)
542    self.test( vocabs['variable'].isInTable( varName, varGroup ), msg, abort=True, part=True )
543
544    if self.pcfg.checkVarType:
545      self.checkId = ('003','variable_type')
546
547      mipType = vocabs['variable'].getAttr( varName, varGroup, 'type' )
548      thisType = {'real':'float32', 'integer':'int32', 'float':'float32', 'double':'float64' }.get( mipType, mipType )
549      self.test( mipType == None or varAts[varName]['_type'] == thisType, 'Variable [%s/%s] not of type %s [%s]' % (varName,varGroup,str(thisType),varAts[varName]['_type']) )
550    else:
551      mipType = None
552
553    self.checkId = ('004','variable_ncattribute_present')
554    m = []
555    reqAts = self.requiredVarAttributes[:]
556    if (not self.parent.fileIsFixed) and self.pcfg.projectV.id in ['CORDEX']:
557      reqAts.append( 'cell_methods' )
558    for k in reqAts + vocabs['variable'].lists(varName, 'addRequiredAttributes'):
559      if not varAts[varName].has_key(k):
560         m.append(k)
561    if not self.test( len(m)  == 0, 'Required variable attributes missing: %s' % str(m) ):
562      vaerr = True
563      for k in m:
564        self.parent.amapListDraft.append( '#@var=%s;%s=%s|%s=%s' % (varName,k,'__absent__',k,'<insert attribute value and uncomment>') )
565        ## print self.parent.amapListDraft[-1]
566
567## need to insert a check that variable is present
568    self.checkId = ('005','variable_ncattribute_mipvalues')
569    ok = True
570    hm = varAts[varName].get( 'missing_value', None ) != None
571    hf = varAts[varName].has_key( '_FillValue' )
572    if hm or hf:
573      if self.pcfg.varTables=='CMIP':
574        ok &= self.test( hm, 'missing_value must be present if _FillValue is [%s]' % varName )
575        ok &= self.test( hf, '_FillValue must be present if missing_value is [%s]' % varName )
576      else:
577        ok = True
578      if mipType == 'real':
579        if varAts[varName].has_key( 'missing_value' ):
580           msg = 'Variable [%s] has incorrect attribute missing_value=%s [correct: %s]' % (varName,varAts[varName]['missing_value'],self.missingValue)
581### need to use ctypes here when using ncq3 to read files -- appears OK for other libraries.
582           ok &= self.test( ctypes.c_float(varAts[varName]['missing_value']).value == ctypes.c_float(self.missingValue).value, msg, part=True )
583        if varAts[varName].has_key( '_FillValue' ):
584           msg = 'Variable [%s] has incorrect attribute _FillValue=%s [correct: %s]' % (varName,varAts[varName]['_FillValue'],self.missingValue)
585           ok &= self.test( varAts[varName]['_FillValue'] == self.missingValue, msg, part=True )
586
587    mm = []
588   
589    if self.pcfg.varTables=='CMIP':
590      contAts = ['long_name', 'standard_name', 'units']
591      if not self.parent.fileIsFixed:
592      ##if varGroup not in ['fx','fixed']:
593        contAts.append( 'cell_methods' )
594    else:
595      contAts = ['standard_name']
596    hcm = varAts[varName].has_key( "cell_methods" )
597    for k in contAts + vocabs['variable'].lists(varName,'addControlledAttributes'):
598      targ = varAts[varName].get( k, 'Attribute not present' )
599      val = vocabs['variable'].getAttr( varName, varGroup, k )
600
601      if k == "cell_methods":
602        if val != None:
603          parenthesies1 = []
604          targ0 = targ[:]
605          while string.find( targ, '(' ) != -1:
606            i0 = targ.index( '(' )
607            i1 = targ.index( ')' )
608            parenthesies1.append( targ[i0:i1+1] )
609            targ = targ[:i0-1] + targ[i1+1:]
610          parenthesies2 = []
611          val0 = val[:]
612          while string.find( val, '(' ) != -1:
613            i0 = val.index( '(' )
614            i1 = val.index( ')' )
615            parenthesies2.append( val[i0:i1+1] )
616            val = val[:i0-1] + val[i1+1:]
617          for p in parenthesies2:
618            if p not in parenthesies1:
619              mm.append( (k,parenthesies1,p) )
620          if string.find( targ, val):
621             mm.append( (k,targ,val) )
622      elif targ != 'Attribute not present' and targ != val:
623        mm.append( (k,targ,val) )
624
625    ok &= self.test( len(mm)  == 0, 'Variable [%s] has incorrect attributes: %s' % (varName, strmm3(mm)), part=True )
626    if len( mm  ) != 0:
627      if self.parent.amapListDraft == None:
628        self.parent.amapListDraft = []
629      for m in mm:
630          if m[2] == None:
631            self.parent.amapListDraft.append( '## @var=%s;%s=%s|@delete=%s -- not supported yet' % (varName,m[0],m[1],m[0]) )
632          else:
633            self.parent.amapListDraft.append( '@var=%s;%s=%s|%s=%s' % (varName,m[0],m[1],m[0],m[2]) )
634
635    if ok:
636       self.log_pass()
637
638    if (not self.parent.fileIsFixed) and hcm:
639    ## if (varGroup not in ['fx','fixed']) and hcm:
640      self.isInstantaneous = string.find( varAts[varName]['cell_methods'], 'time: point' ) != -1
641    else:
642      self.isInstantaneous = True
643
644    self.checkId = ('006','global_ncattribute_cv' )
645    m = []
646    for a in self.controlledGlobalAttributes:
647      if globalAts.has_key(a):
648        try:
649          if not vocabs[a].check( str(globalAts[a]) ):
650            m.append( (a,globalAts[a],vocabs[a].note) )
651        except:
652          print 'failed trying to check global attribute %s' % a
653          raise baseException( 'failed trying to check global attribute %s' % a )
654
655    if not self.test( len(m)  == 0, 'Global attributes do not match constraints: %s' % str(m) ):
656      for t in m:
657        self.parent.amapListDraft.append( '#@;%s=%s|%s=%s' % (t[0],str(t[1]),t[0],'<insert attribute value and uncomment>' + str(t[2]) ) )
658
659    self.checkId = ('007','filename_filemetadata_consistency')
660    m = []
661    for i in range(len(self.globalAttributesInFn)):
662       gaif = self.globalAttributesInFn[i]
663       if gaif != None and gaif[0] != '*':
664         if gaif[-1] == ':':
665           bits = string.split(gaif,':')
666           gaif0 = gaif
667           gaif = bits[0]
668           ix = int(bits[1])
669         else:
670           ix = i
671
672         targVal = fnParts[ix]
673         if gaif[0] == "@":
674           if gaif[1:] == "mip_id":
675               bits = string.split( globalAts[ "table_id" ] ) 
676               if len( bits ) > 2 and bits[0] == "Table":
677                 thisVal = bits[1]
678               else:
679                 thisVal = globalAts[ "table_id" ]
680                 self.test( False, 'Global attribute table_id does not conform to CMOR pattern ["Table ......"]: %s' % thisVal, part=True)
681           elif gaif[1:] == "ensemble":
682               thisVal = "r%si%sp%s" % (globalAts["realization"],globalAts["initialization_method"],globalAts["physics_version"])
683## following mappings are depricated -- introduced for SPECS and withdrawn ---
684           elif gaif[1:] == "experiment_family":
685               thisVal = globalAts["experiment_id"][:-4]
686           elif gaif[1:] == "forecast_reference_time":
687               x = self.globalAts.get("forecast_reference_time",'yyyy-mm-dd Thh:mm:ssZ' )
688               thisVal = "S%s%s%s" % (x[:4],x[5:7],x[8:10])
689           elif gaif[1:] == "series":
690               thisVal = 'series%s' % globalAts["series"]
691           else:
692               assert False, "Not coded to deal with this configuration: globalAttributesInFn[%s]=%s" % (i,self.globalAttributesInFn[i])
693         
694         else:
695             thisVal = globalAts[gaif]
696
697         if thisVal not in [targVal,'__errorReported__']:
698             m.append( (i,self.globalAttributesInFn[i]) )
699
700    self.test( len(m)  == 0,'File name segments do not match corresponding global attributes: %s' % str(m) )
701
702    self.completed = True
703       
704class checkStandardDims(checkBase):
705  """Check the dimensions which are defined in the specifications"""
706
707  def init(self):
708    self.id = 'C4.003'
709    self.checkId = 'unset'
710    self.step = 'Initialised'
711    self.checks = (self.do_check,)
712    self.plevRequired = self.pcfg.plevRequired
713    self.plevValues = self.pcfg.plevValues
714    self.heightRequired = self.pcfg.heightRequired
715    self.heightValues = self.pcfg.heightValues
716    self.heightRange = self.pcfg.heightRange
717
718  def check(self,varName,varGroup, da, va, isInsta,vocabs):
719    self.errorCount = 0
720    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)
721    self.var = varName
722    self.varGroup = varGroup
723    self.da = da
724    self.va = va
725    self.isInsta = isInsta
726    self.vocabs = vocabs
727    self.runChecks()
728
729  def do_check(self):
730    varName = self.var
731    varGroup = self.varGroup
732    da = self.da
733    va = self.va
734    isInsta = self.isInsta
735
736    self.errorCount = 0
737    self.completed = False
738    self.checkId = ('001','time_attributes')
739    self.calendar = 'None'
740    if not self.parent.fileIsFixed:
741    ## if varGroup not in ['fx','fixed']:
742      ok = True
743      self.test( 'time' in da.keys(), 'Time dimension not found' , abort=True, part=True )
744      if self.pcfg.varTables=='CMIP':
745        if not isInsta:
746          ok &= self.test(  da['time'].get( 'bounds', 'xxx' ) == 'time_bnds', 'Required bounds attribute not present or not correct value', part=True )
747
748## is time zone designator needed?
749        tunits = da['time'].get( 'units', 'xxx' )
750        if self.project  == 'CORDEX':
751          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"],
752               'Time units [%s] attribute not set correctly to "days since 1949-12-01 00:00:00Z"' % tunits, part=True )
753        else:
754          ok &= self.test( tunits[:10] == "days since", 'time units [%s] attribute not set correctly to "days since ....."' % tunits, part=True )
755
756        ok &= self.test(  da['time'].has_key( 'calendar' ), 'Time: required attribute calendar missing', part=True )
757
758        ok &= self.test( da['time']['_type'] in ["float64","double"], 'Time: data type not float64 [%s]' % da['time']['_type'], part=True )
759       
760        if ok:
761          self.log_pass()
762        self.calendar = da['time'].get( 'calendar', 'None' )
763
764    self.checkId = ('002','pressure_levels')
765    if varName in self.plevRequired:
766      ok = True
767      self.test( 'plev' in va.keys(), 'plev coordinate not found %s' % str(va.keys()), abort=True, part=True )
768
769      ok &= self.test( int( va['plev']['_data'][0] ) == self.plevValues[varName],  \
770                  'plev value [%s] does not match required [%s]' % (va['plev']['_data'],self.plevValues[varName] ), part=True )
771     
772      plevAtDict = {'standard_name':"air_pressure", \
773                    'long_name':"pressure", \
774                    'units':"Pa", \
775                    'positive':"down", \
776                    'axis':"Z" }
777
778      if varName in ['clh','clm','cll']:
779        plevAtDict['bounds']= "plev_bnds"
780
781      for k in plevAtDict.keys():
782        ok &= self.test( va['plev'].get( k, None ) == plevAtDict[k], 
783                     'plev attribute %s absent or wrong value (should be %s)' % (k,plevAtDict[k]), part=True )
784
785      if varName in ['clh','clm','cll']:
786         self.test( "plev_bnds" in va.keys(), 'plev_bnds variable not found %s' % str(va.keys()), abort=True, part=True )
787         mm = []
788         for k in plevAtDict.keys():
789            if k != 'bounds' and k in va['plev_bnds'].keys():
790               if va['plev_bnds'][k] != va['plev'][k]:
791                 mm.append(k)
792         ok &= self.test( len(mm) == 0, 'Attributes of plev_bnds do not match those of plev: %s' % str(mm), part=True )
793
794         bndsVals = {'clh':[44000, 0], 'clm':[68000, 44000], 'cll':[100000, 68000] }
795         res = self.test( len( va['plev_bnds']['_data'] ) == 2, 'plev_bnds array is of wrong length', part=True )
796         ok &= res
797         if res:
798            kk = 0
799            for i in [0,1]:
800               if int(va['plev_bnds']['_data'][i]) != bndsVals[varName][i]:
801                  kk+=1
802            ok &= self.test( kk == 0, 'plev_bnds values not correct: should be %s' % str(bndsVals[varName]), part=True )
803
804      if ok:
805        self.log_pass()
806
807    self.checkId = ('003','height_levels')
808    hreq = varName in self.heightRequired
809    if self.parent.experimental:
810      print 'utils_c4: ', varName, self.vocabs['variable'].varcons[varGroup][varName].get( '_dimension',[])
811      hreq = "height2m" in self.vocabs['variable'].varcons[varGroup][varName].get( '_dimension',[])
812      if hreq:
813        print 'testing height, var=%s' % varName
814    if hreq:
815      heightAtDict = {'long_name':"height", 'standard_name':"height", 'units':"m", 'positive':"up", 'axis':"Z" }
816      ok = True
817      ok &= self.test( 'height' in va.keys(), 'height coordinate not found %s' % str(va.keys()), abort=True, part=True )
818      ##ok &= self.test( abs( va['height']['_data'] - self.heightValues[varName]) < 0.001, \
819                ##'height value [%s] does not match required [%s]' % (va['height']['_data'],self.heightValues[varName] ), part=True )
820
821      ok1 = self.test( len( va['height']['_data'] ) == 1, 'More height values (%s) than expected (1)' % (len( va['height']['_data'])), part=True )
822      if ok1:
823        r = self.heightRange[varName]
824        ok1 &= self.test( r[0] <= va['height']['_data'][0] <= r[1], \
825                'height value [%s] not in specified range [%s]' % (va['height']['_data'], (self.heightRange[varName] ) ), part=True )
826
827      ok &= ok1
828     
829      for k in heightAtDict.keys():
830        val =  va['height'].get( k, "none" )
831        if not self.test( val == heightAtDict[k], \
832                         'height attribute %s absent or wrong value (should be %s)' % (k,heightAtDict[k]), part=True ):
833          self.parent.amapListDraft.append( '@var=%s;%s=%s|%s=%s' % ('height',k,val,k,heightAtDict[k]) )
834          ok = False
835
836      if ok:
837        self.log_pass()
838
839    self.completed = True
840
841class checkGrids(checkBase):
842
843  def init(self):
844    self.id = 'C4.004'
845    self.checkId = 'unset'
846    self.step = 'Initialised'
847    self.checks = (self.do_check_rp,self.do_check_intd)
848
849  def check(self,varName, domain, da, va):
850    self.errorCount = 0
851    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)
852    self.var = varName
853    self.domain = domain
854    self.da = da
855    self.va = va
856
857    self.runChecks()
858    ##for c in self.checks:
859      ##c()
860    ##self.do_check_rp()
861    ##self.do_check_intd()
862
863  def do_check_rp(self):
864    varName = self.var
865    domain = self.domain
866    da = self.da
867    va = self.va
868    if va[varName].get( 'grid_mapping', None ) == "rotated_pole":
869      self.checkId = ('001','grid_mapping')
870      atDict = { 'grid_mapping_name':'rotated_latitude_longitude' }
871      atDict['grid_north_pole_latitude'] = self.pcfg.rotatedPoleGrids[domain]['grid_np_lat']
872      if self.pcfg.rotatedPoleGrids[domain]['grid_np_lon'] != 'N/A':
873        atDict['grid_north_pole_longitude'] = self.pcfg.rotatedPoleGrids[domain]['grid_np_lon']
874
875      self.checkId = ('002','rotated_latlon_attributes')
876      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 )
877
878      atDict = {'rlat':{'long_name':"rotated latitude", 'standard_name':"grid_latitude", 'units':"degrees", 'axis':"Y", '_type':'float64'},
879                'rlon':{'long_name':"rotated longitude", 'standard_name':"grid_longitude", 'units':"degrees", 'axis':"X", '_type':'float64'} }
880      mm = []
881      for k in ['rlat','rlon']:
882        for k2 in atDict[k].keys():
883          if atDict[k][k2] != da[k].get(k2, None ):
884            mm.append( (k,k2) )
885            record = '#@ax=%s;%s=%s|%s=%s <uncomment if correct>' % (k,k2,da[k].get(k2, '__missing__'),k2,atDict[k][k2]   )
886            self.parent.amapListDraft.append( record )
887      self.test( len(mm) == 0, 'Required attributes of grid coordinate arrays not correct: %s' % str(mm) )
888
889      self.checkId = ('003','rotated_latlon_domain')
890      ok = True
891      for k in ['rlat','rlon']:
892        res = len(da[k]['_data']) == self.pcfg.rotatedPoleGrids[domain][ {'rlat':'nlat','rlon':'nlon' }[k] ]
893        if not res:
894          self.test( res, 'Size of %s dimension does not match specification (%s,%s)' % (k,a,b), part=True  )
895          ok = False
896
897      a = ( da['rlat']['_data'][0], da['rlat']['_data'][-1], da['rlon']['_data'][0], da['rlon']['_data'][-1] )
898      b = map( lambda x: self.pcfg.rotatedPoleGrids[domain][x], ['s','n','w','e'] )
899      mm = []
900      for i in range(4):
901        if abs(a[i] - b[i]) > self.pcfg.gridSpecTol:
902          mm.append( (a[i],b[i]) )
903
904      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 )
905
906      for k in ['rlat','rlon']:
907        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 )
908
909      if ok:
910        self.log_pass()
911
912  def do_check_intd(self):
913    varName = self.var
914    domain = self.domain
915    da = self.da
916    va = self.va
917    if domain[-1] == 'i':
918      self.checkId = ('004','regular_grid_attributes')
919      self.test( 'lat' in da.keys() and 'lon' in da.keys(), 'lat and lon not found (required for interpolated data)', abort=True, part=True )
920
921      atDict = {'lat':{'long_name':"latitude", 'standard_name':"latitude", 'units':"degrees_north", '_type':'float64'},
922                'lon':{'long_name':"longitude", 'standard_name':"longitude", 'units':"degrees_east", '_type':'float64'} }
923      mm = []
924      for k in ['lat','lon']:
925        for k2 in atDict[k].keys():
926          if atDict[k][k2] != da[k].get(k2, None ):
927            mm.append( (k,k2) )
928            record = '#@ax=%s;%s=%s|%s=%s <uncomment if correct>' % (k,k2,da[k].get(k2, '__missing__'),k2,atDict[k][k2]   )
929            self.parent.amapListDraft.append( record )
930
931      self.test( len(mm) == 0,  'Required attributes of grid coordinate arrays not correct: %s' % str(mm), part=True )
932
933      ok = True
934      self.checkId = ('005','regular_grid_domain')
935      for k in ['lat','lon']:
936        res = len(da[k]['_data']) >= self.pcfg.interpolatedGrids[domain][ {'lat':'nlat','lon':'nlon' }[k] ]
937        if not res:
938          a,b =  len(da[k]['_data']), self.pcfg.interpolatedGrids[domain][ {'lat':'nlat','lon':'nlon' }[k] ]
939          self.test( res, 'Size of %s dimension does not match specification (%s,%s)' % (k,a,b), part=True )
940          ok = False
941
942      a = ( da['lat']['_data'][0], da['lat']['_data'][-1], da['lon']['_data'][0], da['lon']['_data'][-1] )
943      b = map( lambda x: self.pcfg.interpolatedGrids[domain][x], ['s','n','w','e'] )
944      rs = self.pcfg.interpolatedGrids[domain]['res']
945      c = [-rs,rs,-rs,rs]
946      mm = []
947      for i in range(4):
948        if a[i] != b[i]:
949          x = (a[i]-b[i])/c[i]
950          if x < 0 or abs( x - int(x) ) > 0.001:
951             skipThis = False
952             if self.project  == 'CORDEX':
953               if domain[:3] == 'ANT':
954                 if i == 2 and abs( a[i] - 0.25 ) < 0.001:
955                    skipThis = True
956                 elif i == 3 and abs( a[i] - 359.75 ) < 0.001:
957                    skipThis = True
958             if not skipThis:
959               mm.append( (a[i],b[i]) )
960
961      ok &= self.test( len(mm) == 0, 'Interpolated grid boundary error: File %s; Req. %s' % (str(a),str(b)), part=True )
962
963      for k in ['lat','lon']:
964        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 )
965      if ok:
966        self.log_pass()
967
968class mipVocab(object):
969
970  def __init__(self,pcfg,dummy=False):
971     self.pcfg = pcfg
972     if dummy:
973       self.dummyMipTable()
974     elif pcfg.varTables=='CMIP':
975       self.ingestMipTables()
976     elif pcfg.varTables=='FLAT':
977       self.flatTable()
978   
979  def ingestMipTables(self):
980     dir, tl, vgmap, fnpat = self.pcfg.mipVocabPars
981     ms = mipTableScan()
982     self.varInfo = {}
983     self.varcons = {}
984     for f in tl:
985        vg = vgmap.get( f, f )
986        self.varcons[vg] = {}
987        fn = fnpat % f
988        ll = open( '%s%s' % (dir,fn) ).readlines()
989        ee = ms.scan_table(ll,None,asDict=True)
990        for v in ee.keys():
991## set global default: type float
992          eeee = { 'type':self.pcfg.defaults.get( 'variableDataType', 'float' ) }
993          eeee['_dimension'] = ee[v][0]
994          ar = []
995          ac = []
996          for a in ee[v][1].keys():
997            eeee[a] = ee[v][1][a]
998          ##if 'positive' in eeee.keys():
999            ##ar.append( 'positive' )
1000            ##ac.append( 'positive' )
1001          self.varInfo[v] = {'ar':ar, 'ac':ac }
1002          self.varcons[vg][v] = eeee
1003           
1004  def dummyMipTable(self):
1005     self.varInfo = {}
1006     self.varcons = {}
1007     ee = { 'standard_name':'sn%s', 'long_name':'n%s', 'units':'1' }
1008     dir, tl, vgmap, fnpat = self.pcfg.mipVocabPars
1009     for f in tl:
1010        vg = vgmap.get( f, f )
1011        self.varcons[vg] = {}
1012        for i in range(12):
1013          v = 'v%s' % i
1014          eeee = {}
1015          eeee['standard_name'] = ee['standard_name'] % i
1016          eeee['long_name'] = ee['long_name'] % i
1017          eeee['cell_methods'] = 'time: point'
1018          eeee['units'] = ee['units']
1019          eeee['type'] = 'float'
1020          ar = []
1021          ac = []
1022          self.varInfo[v] = {'ar':ar, 'ac':ac }
1023          self.varcons[vg][v] = eeee
1024
1025  def flatTable(self):
1026     self.varInfo = {}
1027     self.varcons = {}
1028     dir, tl, vgm, fn = self.pcfg.mipVocabPars
1029     vg = vgm.keys()[0]
1030     ee = { 'standard_name':'sn%s', 'long_name':'n%s', 'units':'1' }
1031     ll = open( '%s%s' % (dir,fn) ).readlines()
1032     self.varcons[vg] = {}
1033     for l in ll:
1034       if l[0] != '#':
1035          dt, v, sn = string.split( string.strip(l) )
1036          self.pcfg.fnvdict[dt] = { 'v':v, 'sn':sn }
1037          ar = []
1038          ac = []
1039          self.varInfo[v] = {'ar':ar, 'ac':ac }
1040          self.varcons[vg][v] = {'standard_name':sn, 'type':'float' }
1041
1042  def lists( self, k, k2 ):
1043     if k2 == 'addRequiredAttributes':
1044       return self.varInfo[k]['ar']
1045     elif k2 == 'addControlledAttributes':
1046       return self.varInfo[k]['ac']
1047     else:
1048       raise baseException( 'mipVocab.lists called with bad list specifier %s' % k2 )
1049
1050  def isInTable( self, v, vg1 ):
1051    vg = vg1
1052    if vg == 'ESA':
1053      vg = 'ESACCI'
1054    assert vg in self.varcons.keys(), '%s not found in  self.varcons.keys() [%s]' % (vg,str(self.varcons.keys()) )
1055    return (v in self.varcons[vg].keys())
1056     
1057  def getAttr( self, v, vg1, a ):
1058    vg = vg1
1059    if vg == 'ESA':
1060      vg = 'ESACCI'
1061    assert vg in self.varcons.keys(), '%s not found in  self.varcons.keys()'
1062    assert v in self.varcons[vg].keys(), '%s not found in self.varcons[%s].keys()' % (v,vg)
1063     
1064    return self.varcons[vg][v][a]
1065     
1066class patternControl(object):
1067
1068  def __init__(self,tag,pattern,list=None,cls=None,examples=None,badExamples=None,runTest=True):
1069    if cls != None:
1070      assert cls in ['ISO'], 'value of cls [%s] not recognised' % cls
1071      if cls == 'ISO':
1072        assert pattern in ['ISO8601 duration'], 'value of pattern [%s] for ISO constraint not recognised' % pattern
1073        if pattern == 'ISO8601 duration':
1074          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)$'
1075        self.re_pat = re.compile( thispat )
1076        self.pattern = thispat
1077        self.pattern_src = pattern
1078    else:
1079      try:
1080        self.re_pat = re.compile( pattern )
1081      except:
1082        print "Failed to compile pattern >>%s<< (%s)" % (pattern, tag)
1083      self.pattern = pattern
1084   
1085    self.examples = examples
1086    self.badExamples = badExamples
1087    self.list = list
1088    self.cls = cls
1089
1090    if runTest:
1091      if examples != None:
1092        for e in examples:
1093          assert self.check(e), 'Internal check failed: example %s does not fit pattern %s' % (e,self.pattern)
1094
1095  def check(self,val):
1096    self.note = '-'
1097    m = self.re_pat.match( val )
1098    if self.list == None:
1099      self.note = "simple test"
1100      return m != None
1101    else:
1102      if m == None:
1103        self.note = "no match %s::%s" % (val,self.pattern)
1104        return False
1105      if not m.groupdict().has_key("val"):
1106        self.note = "no 'val' in match"
1107        return False
1108      self.note = "val=%s" % m.groupdict()["val"]
1109      return m.groupdict()["val"] in self.list
1110   
1111class listControl(object):
1112  def __init__(self,tag,list,split=False,splitVal=None,enumeration=False):
1113    self.list = list
1114    self.tag = tag
1115    self.split = split
1116    self.splitVal = splitVal
1117    self.enumeration = enumeration
1118    self.etest = re.compile( '(.*)<([0-9]+(,[0-9]+)*)>' )
1119    self.essplit = re.compile(r'(?:[^\s,<]|<(?:\\.|[^>])*>)+')
1120
1121  def check(self,val):
1122    self.note = '-'
1123    if len(self.list) < 4:
1124      self.note = str( self.list )
1125    else:
1126      self.note = str( self.list[:4] )
1127    if self.split:
1128      if self.splitVal == None:
1129        vs = string.split( val )
1130      elif self.enumeration:
1131        vs = map( string.strip, self.essplit.findall( val ) )
1132      else:
1133        vs = map( string.strip, string.split( val, self.splitVal ) )
1134    else:
1135      vs = [val,]
1136    if self.enumeration:
1137      vs2 = []
1138      for v in vs:
1139        m = self.etest.findall( v )
1140        if m in [None,[]]:
1141          vs2.append( v )
1142        else:
1143          opts = string.split( m[0][1], ',' )
1144          for o in opts:
1145            vs2.append( '%s%s' % (m[0][0],o) )
1146      vs = vs2[:]
1147       
1148    return all( map( lambda x: x in self.list, vs ) )
1149
1150
1151class checkByVar(checkBase):
1152  """Run some checks on groups of files with a common variable. Checks for continuity of time in group"""
1153
1154  def init(self,fileNameSeparator='_'):
1155    self.id = 'C5.001'
1156    self.checkId = 'unset'
1157    self.step = 'Initialised'
1158    self.checks = (self.checkTrange,)
1159    self.fnsep = fileNameSeparator
1160
1161  def setLogDict( self,fLogDict ):
1162    self.fLogDict = fLogDict
1163
1164  def impt(self,flist):
1165    """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.
1166     :param flist: List of file names.
1167
1168 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."""
1169    ee = {}
1170    elist = []
1171    for f in flist:
1172      fn = string.split(f, '/' )[-1]
1173      fnParts = string.split( fn[:-3], self.fnsep )
1174     
1175      try:
1176        if self.pcfg.freqIndex != None:
1177          freq = fnParts[self.pcfg.freqIndex]
1178        else:
1179          freq = None
1180
1181        group = fnParts[ self.pcfg.groupIndex ]
1182
1183        if self.parent.fileIsFixed:
1184          trange = None
1185        else:
1186          trange = string.split( fnParts[-1], '-' )
1187        var = fnParts[self.pcfg.varIndex]
1188        thisKey = string.join( fnParts[:-1], '.' )
1189        if group not in ee.keys():
1190          ee[group] = {}
1191        if thisKey not in ee[group].keys():
1192          ee[group][thisKey] = []
1193        ee[group][thisKey].append( (f,fn,group,trange) )
1194      except:
1195        print 'Cannot parse file name: %s' % (f) 
1196        elist.append(f)
1197## this ee entry is not used, except in bookkeeping check below.
1198## parsing of file name is repeated later, and a error log entry is created at that stage -- this could be improved.
1199## 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.
1200        group = '__error__'
1201        thisKey = fn
1202        if group not in ee.keys():
1203          ee[group] = {}
1204        if thisKey not in ee[group].keys():
1205          ee[group][thisKey] = []
1206        ee[group][thisKey].append( (f,fn,group) )
1207
1208    nn = len(flist)
1209    n2 = 0
1210    for k in ee.keys():
1211      for k2 in ee[k].keys():
1212        n2 += len( ee[k][k2] )
1213
1214    assert nn==n2, 'some file lost!!!!!!'
1215    if len(elist) == 0:
1216      self.info =  '%s files, %s' % (nn,str(ee.keys()) )
1217    else:
1218      self.info =  '%s files, %s frequencies, severe errors in file names: %s' % (nn,len(ee.keys()),len(elist) )
1219      for e in elist:
1220        self.info += '\n%s' % e
1221    self.ee = ee
1222
1223  def check(self, recorder=None,calendar='None',norun=False):
1224    self.errorCount = 0
1225    self.recorder=recorder
1226    self.calendar=calendar
1227    if calendar == '360-day':
1228      self.enddec = 30
1229    else:
1230      self.enddec = 31
1231    mm = { 'enddec':self.enddec }
1232    self.pats = {'mon':('(?P<d>[0-9]{3})101','(?P<e>[0-9]{3})012'), \
1233            'sem':('(?P<d>[0-9]{3})(012|101)','(?P<e>[0-9]{3})(011|010)'), \
1234            'day':('(?P<d>[0-9]{3}[16])0101','(?P<e>[0-9]{3}[50])12%(enddec)s' % mm), \
1235            '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 ), \
1236            'subd2':('(?P<d>[0-9]{4})0101(?P<h1>[0-9]{2})', '(?P<e>[0-9]{4})010100' ) }
1237
1238    if not norun:
1239      self.runChecks()
1240
1241  def checkTrange(self):
1242    """Manage time range checks: loop over groups of files identified by :meth:`impt`"""
1243    keys = self.ee.keys()
1244    keys.sort()
1245    for k in keys:
1246      if k not in ['fx','fixed']:
1247        keys2 = self.ee[k].keys()
1248        keys2.sort()
1249        for k2 in keys2:
1250          self.checkThisTrange( self.ee[k][k2], k )
1251
1252  def checkThisTrange( self, tt, group):
1253    """Check consistency across a list of time ranges"""
1254
1255    if group in ['3hr','6hr']:
1256       kg = 'subd'
1257    else:
1258       kg = group
1259    ps = self.pats[kg]
1260    rere = (re.compile( ps[0] ), re.compile( ps[1] ) )
1261
1262    n = len(tt)
1263    self.checkId = ('001','filename_timerange_value')
1264    for j in range(n):
1265      if self.monitor != None:
1266         nofh0 = self.monitor.get_open_fds()
1267      t = tt[j]
1268      fn = t[1]
1269      isFirst = j == 0
1270      isLast = j == n-1
1271      lok = True
1272      for i in [0,1]:
1273        if not (i==0 and isFirst or i==1 and isLast):
1274          x = rere[i].match( t[3][i] )
1275          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) )
1276        if not lok:
1277          if self.recorder != None:
1278            self.recorder.modify( t[1], 'ERROR: time range' )
1279      if self.monitor != None:
1280         nofh9 = self.monitor.get_open_fds()
1281         if nofh9 > nofh0:
1282           print 'Open file handles: %s --- %s [%s]' % (nofh0, nofh9, j )
1283
1284### http://stackoverflow.com/questions/2023608/check-what-files-are-open-in-python
1285class sysMonitor(object):
1286
1287  def __init__(self):
1288    self.fhCountMax = 0
1289
1290  def get_open_fds(self):
1291    '''
1292    return the number of open file descriptors for current process
1293    .. warning: will only work on UNIX-like os-es.
1294    '''
1295    import subprocess
1296    import os
1297
1298    pid = os.getpid()
1299    self.procs = subprocess.check_output( 
1300        [ "lsof", '-w', '-Ff', "-p", str( pid ) ] )
1301
1302    self.ps = filter( 
1303            lambda s: s and s[ 0 ] == 'f' and s[1: ].isdigit(),
1304            self.procs.split( '\n' ) )
1305    self.fhCountMax = max( self.fhCountMax, len(self.ps) )
1306    return len( self.ps )
Note: See TracBrowser for help on using the repository browser.