cli.py 21.2 KB
Newer Older
Iustin Pop's avatar
Iustin Pop committed
1
#
Iustin Pop's avatar
Iustin Pop committed
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
#

# Copyright (C) 2006, 2007 Google Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.


"""Module dealing with command line parsing"""


import sys
import textwrap
import os.path
import copy
29
import time
30
from cStringIO import StringIO
Iustin Pop's avatar
Iustin Pop committed
31
32
33
34
35

from ganeti import utils
from ganeti import logger
from ganeti import errors
from ganeti import constants
36
from ganeti import opcodes
Iustin Pop's avatar
Iustin Pop committed
37
from ganeti import luxi
38
from ganeti import ssconf
Iustin Pop's avatar
Iustin Pop committed
39
40

from optparse import (OptionParser, make_option, TitledHelpFormatter,
Iustin Pop's avatar
Iustin Pop committed
41
                      Option, OptionValueError)
Iustin Pop's avatar
Iustin Pop committed
42

Iustin Pop's avatar
Iustin Pop committed
43
__all__ = ["DEBUG_OPT", "NOHDR_OPT", "SEP_OPT", "GenericMain",
44
           "SubmitOpCode", "GetClient",
45
           "cli_option", "GenerateTable", "AskUser",
Iustin Pop's avatar
Iustin Pop committed
46
           "ARGS_NONE", "ARGS_FIXED", "ARGS_ATLEAST", "ARGS_ANY", "ARGS_ONE",
47
           "USEUNITS_OPT", "FIELDS_OPT", "FORCE_OPT", "SUBMIT_OPT",
48
           "ListTags", "AddTags", "RemoveTags", "TAG_SRC_OPT",
49
           "FormatError", "SplitNodeOption", "SubmitOrSend",
50
           "JobSubmittedException", "FormatTimestamp",
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
           ]


def _ExtractTagsObject(opts, args):
  """Extract the tag type object.

  Note that this function will modify its args parameter.

  """
  if not hasattr(opts, "tag_type"):
    raise errors.ProgrammerError("tag_type not passed to _ExtractTagsObject")
  kind = opts.tag_type
  if kind == constants.TAG_CLUSTER:
    retval = kind, kind
  elif kind == constants.TAG_NODE or kind == constants.TAG_INSTANCE:
    if not args:
Iustin Pop's avatar
Iustin Pop committed
67
      raise errors.OpPrereqError("no arguments passed to the command")
68
69
70
71
72
73
74
    name = args.pop(0)
    retval = kind, name
  else:
    raise errors.ProgrammerError("Unhandled tag type '%s'" % kind)
  return retval


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
def _ExtendTags(opts, args):
  """Extend the args if a source file has been given.

  This function will extend the tags with the contents of the file
  passed in the 'tags_source' attribute of the opts parameter. A file
  named '-' will be replaced by stdin.

  """
  fname = opts.tags_source
  if fname is None:
    return
  if fname == "-":
    new_fh = sys.stdin
  else:
    new_fh = open(fname, "r")
  new_data = []
  try:
    # we don't use the nice 'new_data = [line.strip() for line in fh]'
    # because of python bug 1633941
    while True:
      line = new_fh.readline()
      if not line:
        break
      new_data.append(line.strip())
  finally:
    new_fh.close()
  args.extend(new_data)


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
def ListTags(opts, args):
  """List the tags on a given object.

  This is a generic implementation that knows how to deal with all
  three cases of tag objects (cluster, node, instance). The opts
  argument is expected to contain a tag_type field denoting what
  object type we work on.

  """
  kind, name = _ExtractTagsObject(opts, args)
  op = opcodes.OpGetTags(kind=kind, name=name)
  result = SubmitOpCode(op)
  result = list(result)
  result.sort()
  for tag in result:
    print tag


def AddTags(opts, args):
  """Add tags on a given object.

  This is a generic implementation that knows how to deal with all
  three cases of tag objects (cluster, node, instance). The opts
  argument is expected to contain a tag_type field denoting what
  object type we work on.

  """
  kind, name = _ExtractTagsObject(opts, args)
132
  _ExtendTags(opts, args)
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
  if not args:
    raise errors.OpPrereqError("No tags to be added")
  op = opcodes.OpAddTags(kind=kind, name=name, tags=args)
  SubmitOpCode(op)


