Source code for duplicity.statistics

# -*- Mode:Python; indent-tabs-mode:nil; tab-width:4; encoding:utf-8 -*-
# Copyright 2002 Ben Escoto <>
# Copyright 2007 Kenneth Loafman <>
# This file is part of duplicity.
# Duplicity 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.
# Duplicity is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with duplicity; if not, write to the Free Software Foundation,
# Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

u"""Generate and process backup statistics"""
from __future__ import division

from builtins import zip
from builtins import map
from builtins import str
from builtins import object

import re
import time
import os

from duplicity import config
from duplicity import dup_time

[docs]class StatsException(Exception): pass
[docs]class StatsObj(object): u"""Contains various statistics, provide string conversion functions""" # used when quoting files in get_stats_line space_regex = re.compile(u" ") stat_file_attrs = (u'SourceFiles', u'SourceFileSize', u'NewFiles', u'NewFileSize', u'DeletedFiles', u'ChangedFiles', u'ChangedFileSize', u'ChangedDeltaSize', u'DeltaEntries', u'RawDeltaSize') stat_misc_attrs = (u'Errors', u'TotalDestinationSizeChange') stat_time_attrs = (u'StartTime', u'EndTime', u'ElapsedTime') stat_attrs = ((u'Filename',) + stat_time_attrs + stat_misc_attrs + stat_file_attrs) # Below, the second value in each pair is true iff the value # indicates a number of bytes stat_file_pairs = ((u'SourceFiles', False), (u'SourceFileSize', True), (u'NewFiles', False), (u'NewFileSize', True), (u'DeletedFiles', False), (u'ChangedFiles', False), (u'ChangedFileSize', True), (u'ChangedDeltaSize', True), (u'DeltaEntries', False), (u'RawDeltaSize', True)) # This is used in get_byte_summary_string below byte_abbrev_list = ((1024 * 1024 * 1024 * 1024, u"TB"), (1024 * 1024 * 1024, u"GB"), (1024 * 1024, u"MB"), (1024, u"KB"))
[docs] def __init__(self): u"""Set attributes to None""" for attr in self.stat_attrs: self.__dict__[attr] = None
[docs] def get_stat(self, attribute): u"""Get a statistic""" return self.__dict__[attribute]
[docs] def set_stat(self, attr, value): u"""Set attribute to given value""" self.__dict__[attr] = value
[docs] def increment_stat(self, attr): u"""Add 1 to value of attribute""" self.__dict__[attr] += 1
[docs] def get_stats_line(self, index, use_repr=1): u"""Return one line abbreviated version of full stats string""" file_attrs = [str(self.get_stat(a)) for a in self.stat_file_attrs] if not index: filename = u"." else: filename = os.path.join(*index) if use_repr: # use repr to quote newlines in relative filename, then # take of leading and trailing quote and quote spaces. filename = self.space_regex.sub(u"\\\\x20", repr(filename)) n = 1 if filename[0] == u'u': n = 2 filename = filename[n:-1] return u" ".join([filename, ] + file_attrs)
[docs] def set_stats_from_line(self, line): u"""Set statistics from given line""" def error(): raise StatsException(u"Bad line '%s'" % line) if line[-1] == u"\n": line = line[:-1] lineparts = line.split(u" ") if len(lineparts) < len(self.stat_file_attrs): error() for attr, val_string in zip(self.stat_file_attrs, lineparts[-len(self.stat_file_attrs):]): try: val = int(val_string) except ValueError: try: val = float(val_string) except ValueError: error() self.set_stat(attr, val) return self
[docs] def get_stats_string(self): u"""Return extended string printing out statistics""" return u"%s%s%s" % (self.get_timestats_string(), self.get_filestats_string(), self.get_miscstats_string())
[docs] def get_timestats_string(self): u"""Return portion of statistics string dealing with time""" timelist = [] if self.StartTime is not None: timelist.append(u"StartTime %.2f (%s)\n" % # pylint: disable=bad-string-format-type (self.StartTime, dup_time.timetopretty(self.StartTime))) if self.EndTime is not None: timelist.append(u"EndTime %.2f (%s)\n" % # pylint: disable=bad-string-format-type (self.EndTime, dup_time.timetopretty(self.EndTime))) if self.ElapsedTime or (self.StartTime is not None and # pylint:disable=access-member-before-definition self.EndTime is not None): if self.ElapsedTime is None: # pylint:disable=access-member-before-definition self.ElapsedTime = self.EndTime - self.StartTime timelist.append(u"ElapsedTime %.2f (%s)\n" % (self.ElapsedTime, dup_time.inttopretty(self.ElapsedTime))) return u"".join(timelist)
[docs] def get_filestats_string(self): u"""Return portion of statistics string about files and bytes""" def fileline(stat_file_pair): u"""Return zero or one line of the string""" attr, in_bytes = stat_file_pair val = self.get_stat(attr) if val is None: return u"" if in_bytes: return u"%s %s (%s)\n" % (attr, val, self.get_byte_summary_string(val)) else: return u"%s %s\n" % (attr, val) return u"".join(map(fileline, self.stat_file_pairs))
[docs] def get_miscstats_string(self): u"""Return portion of extended stat string about misc attributes""" misc_string = u"" tdsc = self.TotalDestinationSizeChange if tdsc is not None: misc_string += (u"TotalDestinationSizeChange %s (%s)\n" % (tdsc, self.get_byte_summary_string(tdsc))) if self.Errors is not None: misc_string += u"Errors %d\n" % self.Errors return misc_string
[docs] def get_byte_summary_string(self, byte_count): u"""Turn byte count into human readable string like "7.23GB" """ if byte_count < 0: sign = u"-" byte_count = -byte_count else: sign = u"" for abbrev_bytes, abbrev_string in self.byte_abbrev_list: if byte_count >= abbrev_bytes: # Now get 3 significant figures abbrev_count = float(byte_count) / abbrev_bytes if abbrev_count >= 100: precision = 0 elif abbrev_count >= 10: precision = 1 else: precision = 2 return u"%s%%.%df %s" % (sign, precision, abbrev_string) \ % (abbrev_count,) byte_count = round(byte_count) if byte_count == 1: return sign + u"1 byte" else: return u"%s%d bytes" % (sign, byte_count)
[docs] def get_stats_logstring(self, title): u"""Like get_stats_string, but add header and footer""" header = u"--------------[ %s ]--------------" % title footer = u"-" * len(header) return u"%s\n%s%s\n" % (header, self.get_stats_string(), footer)
[docs] def set_stats_from_string(self, s): u"""Initialize attributes from string, return self for convenience""" def error(line): raise StatsException(u"Bad line '%s'" % line) for line in s.split(u"\n"): if not line: continue line_parts = line.split() if len(line_parts) < 2: error(line) attr, value_string = line_parts[:2] if attr not in self.stat_attrs: error(line) try: try: val1 = int(value_string) except ValueError: val1 = None val2 = float(value_string) if val1 == val2: self.set_stat(attr, val1) # use integer val else: self.set_stat(attr, val2) # use float except ValueError: error(line) return self
[docs] def write_stats_to_path(self, path): u"""Write statistics string to given path""" fin ="w") fin.write(self.get_stats_string()) assert not fin.close()
[docs] def read_stats_from_path(self, path): u"""Set statistics from path, return self for convenience""" fp ="r") self.set_stats_from_string( assert not fp.close() return self
[docs] def stats_equal(self, s): u"""Return true if s has same statistics as self""" assert isinstance(s, StatsObj) for attr in self.stat_file_attrs: if self.get_stat(attr) != s.get_stat(attr): return None return 1
[docs] def set_to_average(self, statobj_list): u"""Set self's attributes to average of those in statobj_list""" for attr in self.stat_attrs: self.set_stat(attr, 0) for statobj in statobj_list: for attr in self.stat_attrs: if statobj.get_stat(attr) is None: self.set_stat(attr, None) elif self.get_stat(attr) is not None: self.set_stat(attr, statobj.get_stat(attr) + self.get_stat(attr)) # Don't compute average starting/stopping time self.StartTime = None self.EndTime = None for attr in self.stat_attrs: if self.get_stat(attr) is not None: self.set_stat(attr, self.get_stat(attr) / float(len(statobj_list))) return self
[docs] def get_statsobj_copy(self): u"""Return new StatsObj object with same stats as self""" s = StatsObj() for attr in self.stat_attrs: s.set_stat(attr, self.get_stat(attr)) return s
[docs]class StatsDeltaProcess(StatsObj): u"""Keep track of statistics during DirDelta process"""
[docs] def __init__(self): u"""StatsDeltaProcess initializer - zero file attributes""" StatsObj.__init__(self) for attr in StatsObj.stat_file_attrs: self.__dict__[attr] = 0 self.Errors = 0 self.StartTime = time.time() self.files_changed = []
[docs] def add_new_file(self, path): u"""Add stats of new file path to statistics""" filesize = path.getsize() self.SourceFiles += 1 # SourceFileSize is added-to incrementally as read self.NewFiles += 1 self.NewFileSize += filesize self.DeltaEntries += 1 self.add_delta_entries_file(path, b'new')
[docs] def add_changed_file(self, path): u"""Add stats of file that has changed since last backup""" filesize = path.getsize() self.SourceFiles += 1 # SourceFileSize is added-to incrementally as read self.ChangedFiles += 1 self.ChangedFileSize += filesize self.DeltaEntries += 1 self.add_delta_entries_file(path, b'changed')
[docs] def add_deleted_file(self, path): u"""Add stats of file no longer in source directory""" self.DeletedFiles += 1 # can't add size since not available self.DeltaEntries += 1 self.add_delta_entries_file(path, b'deleted')
[docs] def add_unchanged_file(self, path): u"""Add stats of file that hasn't changed since last backup""" filesize = path.getsize() self.SourceFiles += 1 self.SourceFileSize += filesize
[docs] def close(self): u"""End collection of data, set EndTime""" self.EndTime = time.time()
[docs] def add_delta_entries_file(self, path, action_type): if not config.no_files_changed and path.isreg(): self.files_changed.append((path.get_relative_path(), action_type))
[docs] def get_delta_entries_file(self): return self.files_changed