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

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

updates for glob snow

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