def RemoveTags(opts, args):
  """Remove tags from a given object.

  This is a generic implementation that knows how to deal with all
  three cases of tag objects (cluster, node, instance). The opts
  argument is expected to contain a tag_type field denoting what
  object type we work on.

  """
  kind, name = _ExtractTagsObject(opts, args)
149
  _ExtendTags(opts, args)
150
151
152
153
154
  if not args:
    raise errors.OpPrereqError("No tags to be removed")
  op = opcodes.OpDelTags(kind=kind, name=name, tags=args)
  SubmitOpCode(op)

Iustin Pop's avatar
Iustin Pop committed
155
156
157
158
159
160
161
162
163

DEBUG_OPT = make_option("-d", "--debug", default=False,
                        action="store_true",
                        help="Turn debugging on")

NOHDR_OPT = make_option("--no-headers", default=False,
                        action="store_true", dest="no_headers",
                        help="Don't display column headers")

164
SEP_OPT = make_option("--separator", default=None,
Iustin Pop's avatar
Iustin Pop committed
165
166
167
168
169
170
171
172
                      action="store", dest="separator",
                      help="Separator between output fields"
                      " (defaults to one space)")

USEUNITS_OPT = make_option("--human-readable", default=False,
                           action="store_true", dest="human_readable",
                           help="Print sizes in human readable format")

173
FIELDS_OPT = make_option("-o", "--output", dest="output", action="store",
174
175
                         type="string", help="Comma separated list of"
                         " output fields",
176
177
                         metavar="FIELDS")

178
179
180
FORCE_OPT = make_option("-f", "--force", dest="force", action="store_true",
                        default=False, help="Force the operation")

181
182
183
TAG_SRC_OPT = make_option("--from", dest="tags_source",
                          default=None, help="File with tag names")

184
185
186
187
188
SUBMIT_OPT = make_option("--submit", dest="submit_only",
                         default=False, action="store_true",
                         help="Submit the job and return the job ID, but"
                         " don't wait for the job to finish")

189

Iustin Pop's avatar
Iustin Pop committed
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
def ARGS_FIXED(val):
  """Macro-like function denoting a fixed number of arguments"""
  return -val


def ARGS_ATLEAST(val):
  """Macro-like function denoting a minimum number of arguments"""
  return val


ARGS_NONE = None
ARGS_ONE = ARGS_FIXED(1)
ARGS_ANY = ARGS_ATLEAST(0)


def check_unit(option, opt, value):
Iustin Pop's avatar
Iustin Pop committed
206
207
208
  """OptParsers custom converter for units.

  """
Iustin Pop's avatar
Iustin Pop committed
209
210
211
  try:
    return utils.ParseUnit(value)
  except errors.UnitParseError, err:
212
    raise OptionValueError("option %s: %s" % (opt, err))
Iustin Pop's avatar
Iustin Pop committed
213
214
215


class CliOption(Option):
Iustin Pop's avatar
Iustin Pop committed
216
217
218
  """Custom option class for optparse.

  """
Iustin Pop's avatar
Iustin Pop committed
219
220
221
222
223
224
225
226
227
  TYPES = Option.TYPES + ("unit",)
  TYPE_CHECKER = copy.copy(Option.TYPE_CHECKER)
  TYPE_CHECKER["unit"] = check_unit


# optparse.py sets make_option, so we do it for our own option class, too
cli_option = CliOption


228
def _ParseArgs(argv, commands, aliases):
Iustin Pop's avatar
Iustin Pop committed
229
230
231
232
233
234
235
236
  """Parses the command line and return the function which must be
  executed together with its arguments

  Arguments:
    argv: the command line

    commands: dictionary with special contents, see the design doc for
    cmdline handling
237
    aliases: dictionary with command aliases {'alias': 'target, ...}
238

Iustin Pop's avatar
Iustin Pop committed
239
240
241
242
243
244
245
246
247
248
249
250
  """
  if len(argv) == 0:
    binary = "<command>"
  else:
    binary = argv[0].split("/")[-1]

  if len(argv) > 1 and argv[1] == "--version":
    print "%s (ganeti) %s" % (binary, constants.RELEASE_VERSION)
    # Quit right away. That way we don't have to care about this special
    # argument. optparse.py does it the same.
    sys.exit(0)

