/usr/share/pyshared/drslib/drs_command.py is in python-drslib 0.3.0a3-5.
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 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 | # BSD Licence
# Copyright (c) 2011, Science & Technology Facilities Council (STFC)
# All rights reserved.
#
# See the LICENSE file in the source distribution of this software for
# the full license text.
"""
Command-line access to drslib
"""
from __future__ import print_function
import sys, os
from optparse import OptionParser
from configparser import NoSectionError, NoOptionError
from drslib.drs_tree import DRSTree
from drslib import config
from drslib.drs import DRS
from drslib import p_cmip5
import logging
log = logging.getLogger(__name__)
usage = """\
usage: %prog [command] [options] [drs-pattern]
%prog --help
command:
list list publication-level datasets
todo show file operations pending for the next version
upgrade make changes to the selected datasets to upgrade to the next version.
mapfile make a mapfile of the selected dataset
history list all versions of the selected dataset
init initialise CMIP5 data for product detection
diff list differences between versions or between a version and the todo list
drs-pattern:
A dataset identifier in '.'-separated notation using '%' for wildcards
Run %prog --help for full list of options.
"""
def make_parser():
op = OptionParser(usage=usage)
op.add_option('-R', '--root', action='store',
help='Root directory of the DRS tree')
op.add_option('-I', '--incoming', action='store',
help='Incoming directory for DRS files. Defaults to <root>/%s' % config.DEFAULT_INCOMING)
for attr in ['activity', 'product', 'institute', 'model', 'experiment',
'frequency', 'realm']:
op.add_option('-%s'%attr[0], '--%s'% attr, action='store',
help='Set DRS attribute %s for dataset discovery'%attr)
op.add_option('-v', '--version', action='store',
help='Force version upgrades to this version')
op.add_option('-P', '--profile', action='store',
metavar='FILE',
help='Profile the script exectuion into FILE')
# p_cmip5 options
op.add_option('--detect-product', action='store_true',
help='Automatically detect the DRS product of incoming data')
op.add_option('--shelve-dir', action='store',
help='Location of the p_cmip5 data directory')
op.add_option('--p-cmip5-config', action='store',
help='Location of model-specific configuration file for p_cmip5')
op.add_option('-M', '--move-cmd', action='store',
help='Set the command used to move files into the DRS structure')
return op
class Command(object):
def __init__(self, opts, args):
self.opts = opts
self.args = args
self.shelve_dir = None
self.p_cmip5_config = None
self.drs_root = None
self.drs_tree = None
self.make_drs_tree()
def _config_p_cmip5(self):
"""
Ensure self.shelve_dir is set. This is required for InitCommand
and any command that uses p_cmip5.
"""
self.shelve_dir = self.opts.shelve_dir
if self.shelve_dir is None:
try:
self.shelve_dir = config.config.get('p_cmip5', 'shelve-dir')
except NoSectionError:
raise Exception("Shelve directory not specified. Please use --shelve-dir or set shelve_dir via metaconfig")
def _setup_p_cmip5(self):
"""
Instantiate the p_cmip5.cmip5_product object ready for deducing
the product component.
"""
shelves = p_cmip5.init._find_shelves(self.shelve_dir)
self.p_cmip5_config = self.opts.p_cmip5_config
if self.p_cmip5_config is None:
try:
self.p_cmip5_config = config.config.get('p_cmip5', 'config')
except (NoSectionError, NoOptionError):
raise Exception("p_cmip5 configuration file not specified. Please use --p-cmip5-config or set via metaconfig")
self.drs_tree.set_p_cmip5(p_cmip5.product.cmip5_product(
mip_table_shelve=shelves['stdo_mip'],
template=shelves['template'],
stdo=shelves['stdo'],
config=self.p_cmip5_config,
not_ok_excpt=True))
def make_drs_tree(self):
if self.opts.root:
self.drs_root = self.opts.root
else:
try:
self.drs_root = config.drs_defaults['root']
except KeyError:
raise Exception('drs-root not defined')
if self.opts.incoming:
incoming = self.opts.incoming
else:
try:
incoming = config.drs_defaults['incoming']
except KeyError:
incoming = os.path.join(self.drs_root, config.DEFAULT_INCOMING)
self.drs_tree = DRSTree(self.drs_root)
if self.opts.move_cmd:
self.drs_tree.set_move_cmd(self.opts.move_cmd)
kwargs = {}
for attr in ['activity', 'product', 'institute', 'model', 'experiment',
'frequency', 'realm', 'ensemble']:
try:
val = getattr(self.opts, attr)
# val may be there but None
if val is None:
raise AttributeError
except AttributeError:
val = config.drs_defaults.get(attr)
kwargs[attr] = val
# Get the template DRS from args
if self.args:
dataset_id = self.args.pop(0)
drs = DRS.from_dataset_id(dataset_id, **kwargs)
else:
drs = DRS(**kwargs)
# Product detection
if self.opts.detect_product:
self._config_p_cmip5()
self._setup_p_cmip5()
self.drs_tree.discover(incoming, **drs)
def do(self):
raise NotImplementedError("Unimplemented command")
def print_header(self):
print("""\
==============================================================================
DRS Tree at %s
------------------------------------------------------------------------------\
""" % self.drs_root)
def print_sep(self):
print("""\
------------------------------------------------------------------------------\
""")
def print_footer(self):
print("""\
==============================================================================\
""")
class ListCommand(Command):
def do(self):
self.print_header()
to_upgrade = 0
for k in sorted(self.drs_tree.pub_trees):
pt = self.drs_tree.pub_trees[k]
todo = pt.count_todo()
if todo:
state_msg = '%d:%d %d:%d' % (pt.count(), pt.size(), todo, pt.todo_size())
else:
state_msg = '%d:%d' % (pt.count(), pt.size())
if pt.state != pt.STATE_VERSIONED:
to_upgrade += 1
#!TODO: print update summary
print('%-70s %s' % (pt.version_drs().to_dataset_id(with_version=True), state_msg))
if self.drs_tree.incomplete:
self.print_sep()
print('Incompletely specified incoming datasets')
self.print_sep()
for dataset_id in sorted(self.drs_tree.incomplete_dataset_ids()):
print('%-70s' % dataset_id)
if to_upgrade:
self.print_sep()
print('%d datasets awaiting upgrade' % to_upgrade)
self.print_footer()
class TodoCommand(Command):
def do(self):
self.print_header()
first = True
for k in sorted(self.drs_tree.pub_trees):
pt = self.drs_tree.pub_trees[k]
if pt.count_todo() == 0:
if not first:
self.print_sep()
print('Nothing todo for %s' % pt.drs.to_dataset_id())
first = False
continue
if self.opts.version:
next_version = int(self.opts.version)
else:
next_version = pt._next_version()
todos = pt.list_todo(next_version)
if not first:
self.print_sep()
print("Publisher Tree %s todo for version %d" % (pt.drs.to_dataset_id(),
next_version))
first = False
print()
print('\n'.join(todos))
self.print_footer()
class UpgradeCommand(Command):
def do(self):
self.print_header()
for k in sorted(self.drs_tree.pub_trees):
pt = self.drs_tree.pub_trees[k]
if self.opts.version:
next_version = int(self.opts.version)
else:
next_version = pt._next_version()
if pt.state == pt.STATE_VERSIONED:
print('Publisher Tree %s has no pending upgrades' % pt.drs.to_dataset_id())
else:
print(('Upgrading %s to version %d ...' % (pt.drs.to_dataset_id(), next_version)), end=' ')
to_process = pt.count_todo()
pt.do_version(next_version)
print('done %d' % to_process)
self.print_footer()
class MapfileCommand(Command):
def do(self):
"""
Generate a mapfile from the selection. The selection must be for
only 1 realm-tree.
"""
if len(self.drs_tree.pub_trees) != 1:
raise Exception("You must select 1 dataset to create a mapfile. %d selected" %
len(self.drs_tree.pub_trees))
if len(self.drs_tree.pub_trees) == 0:
raise Exception("No datasets selected")
pt = list(self.drs_tree.pub_trees.values())[0]
#!TODO: better argument handling
if self.args:
version = int(self.args[0])
else:
version = pt.latest
if version not in pt.versions:
log.warning("PublisherTree %s has no version %d, skipping" % (pt.drs.to_dataset_id(), version))
else:
#!TODO: Alternative to stdout?
pt.version_to_mapfile(version)
class HistoryCommand(Command):
def do(self):
"""
List all versions of a selected dataset.
"""
if len(self.drs_tree.pub_trees) != 1:
raise Exception("You must select 1 dataset to list history. %d selected" % len(self.drs_tree.pub_trees))
pt = list(self.drs_tree.pub_trees.values())[0]
self.print_header()
print("History of %s" % pt.drs.to_dataset_id())
self.print_sep()
for version in sorted(pt.versions, reverse=True):
vdrs = DRS(pt.drs, version=version)
print(vdrs.to_dataset_id(with_version=True))
self.print_footer()
class InitCommand(Command):
def make_drs_tree(self):
"""No need to initialise the drs tree for this command.
"""
pass
def do(self):
self._config_p_cmip5()
from drslib.p_cmip5.init import init
init(self.shelve_dir, config.table_path)
print("CMIP5 configuration data written to %s" % repr(self.shelve_dir))
class DiffCommand(Command):
"""
Accepts 0-2 arguments. If no arguments given lists the diff between
the latest version and the todo list. If 1 given lists the diff
between that version and the todo list. If 2 given lists the diff
between these versions.
"""
def do(self):
if len(self.drs_tree.pub_trees) != 1:
raise Exception("You must select 1 dataset to view differences. %d selected" %
len(self.drs_tree.pub_trees))
if len(self.drs_tree.pub_trees) == 0:
raise Exception("No datasets selected")
pt =list(self.drs_tree.pub_trees.values())[0]
#!TODO: better argument handling
args = self.args[:]
if not args:
v1 = pt.latest
v2 = None
else:
v1 = int(args.pop(0))
if args:
v2 = int(args.pop(0))
else:
v2 = None
# Yields DIFF_STATE, file1, file2
self.print_header()
if v2:
v2_msg = v2
else:
v2_msg = 'todo list'
print('Diff between %s and %s' % (v1, v2_msg))
self.print_sep()
#!FIXME: Just compare file sizes at the moment!
for diff_type, f1, f2 in pt.diff_version(v1, v2):
filename = os.path.basename(f1 or f2)
if diff_type == pt.DIFF_NONE:
continue
# Don't compare by path if using the todo list
elif (v2 is not None) and (diff_type & pt.DIFF_PATH == pt.DIFF_PATH):
print('PATH\t\t%s' % filename)
elif diff_type & pt.DIFF_SIZE == pt.DIFF_SIZE:
print('SIZE\t\t%s' % filename)
elif diff_type & pt.DIFF_TRACKING_ID == pt.DIFF_TRACKING_ID:
print('TRACKING_ID\t%s' % filename)
elif diff_type & pt.DIFF_V1_ONLY == pt.DIFF_V1_ONLY:
print('%s\t\t%s' % (v1, filename))
elif diff_type & pt.DIFF_V2_ONLY == pt.DIFF_V2_ONLY:
print('%s\t\t%s' % (v2_msg, filename))
else:
assert False
self.print_footer()
def run(op, command, opts, args):
if command == 'list':
c = ListCommand(opts, args)
elif command == 'todo':
c = TodoCommand(opts, args)
elif command == 'upgrade':
c = UpgradeCommand(opts, args)
elif command == 'mapfile':
c = MapfileCommand(opts, args)
elif command == 'history':
c = HistoryCommand(opts, args)
elif command == 'init':
c = InitCommand(opts, args)
elif command == 'diff':
c = DiffCommand(opts, args)
else:
op.error("Unrecognised command %s" % command)
c.do()
def main(argv=sys.argv):
op = make_parser()
try:
command = argv[1]
except IndexError:
op.error("command not specified")
#!FIXME: better global vs. per-command help
if command in ['-h', '--help']:
opts, args = op.parse_args(argv[1:2])
else:
opts, args = op.parse_args(argv[2:])
if opts.profile:
import cProfile
cProfile.runctx('run(op, command, opts, args)', globals(), locals(), opts.profile)
else:
return run(op, command, opts, args)
if __name__ == '__main__':
main()
|