/usr/lib/python2.7/dist-packages/drslib/drs.py is in python-drslib 0.3.0a3-5build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 | # BSD Licence
# Copyright (c) 2010, Science & Technology Facilities Council (STFC)
# All rights reserved.
#
# See the LICENSE file in the source distribution of this software for
# the full license text.
'''
The drs module contains a minimal model class for DRS information
and some utility functions for converting filesystem paths to and from
DRS objects.
More sophisticated conversions can be done with the
:mod:`drslib.translate` and :mod:`drslib.cmip5` modules.
'''
import os
import itertools
import re
import logging
log = logging.getLogger(__name__)
DRS_ATTRS = ['activity', 'product', 'institute', 'model', 'experiment', 'frequency',
'realm', 'table', 'ensemble', 'version', 'variable', 'subset', 'extended']
PUB_ATTRS = ['activity', 'product', 'institute', 'model', 'experiment', 'frequency',
'realm', 'table', 'ensemble', ]
class DRS(dict):
"""
Represents a DRS entry. DRS objects are dictionaries where DRS
components are also exposed as attributes. Therefore you can get/set
DRS components using dictionary or attribute notation.
In combination with the translator machinary, this class maintains
consistency between the path and filename portion of the DRS.
:ivar activity: string
:ivar product: string
:ivar institute: string
:ivar model: string
:ivar experiment: string
:ivar frequency: string
:ivar realm: string
:ivar variable: string
:ivar table: string of None
:ivar ensemble: (r, i, p)
:ivar version: integer
:ivar subset: (N1, N2, clim) where N1 and N2 are (y, m, d, h, mn)
and clim is boolean
:ivar extended: A string containing miscellaneous stuff. Useful for
representing irregular CMIP3 files
"""
def __init__(self, *argv, **kwargs):
"""
Instantiate a DRS object with a set of DRS component values.
>>> mydrs = DRS(activity='cmip5', product='output', model='HadGEM1',
... experiment='1pctto4x', variable='tas')
<DRS activity="cmip5" product="output" model="HadGEM1" ...>
:param argv: If not () should be a DRS object to instantiate from
:param kwargs: DRS component values.
"""
# Initialise all components as None
for attr in DRS_ATTRS:
self[attr] = None
# Check only DRS components are used
for kw in kwargs:
if kw not in DRS_ATTRS:
raise KeyError("Keyword %s is not a DRS component" % repr(kw))
# Use dict flexible instantiation
super(DRS, self).__init__(*argv, **kwargs)
def __getattr__(self, attr):
if attr in DRS_ATTRS:
return self[attr]
else:
raise AttributeError('%s object has no attribute %s' %
(repr(type(self).__name__), repr(attr)))
def __setattr__(self, attr, value):
if attr in DRS_ATTRS:
self[attr] = value
else:
raise AttributeError('%s is not a DRS component' % repr(attr))
def is_complete(self):
"""Returns boolean to indicate if all components are specified.
Returns ``True`` if all components except ``extended`` have a value.
"""
for attr in DRS_ATTRS:
if attr is 'extended':
continue
if self.get(attr, None) is None:
return False
return True
def is_publish_level(self):
"""Returns boolian to indicate if the all publish-level components are
specified.
"""
for attr in PUB_ATTRS:
if self.get(attr, None) is None:
return False
return True
def __repr__(self):
kws = []
for attr in DRS_ATTRS:
kws.append(self._encode_component(attr))
# Remove trailing '%' from components
while kws[-1] == '%':
kws.pop(-1)
return '<DRS %s>' % '.'.join(kws)
def _encode_component(self, attr):
"""
Encode a DRS component as a string. Components that are None
are encoded as '%'.
"""
from drslib.translate import _to_date, _from_date
#!TODO: this code overlaps serialisation code in translate.py
if self[attr] is None:
val = '%'
elif attr is 'ensemble':
val = self._encode_ensemble()
elif attr is 'version':
val = 'v%d' % self.version
elif attr is 'subset':
N1, N2, clim = self.subset
if clim:
val = '%s-%s-clim' % (_from_date(N1), _from_date(N2))
else:
val = '%s-%s' % (_from_date(N1), _from_date(N2))
else:
val = self[attr]
return val
def _encode_ensemble(self):
r, i, p = self.ensemble
ret = 'r%d' % r
if i is not None:
ret += 'i%d' % i
if p is not None:
ret += 'p%d' % p
return ret
def to_dataset_id(self, with_version=False):
"""
Return the esgpublish dataset_id for this drs object.
If version is not None and with_version=True the version is included.
"""
parts = [self._encode_component(x) for x in PUB_ATTRS]
if self.version and with_version:
parts.append(self._encode_component('version'))
return '.'.join(parts)
@classmethod
def from_dataset_id(klass, dataset_id, **components):
"""
Return a DRS object fro a ESG Publisher dataset_id.
If the dataset_id contains less than 10 components all trailing
components are set to None. Any component of value '%' is set to None
E.g.
>>> drs = DRS.from_dataset_id('cmip5.output.MOHC.%.rpc45')
>>> drs.institute, drs.model, drs.experiment, drs.realm
('MOHC', None, 'rpc45', None)
"""
parts = dataset_id.split('.')
for attr, val in zip(DRS_ATTRS, parts):
if val is '%':
continue
if attr is 'ensemble':
r, i, p = re.match(r'r(\d+)i(\d+)p(\d+)', val).groups()
components[attr] = (int(r), int(i), int(p))
elif attr is 'version':
v = re.match(r'v(\d+)', val).group(1)
components[attr] = int(v)
# Don't process after version
break
else:
components[attr] = val
return klass(**components)
#--------------------------------------------------------------------------
# A more lightweight way of getting the DRS attributes from a path.
# This is effective for the path part of a DRS path but doesn't verify
# or parse the filename
#
def path_to_drs(drs_root, path, activity=None):
"""
Create a :class:`DRS` object from a filesystem path.
This function is more lightweight than using :mod:`drslib.translator`
but only works for the parts of the DRS explicitly represented in
a path.
:param drs_root: The root of the DRS tree.
This should point to the *activity* directory
:param path: The path to convert. This is either an absolute path
or is relative to the current working directory.
"""
nroot = drs_root.rstrip('/') + '/'
relpath = os.path.normpath(path[len(nroot):])
p = relpath.split('/')
attrs = ['product', 'institute', 'model', 'experiment',
'frequency', 'realm', 'table', 'ensemble']
drs = DRS(activity=activity)
for val, attr in zip(p, attrs):
if attr == 'ensemble':
mo = re.match(r'r(\d+)i(\d+)p(\d+)', val)
drs[attr] = tuple(int(x) for x in mo.groups())
else:
drs[attr] = val
log.debug('%s => %s' % (repr(path), drs))
return drs
def drs_to_path(drs_root, drs):
"""
Returns a directory path from a :class:`DRS` object. Any DRS component
that is set to None will result in a wildcard '*' element in the path.
This function does not take into account of MIP tables of filenames.
:param drs_root: The root of the DRS tree. This should point to
the *activity* directory
:param drs: The :class:`DRS` object from which to generate the path
"""
attrs = ['product', 'institute', 'model', 'experiment',
'frequency', 'realm', 'table', 'ensemble']
path = [drs_root]
for attr in attrs:
if drs[attr] is None:
val = '*'
else:
if attr == 'ensemble':
val = 'r%di%dp%d' % drs.ensemble
else:
val = drs[attr]
if val is None:
break
path.append(val)
#!DEBUG
assert len(path) == len(attrs)+1
path = os.path.join(*path)
log.debug('%s => %s' % (drs, repr(path)))
return path
|