251
  if len(argv) < 2 or not (argv[1] in commands or
Guido Trotter's avatar
Guido Trotter committed
252
                           argv[1] in aliases):
Iustin Pop's avatar
Iustin Pop committed
253
254
255
256
257
258
259
    # let's do a nice thing
    sortedcmds = commands.keys()
    sortedcmds.sort()
    print ("Usage: %(bin)s {command} [options...] [argument...]"
           "\n%(bin)s <command> --help to see details, or"
           " man %(bin)s\n" % {"bin": binary})
    # compute the max line length for cmd + usage
260
    mlen = max([len(" %s" % cmd) for cmd in commands])
Iustin Pop's avatar
Iustin Pop committed
261
262
263
264
    mlen = min(60, mlen) # should not get here...
    # and format a nice command list
    print "Commands:"
    for cmd in sortedcmds:
265
      cmdstr = " %s" % (cmd,)
266
      help_text = commands[cmd][4]
Iustin Pop's avatar
Iustin Pop committed
267
      help_lines = textwrap.wrap(help_text, 79-3-mlen)
268
      print "%-*s - %s" % (mlen, cmdstr, help_lines.pop(0))
Iustin Pop's avatar
Iustin Pop committed
269
270
271
272
      for line in help_lines:
        print "%-*s   %s" % (mlen, "", line)
    print
    return None, None, None
273
274

  # get command, unalias it, and look it up in commands
Iustin Pop's avatar
Iustin Pop committed
275
  cmd = argv.pop(1)
276
277
278
279
280
281
282
283
284
285
286
  if cmd in aliases:
    if cmd in commands:
      raise errors.ProgrammerError("Alias '%s' overrides an existing"
                                   " command" % cmd)

    if aliases[cmd] not in commands:
      raise errors.ProgrammerError("Alias '%s' maps to non-existing"
                                   " command '%s'" % (cmd, aliases[cmd]))

    cmd = aliases[cmd]

Iustin Pop's avatar
Iustin Pop committed
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
  func, nargs, parser_opts, usage, description = commands[cmd]
  parser = OptionParser(option_list=parser_opts,
                        description=description,
                        formatter=TitledHelpFormatter(),
                        usage="%%prog %s %s" % (cmd, usage))
  parser.disable_interspersed_args()
  options, args = parser.parse_args()
  if nargs is None:
    if len(args) != 0:
      print >> sys.stderr, ("Error: Command %s expects no arguments" % cmd)
      return None, None, None
  elif nargs < 0 and len(args) != -nargs:
    print >> sys.stderr, ("Error: Command %s expects %d argument(s)" %
                         (cmd, -nargs))
    return None, None, None
  elif nargs >= 0 and len(args) < nargs:
    print >> sys.stderr, ("Error: Command %s expects at least %d argument(s)" %
                         (cmd, nargs))
    return None, None, None

  return func, options, args


310
311
312
313
314
315
316
317
318
319
def SplitNodeOption(value):
  """Splits the value of a --node option.

  """
  if value and ':' in value:
    return value.split(':', 1)
  else:
    return (value, None)


320
321
def AskUser(text, choices=None):
  """Ask the user a question.
Iustin Pop's avatar
Iustin Pop committed
322
323

  Args:
324
    text - the question to ask.
Iustin Pop's avatar
Iustin Pop committed
325

326
327
328
329
330
331
332
333
    choices - list with elements tuples (input_char, return_value,
    description); if not given, it will default to: [('y', True,
    'Perform the operation'), ('n', False, 'Do no do the operation')];
    note that the '?' char is reserved for help

  Returns: one of the return values from the choices list; if input is
  not possible (i.e. not running with a tty, we return the last entry
  from the list
Iustin Pop's avatar
Iustin Pop committed
334
335

  """
336
337
338
339
340
341
342
343
344
345
346
347
348
349
  if choices is None:
    choices = [('y', True, 'Perform the operation'),
               ('n', False, 'Do not perform the operation')]
  if not choices or not isinstance(choices, list):
    raise errors.ProgrammerError("Invalid choiches argument to AskUser")
  for entry in choices:
    if not isinstance(entry, tuple) or len(entry) < 3 or entry[0] == '?':
      raise errors.ProgrammerError("Invalid choiches element to AskUser")

  answer = choices[-1][1]
  new_text = []
  for line in text.splitlines():
    new_text.append(textwrap.fill(line, 70, replace_whitespace=False))
  text = "\n".join(new_text)
Iustin Pop's avatar
Iustin Pop committed
350
  try:
351
    f = file("/dev/tty", "a+")
Iustin Pop's avatar
Iustin Pop committed
352
  except IOError:
353
    return answer
Iustin Pop's avatar
Iustin Pop committed
354
  try:
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
    chars = [entry[0] for entry in choices]
    chars[-1] = "[%s]" % chars[-1]
    chars.append('?')
    maps = dict([(entry[0], entry[1]) for entry in choices])
    while True:
      f.write(text)
      f.write('\n')
      f.write("/".join(chars))
      f.write(": ")
      line = f.readline(2).strip().lower()
      if line in maps:
        answer = maps[line]
        break
      elif line == '?':
        for entry in choices:
          f.write(" %s - %s\n" % (entry[0], entry[2]))
        f.write("\n")
        continue
Iustin Pop's avatar
Iustin Pop committed
373
374
375
376
377
  finally:
    f.close()
  return answer


378
379
380
381
382
383
384
385
386
387
388
class JobSubmittedException(Exception):
  """Job was submitted, client should exit.

  This exception has one argument, the ID of the job that was
  submitted. The handler should print this ID.

  This is not an error, just a structured way to exit from clients.

  """


389
390
def SendJob(ops, cl=None):
  """Function to submit an opcode without waiting for the results.
Iustin Pop's avatar
Iustin Pop committed
391

392
393
394
395
396
  @type ops: list
  @param ops: list of opcodes
  @type cl: luxi.Client
  @param cl: the luxi client to use for communicating with the master;
             if None, a new client will be created
Iustin Pop's avatar
Iustin Pop committed
397
398

  """
Iustin Pop's avatar
Iustin Pop committed
399
  if cl is None:
400
    cl = GetClient()
401

402
403
404
405
406
  job_id = cl.SubmitJob(ops)

  return job_id


Michael Hanselmann's avatar
Michael Hanselmann committed
407
def PollJob(job_id, cl=None, feedback_fn=None):
408
409
410
411
412
413
414
415
416
417
418
  """Function to poll for the result of a job.

  @type job_id: job identified
  @param job_id: the job to poll for results
  @type cl: luxi.Client
  @param cl: the luxi client to use for communicating with the master;
             if None, a new client will be created

  """
  if cl is None:
    cl = GetClient()
419

420
421
422
  prev_job_info = None
  prev_logmsg_serial = None

423
  while True:
424
425
426
    result = cl.WaitForJobChange(job_id, ["status"], prev_job_info,
                                 prev_logmsg_serial)
    if not result:
427
      # job not found, go away!
428
      raise errors.JobLost("Job with id %s lost" % job_id)
429

430
431
432
433
434
435
436
437
438
439
440
441
442
    # Split result, a tuple of (field values, log entries)
    (job_info, log_entries) = result
    (status, ) = job_info

    if log_entries:
      for log_entry in log_entries:
        (serial, timestamp, _, message) = log_entry
        if callable(feedback_fn):
          feedback_fn(log_entry[1:])
        else:
          print "%s %s" % (time.ctime(utils.MergeTime(timestamp)), message)
        prev_logmsg_serial = max(prev_logmsg_serial, serial)

443
    # TODO: Handle canceled and archived jobs
444
    elif status in (constants.JOB_STATUS_SUCCESS, constants.JOB_STATUS_ERROR):
445
      break
446
447

    prev_job_info = job_info
448

449
  jobs = cl.QueryJobs([job_id], ["status", "opresult"])
450
451
  if not jobs:
    raise errors.JobLost("Job with id %s lost" % job_id)
452

453
454
  status, result = jobs[0]
  if status == constants.JOB_STATUS_SUCCESS:
455
    return result
456
457
  else:
    raise errors.OpExecError(result)
Iustin Pop's avatar
Iustin Pop committed
458
459


460
461
462
463
464
465
466
467
468
469
470
471
472
def SubmitOpCode(op, cl=None, feedback_fn=None):
  """Legacy function to submit an opcode.

  This is just a simple wrapper over the construction of the processor
  instance. It should be extended to better handle feedback and
  interaction functions.

  """
  if cl is None:
    cl = GetClient()

  job_id = SendJob([op], cl)

473
474
475
  op_results = PollJob(job_id, cl=cl, feedback_fn=feedback_fn)

  return op_results[0]
476
477


478
479
480
481
482
483
484
485
486
487
def SubmitOrSend(op, opts, cl=None, feedback_fn=None):
  """Wrapper around SubmitOpCode or SendJob.

  This function will decide, based on the 'opts' parameter, whether to
  submit and wait for the result of the opcode (and return it), or
  whether to just send the job and print its identifier. It is used in
  order to simplify the implementation of the '--submit' option.

  """
  if opts and opts.submit_only:
488
489
    job_id = SendJob([op], cl=cl)
    raise JobSubmittedException(job_id)
490
491
492
493
  else:
    return SubmitOpCode(op, cl=cl, feedback_fn=feedback_fn)


494
495
def GetClient():
  # TODO: Cache object?
496
497
498
499
500
501
502
503
504
505
506
  try:
    client = luxi.Client()
  except luxi.NoMasterError:
    master, myself = ssconf.GetMasterAndMyself()
    if master != myself:
      raise errors.OpPrereqError("This is not the master node, please connect"
                                 " to node '%s' and rerun the command" %
                                 master)
    else:
      raise
  return client
507
508


509
510
511
512
513
514
515
516
517
518
519
def FormatError(err):
  """Return a formatted error message for a given error.

  This function takes an exception instance and returns a tuple
  consisting of two values: first, the recommended exit code, and
  second, a string describing the error message (not
  newline-terminated).

  """
  retcode = 1
  obuf = StringIO()
520
  msg = str(err)
521
  if isinstance(err, errors.ConfigurationError):
522
523
524
    txt = "Corrupt configuration file: %s" % msg
    logger.Error(txt)
    obuf.write(txt + "\n")
525
526
527
528
529
530
531
532
533
534
535
536
    obuf.write("Aborting.")
    retcode = 2
  elif isinstance(err, errors.HooksAbort):
    obuf.write("Failure: hooks execution failed:\n")
    for node, script, out in err.args[0]:
      if out:
        obuf.write("  node: %s, script: %s, output: %s\n" %
                   (node, script, out))
      else:
        obuf.write("  node: %s, script: %s (no output)\n" %
                   (node, script))
  elif isinstance(err, errors.HooksFailure):
537
    obuf.write("Failure: hooks general failure: %s" % msg)
538
539
540
541
542
543
544
545
546
  elif isinstance(err, errors.ResolverError):
    this_host = utils.HostInfo.SysName()
    if err.args[0] == this_host:
      msg = "Failure: can't resolve my own hostname ('%s')"
    else:
      msg = "Failure: can't resolve hostname '%s'"
    obuf.write(msg % err.args[0])
  elif isinstance(err, errors.OpPrereqError):
    obuf.write("Failure: prerequisites not met for this"
547
               " operation:\n%s" % msg)
548
  elif isinstance(err, errors.OpExecError):
549
    obuf.write("Failure: command execution error:\n%s" % msg)
550
  elif isinstance(err, errors.TagError):
551
    obuf.write("Failure: invalid tag(s) given:\n%s" % msg)
552
  elif isinstance(err, errors.GenericError):
553
    obuf.write("Unhandled Ganeti error: %s" % msg)
554
555
  elif isinstance(err, luxi.NoMasterError):
    obuf.write("Cannot communicate with the master daemon.\nIs it running"
556
               " and listening for connections?")
557
558
559
560
561
562
  elif isinstance(err, luxi.TimeoutError):
    obuf.write("Timeout while talking to the master daemon. Error:\n"
               "%s" % msg)
  elif isinstance(err, luxi.ProtocolError):
    obuf.write("Unhandled protocol error while talking to the master daemon:\n"
               "%s" % msg)
563
564
565
  elif isinstance(err, JobSubmittedException):
    obuf.write("JobID: %s\n" % err.args[0])
    retcode = 0
566
  else:
567
    obuf.write("Unhandled exception: %s" % msg)
568
569
570
  return retcode, obuf.getvalue().rstrip('\n')


571
def GenericMain(commands, override=None, aliases=None):
Iustin Pop's avatar
Iustin Pop committed
572
573
  """Generic main function for all the gnt-* commands.

574
575
576
577
578
579
  Arguments:
    - commands: a dictionary with a special structure, see the design doc
                for command line handling.
    - override: if not None, we expect a dictionary with keys that will
                override command line options; this can be used to pass
                options from the scripts to generic functions
580
    - aliases: dictionary with command aliases {'alias': 'target, ...}
Iustin Pop's avatar
Iustin Pop committed
581
582
583
584
585
586
587
588
589
590
591
592
593
594

  """
  # save the program name and the entire command line for later logging
  if sys.argv:
    binary = os.path.basename(sys.argv[0]) or sys.argv[0]
    if len(sys.argv) >= 2:
      binary += " " + sys.argv[1]
      old_cmdline = " ".join(sys.argv[2:])
    else:
      old_cmdline = ""
  else:
    binary = "<unknown program>"
    old_cmdline = ""

595
596
597
598
  if aliases is None:
    aliases = {}

  func, options, args = _ParseArgs(sys.argv, commands, aliases)
Iustin Pop's avatar
Iustin Pop committed
599
600
601
  if func is None: # parse error
    return 1

602
603
604
605
  if override is not None:
    for key, val in override.iteritems():
      setattr(options, key, val)

Iustin Pop's avatar
Iustin Pop committed
606
607
  logger.SetupLogging(constants.LOG_COMMANDS, debug=options.debug,
                      stderr_logging=True, program=binary)
Iustin Pop's avatar
Iustin Pop committed
608

609
  utils.debug = options.debug
Iustin Pop's avatar
Iustin Pop committed
610
611
612
613
614
615
616

  if old_cmdline:
    logger.Info("run with arguments '%s'" % old_cmdline)
  else:
    logger.Info("run with no arguments")

  try:
617
    result = func(options, args)
618
  except (errors.GenericError, luxi.ProtocolError), err:
619
620
    result, err_msg = FormatError(err)
    logger.ToStderr(err_msg)
Iustin Pop's avatar
Iustin Pop committed
621
622

  return result
623
624


625
626
def GenerateTable(headers, fields, separator, data,
                  numfields=None, unitfields=None):
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
  """Prints a table with headers and different fields.

  Args:
    headers: Dict of header titles or None if no headers should be shown
    fields: List of fields to show
    separator: String used to separate fields or None for spaces
    data: Data to be printed
    numfields: List of fields to be aligned to right
    unitfields: List of fields to be formatted as units

  """
  if numfields is None:
    numfields = []
  if unitfields is None:
    unitfields = []

  format_fields = []
  for field in fields:
645
646
647
    if headers and field not in headers:
      raise errors.ProgrammerError("Missing header description for field '%s'"
                                   % field)
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
    if separator is not None:
      format_fields.append("%s")
    elif field in numfields:
      format_fields.append("%*s")
    else:
      format_fields.append("%-*s")

  if separator is None:
    mlens = [0 for name in fields]
    format = ' '.join(format_fields)
  else:
    format = separator.replace("%", "%%").join(format_fields)

  for row in data:
    for idx, val in enumerate(row):
      if fields[idx] in unitfields:
        try:
          val = int(val)
        except ValueError:
          pass
        else:
          val = row[idx] = utils.FormatUnit(val)
670
      val = row[idx] = str(val)
671
672
673
      if separator is None:
        mlens[idx] = max(mlens[idx], len(val))

674
  result = []
675
676
677
678
679
680
681
682
  if headers:
    args = []
    for idx, name in enumerate(fields):
      hdr = headers[name]
      if separator is None:
        mlens[idx] = max(mlens[idx], len(hdr))
        args.append(mlens[idx])
      args.append(hdr)
683
    result.append(format % tuple(args))
684
685
686
687
688
689
690

  for line in data:
    args = []
    for idx in xrange(len(fields)):
      if separator is None:
        args.append(mlens[idx])
      args.append(line[idx])
691
692
693
    result.append(format % tuple(args))

  return result
694
695
696
697
698
699
700
701
702
703
704
705


def FormatTimestamp(ts):
  """Formats a given timestamp.

  @type ts: timestamp
  @param ts: a timeval-type timestamp, a tuple of seconds and microseconds

  @rtype: string
  @returns: a string with the formatted timestamp

  """
706
707
  if not isinstance (ts, (tuple, list)) or len(ts) != 2:
    return '?'
708
709
  sec, usec = ts
  return time.strftime("%F %T", time.localtime(sec)) + ".%06d" % usec