mirror of
https://github.com/borgbackup/borg.git
synced 2026-04-23 07:07:52 -04:00
convert most print() calls to logging
the logging level varies: most is logging.info(), in some place logging.warning() or logging.error() are used when the condition is clearly an error or warning. in other cases, we keep using print, but force writing to sys.stderr, unless we interact with the user. there were 77 calls to print before this commit, now there are 7, most of which in the archiver module, which interacts directly with the user. in one case there, we still use print() only because logging is not setup properly yet during argument parsing. it could be argued that commands like info or list should use print directly, but we have converted them anyways, without ill effects on the unit tests unit tests still use print() in some places this switches all informational output to stderr, which should help with, if not fix jborg/attic#312 directly
This commit is contained in:
Antoine Beaupré
parent
c996fd8366
commit
09ffbb1d9d
6 changed files with 83 additions and 63 deletions
|
|
@ -2,6 +2,8 @@ from datetime import datetime
|
|||
from getpass import getuser
|
||||
from itertools import groupby
|
||||
import errno
|
||||
import logging
|
||||
|
||||
from .key import key_factory
|
||||
from .remote import cache_if_remote
|
||||
import msgpack
|
||||
|
|
@ -650,7 +652,7 @@ class ArchiveChecker:
|
|||
def report_progress(self, msg, error=False):
|
||||
if error:
|
||||
self.error_found = True
|
||||
print(msg, file=sys.stderr if error else sys.stdout)
|
||||
logging.log(logging.ERROR if error else logging.WARNING, msg)
|
||||
|
||||
def identify_key(self, repository):
|
||||
cdata = repository.get(next(self.chunks.iteritems())[0])
|
||||
|
|
|
|||
|
|
@ -7,6 +7,7 @@ from operator import attrgetter
|
|||
import functools
|
||||
import inspect
|
||||
import io
|
||||
import logging
|
||||
import os
|
||||
import signal
|
||||
import stat
|
||||
|
|
@ -46,15 +47,11 @@ class Archiver:
|
|||
def print_error(self, msg, *args):
|
||||
msg = args and msg % args or msg
|
||||
self.exit_code = 1
|
||||
print('borg: ' + msg, file=sys.stderr)
|
||||
logging.error('borg: ' + msg)
|
||||
|
||||
def print_verbose(self, msg, *args, **kw):
|
||||
if self.verbose:
|
||||
msg = args and msg % args or msg
|
||||
if kw.get('newline', True):
|
||||
print(msg)
|
||||
else:
|
||||
print(msg, end=' ')
|
||||
msg = args and msg % args or msg
|
||||
logging.info(msg)
|
||||
|
||||
def do_serve(self, args):
|
||||
"""Start in server mode. This command is usually not used manually.
|
||||
|
|
@ -63,7 +60,7 @@ class Archiver:
|
|||
|
||||
def do_init(self, args):
|
||||
"""Initialize an empty repository"""
|
||||
print('Initializing repository at "%s"' % args.repository.orig)
|
||||
logging.info('Initializing repository at "%s"' % args.repository.orig)
|
||||
repository = self.open_repository(args.repository, create=True, exclusive=True)
|
||||
key = key_creator(repository, args)
|
||||
manifest = Manifest(key, repository)
|
||||
|
|
@ -85,9 +82,9 @@ Type "Yes I am sure" if you understand this and want to continue.\n""")
|
|||
if input('Do you want to continue? ') == 'Yes I am sure':
|
||||
break
|
||||
if not args.archives_only:
|
||||
print('Starting repository check...')
|
||||
logging.info('Starting repository check...')
|
||||
if repository.check(repair=args.repair):
|
||||
print('Repository check complete, no problems found.')
|
||||
logging.info('Repository check complete, no problems found.')
|
||||
else:
|
||||
return 1
|
||||
if not args.repo_only and not ArchiveChecker().check(
|
||||
|
|
@ -163,15 +160,15 @@ Type "Yes I am sure" if you understand this and want to continue.\n""")
|
|||
if args.stats:
|
||||
t = datetime.now()
|
||||
diff = t - t0
|
||||
print('-' * 78)
|
||||
print('Archive name: %s' % args.archive.archive)
|
||||
print('Archive fingerprint: %s' % hexlify(archive.id).decode('ascii'))
|
||||
print('Start time: %s' % t0.strftime('%c'))
|
||||
print('End time: %s' % t.strftime('%c'))
|
||||
print('Duration: %s' % format_timedelta(diff))
|
||||
print('Number of files: %d' % archive.stats.nfiles)
|
||||
logging.info('-' * 78)
|
||||
logging.info('Archive name: %s' % args.archive.archive)
|
||||
logging.info('Archive fingerprint: %s' % hexlify(archive.id).decode('ascii'))
|
||||
logging.info('Start time: %s' % t0.strftime('%c'))
|
||||
logging.info('End time: %s' % t.strftime('%c'))
|
||||
logging.info('Duration: %s' % format_timedelta(diff))
|
||||
logging.info('Number of files: %d' % archive.stats.nfiles)
|
||||
archive.stats.print_('This archive:', cache)
|
||||
print('-' * 78)
|
||||
logging.info('-' * 78)
|
||||
return self.exit_code
|
||||
|
||||
def _process(self, archive, cache, excludes, exclude_caches, skip_inodes, path, restrict_dev,
|
||||
|
|
@ -250,7 +247,7 @@ Type "Yes I am sure" if you understand this and want to continue.\n""")
|
|||
"""Extract archive contents"""
|
||||
# be restrictive when restoring files, restore permissions later
|
||||
if sys.getfilesystemencoding() == 'ascii':
|
||||
print('Warning: File system encoding is "ascii", extracting non-ascii filenames will not be supported.')
|
||||
logging.warning('Warning: File system encoding is "ascii", extracting non-ascii filenames will not be supported.')
|
||||
repository = self.open_repository(args.archive)
|
||||
manifest, key = Manifest.load(repository)
|
||||
archive = Archive(repository, key, manifest, args.archive.archive,
|
||||
|
|
@ -318,17 +315,17 @@ Type "Yes I am sure" if you understand this and want to continue.\n""")
|
|||
if args.stats:
|
||||
stats.print_('Deleted data:', cache)
|
||||
else:
|
||||
print("You requested to completely DELETE the repository *including* all archives it contains:")
|
||||
logging.warning("You requested to completely DELETE the repository *including* all archives it contains:")
|
||||
for archive_info in manifest.list_archive_infos(sort_by='ts'):
|
||||
print(format_archive(archive_info))
|
||||
logging.warning(format_archive(archive_info))
|
||||
if not os.environ.get('BORG_CHECK_I_KNOW_WHAT_I_AM_DOING'):
|
||||
print("""Type "YES" if you understand this and want to continue.\n""")
|
||||
print("""Type "YES" if you understand this and want to continue.""")
|
||||
if input('Do you want to continue? ') != 'YES':
|
||||
self.exit_code = 1
|
||||
return self.exit_code
|
||||
repository.destroy()
|
||||
cache.destroy()
|
||||
print("Repository and corresponding cache were deleted.")
|
||||
logging.info("Repository and corresponding cache were deleted.")
|
||||
return self.exit_code
|
||||
|
||||
def do_mount(self, args):
|
||||
|
|
@ -366,7 +363,7 @@ Type "Yes I am sure" if you understand this and want to continue.\n""")
|
|||
archive = Archive(repository, key, manifest, args.src.archive)
|
||||
if args.short:
|
||||
for item in archive.iter_items():
|
||||
print(remove_surrogates(item[b'path']))
|
||||
logging.info(remove_surrogates(item[b'path']))
|
||||
else:
|
||||
tmap = {1: 'p', 2: 'c', 4: 'd', 6: 'b', 0o10: '-', 0o12: 'l', 0o14: 's'}
|
||||
for item in archive.iter_items():
|
||||
|
|
@ -391,13 +388,13 @@ Type "Yes I am sure" if you understand this and want to continue.\n""")
|
|||
extra = ' link to %s' % item[b'source']
|
||||
else:
|
||||
extra = ''
|
||||
print('%s%s %-6s %-6s %8d %s %s%s' % (
|
||||
logging.info('%s%s %-6s %-6s %8d %s %s%s' % (
|
||||
type, mode, item[b'user'] or item[b'uid'],
|
||||
item[b'group'] or item[b'gid'], size, format_time(mtime),
|
||||
remove_surrogates(item[b'path']), extra))
|
||||
else:
|
||||
for archive_info in manifest.list_archive_infos(sort_by='ts'):
|
||||
print(format_archive(archive_info))
|
||||
logging.info(format_archive(archive_info))
|
||||
return self.exit_code
|
||||
|
||||
def do_info(self, args):
|
||||
|
|
@ -407,13 +404,13 @@ Type "Yes I am sure" if you understand this and want to continue.\n""")
|
|||
cache = Cache(repository, key, manifest, do_files=args.cache_files)
|
||||
archive = Archive(repository, key, manifest, args.archive.archive, cache=cache)
|
||||
stats = archive.calc_stats(cache)
|
||||
print('Name:', archive.name)
|
||||
print('Fingerprint: %s' % hexlify(archive.id).decode('ascii'))
|
||||
print('Hostname:', archive.metadata[b'hostname'])
|
||||
print('Username:', archive.metadata[b'username'])
|
||||
print('Time: %s' % to_localtime(archive.ts).strftime('%c'))
|
||||
print('Command line:', remove_surrogates(' '.join(archive.metadata[b'cmdline'])))
|
||||
print('Number of files: %d' % stats.nfiles)
|
||||
logging.info('Name:', archive.name)
|
||||
logging.info('Fingerprint: %s' % hexlify(archive.id).decode('ascii'))
|
||||
logging.info('Hostname:', archive.metadata[b'hostname'])
|
||||
logging.info('Username:', archive.metadata[b'username'])
|
||||
logging.info('Time: %s' % to_localtime(archive.ts).strftime('%c'))
|
||||
logging.info('Command line:', remove_surrogates(' '.join(archive.metadata[b'cmdline'])))
|
||||
logging.info('Number of files: %d' % stats.nfiles)
|
||||
stats.print_('This archive:', cache)
|
||||
return self.exit_code
|
||||
|
||||
|
|
@ -496,10 +493,10 @@ Type "Yes I am sure" if you understand this and want to continue.\n""")
|
|||
if not args.topic:
|
||||
parser.print_help()
|
||||
elif args.topic in self.helptext:
|
||||
print(self.helptext[args.topic])
|
||||
logging.info(self.helptext[args.topic])
|
||||
elif args.topic in commands:
|
||||
if args.epilog_only:
|
||||
print(commands[args.topic].epilog)
|
||||
logging.info(commands[args.topic].epilog)
|
||||
elif args.usage_only:
|
||||
commands[args.topic].epilog = None
|
||||
commands[args.topic].print_help()
|
||||
|
|
@ -509,6 +506,21 @@ Type "Yes I am sure" if you understand this and want to continue.\n""")
|
|||
parser.error('No help available on %s' % (args.topic,))
|
||||
return self.exit_code
|
||||
|
||||
def setup_logging(self, args):
|
||||
logging.raiseExceptions = False
|
||||
l = logging.getLogger('')
|
||||
sh = logging.StreamHandler(sys.stderr)
|
||||
l.addHandler(sh)
|
||||
levels = { None: logging.WARNING,
|
||||
0: logging.WARNING,
|
||||
1: logging.INFO,
|
||||
2: logging.DEBUG }
|
||||
# default to INFO, --verbose turns into DEBUG
|
||||
# XXX: ideally, we'd default to being silent, that is only
|
||||
# show warnings and above, but we're retaining current output
|
||||
# for now.
|
||||
l.setLevel(levels[int(self.verbose)+1])
|
||||
|
||||
def preprocess_args(self, args):
|
||||
deprecations = [
|
||||
('--hourly', '--keep-hourly', 'Warning: "--hourly" has been deprecated. Use "--keep-hourly" instead.'),
|
||||
|
|
@ -518,16 +530,17 @@ Type "Yes I am sure" if you understand this and want to continue.\n""")
|
|||
('--yearly', '--keep-yearly', 'Warning: "--yearly" has been deprecated. Use "--keep-yearly" instead.')
|
||||
]
|
||||
if args and args[0] == 'verify':
|
||||
print('Warning: "borg verify" has been deprecated. Use "borg extract --dry-run" instead.')
|
||||
print('Warning: "borg verify" has been deprecated. Use "borg extract --dry-run" instead.', file=sys.stderr)
|
||||
args = ['extract', '--dry-run'] + args[1:]
|
||||
for i, arg in enumerate(args[:]):
|
||||
for old_name, new_name, warning in deprecations:
|
||||
if arg.startswith(old_name):
|
||||
args[i] = arg.replace(old_name, new_name)
|
||||
print(warning)
|
||||
print(warning, file=sys.stderr)
|
||||
return args
|
||||
|
||||
def run(self, args=None):
|
||||
# show all logging by default for starters
|
||||
check_extension_modules()
|
||||
keys_dir = get_keys_dir()
|
||||
if not os.path.exists(keys_dir):
|
||||
|
|
@ -908,6 +921,7 @@ Type "Yes I am sure" if you understand this and want to continue.\n""")
|
|||
|
||||
args = parser.parse_args(args or ['-h'])
|
||||
self.verbose = args.verbose
|
||||
self.setup_logging(args)
|
||||
os.umask(args.umask)
|
||||
RemoteRepository.remote_path = args.remote_path
|
||||
RemoteRepository.umask = args.umask
|
||||
|
|
@ -926,7 +940,7 @@ def sig_info_handler(signum, stack): # pragma: no cover
|
|||
total = loc['st'].st_size
|
||||
except Exception:
|
||||
pos, total = 0, 0
|
||||
print("{0} {1}/{2}".format(path, format_file_size(pos), format_file_size(total)))
|
||||
logging.warning("{0} {1}/{2}".format(path, format_file_size(pos), format_file_size(total)))
|
||||
break
|
||||
if func in ('extract_item', ): # extract op
|
||||
path = loc['item'][b'path']
|
||||
|
|
@ -934,7 +948,7 @@ def sig_info_handler(signum, stack): # pragma: no cover
|
|||
pos = loc['fd'].tell()
|
||||
except Exception:
|
||||
pos = 0
|
||||
print("{0} {1}/???".format(path, format_file_size(pos)))
|
||||
logging.warning("{0} {1}/???".format(path, format_file_size(pos)))
|
||||
break
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
from configparser import RawConfigParser
|
||||
from .remote import cache_if_remote
|
||||
import errno
|
||||
import logging
|
||||
import msgpack
|
||||
import os
|
||||
import stat
|
||||
|
|
@ -71,9 +72,9 @@ class Cache:
|
|||
self.close()
|
||||
|
||||
def _confirm(self, message, env_var_override=None):
|
||||
print(message, file=sys.stderr)
|
||||
logging.warning(message)
|
||||
if env_var_override and os.environ.get(env_var_override):
|
||||
print("Yes (From {})".format(env_var_override))
|
||||
logging.warning("Yes (From {})".format(env_var_override))
|
||||
return True
|
||||
if not sys.stdin.isatty():
|
||||
return False
|
||||
|
|
@ -253,7 +254,7 @@ class Cache:
|
|||
unpacker.feed(data)
|
||||
for item in unpacker:
|
||||
if not isinstance(item, dict):
|
||||
print('Error: Did not get expected metadata dict - archive corrupted!')
|
||||
logging.error('Error: Did not get expected metadata dict - archive corrupted!')
|
||||
continue
|
||||
if b'chunks' in item:
|
||||
for chunk_id, size, csize in item[b'chunks']:
|
||||
|
|
@ -274,10 +275,10 @@ class Cache:
|
|||
return name
|
||||
|
||||
def create_master_idx(chunk_idx):
|
||||
print('Synchronizing chunks cache...')
|
||||
logging.info('Synchronizing chunks cache...')
|
||||
cached_ids = cached_archives()
|
||||
archive_ids = repo_archives()
|
||||
print('Archives: %d, w/ cached Idx: %d, w/ outdated Idx: %d, w/o cached Idx: %d.' % (
|
||||
logging.info('Archives: %d, w/ cached Idx: %d, w/ outdated Idx: %d, w/o cached Idx: %d.' % (
|
||||
len(archive_ids), len(cached_ids),
|
||||
len(cached_ids - archive_ids), len(archive_ids - cached_ids), ))
|
||||
# deallocates old hashindex, creates empty hashindex:
|
||||
|
|
@ -289,12 +290,12 @@ class Cache:
|
|||
archive_name = lookup_name(archive_id)
|
||||
if archive_id in cached_ids:
|
||||
archive_chunk_idx_path = mkpath(archive_id)
|
||||
print("Reading cached archive chunk index for %s ..." % archive_name)
|
||||
logging.info("Reading cached archive chunk index for %s ..." % archive_name)
|
||||
archive_chunk_idx = ChunkIndex.read(archive_chunk_idx_path)
|
||||
else:
|
||||
print('Fetching and building archive index for %s ...' % archive_name)
|
||||
logging.info('Fetching and building archive index for %s ...' % archive_name)
|
||||
archive_chunk_idx = fetch_and_build_idx(archive_id, repository, self.key)
|
||||
print("Merging into master chunks index ...")
|
||||
logging.info("Merging into master chunks index ...")
|
||||
if chunk_idx is None:
|
||||
# we just use the first archive's idx as starting point,
|
||||
# to avoid growing the hash table from 0 size and also
|
||||
|
|
@ -302,7 +303,7 @@ class Cache:
|
|||
chunk_idx = archive_chunk_idx
|
||||
else:
|
||||
chunk_idx.merge(archive_chunk_idx)
|
||||
print('Done.')
|
||||
logging.info('Done.')
|
||||
return chunk_idx
|
||||
|
||||
def legacy_cleanup():
|
||||
|
|
|
|||
|
|
@ -5,6 +5,7 @@ import binascii
|
|||
from collections import namedtuple
|
||||
from functools import wraps
|
||||
import grp
|
||||
import logging
|
||||
import os
|
||||
import pwd
|
||||
import re
|
||||
|
|
@ -150,7 +151,7 @@ class Statistics:
|
|||
buf += "\n"
|
||||
buf += ' Unique chunks Total chunks'
|
||||
buf += 'Chunk index: %20d %20d' % (total_unique_chunks, total_chunks)
|
||||
print(buf)
|
||||
logging.info(buf)
|
||||
|
||||
def show_progress(self, item=None, final=False):
|
||||
if not final:
|
||||
|
|
@ -161,8 +162,8 @@ class Statistics:
|
|||
format_file_size(self.osize), format_file_size(self.csize), format_file_size(self.usize), path)
|
||||
else:
|
||||
msg = ' ' * 79
|
||||
print(msg, end='\r')
|
||||
sys.stdout.flush()
|
||||
print(msg, file=sys.stderr, end='\r')
|
||||
sys.stderr.flush()
|
||||
|
||||
|
||||
def get_keys_dir():
|
||||
|
|
|
|||
19
borg/key.py
19
borg/key.py
|
|
@ -1,6 +1,7 @@
|
|||
from binascii import hexlify, a2b_base64, b2a_base64
|
||||
import configparser
|
||||
import getpass
|
||||
import logging
|
||||
import os
|
||||
import msgpack
|
||||
import textwrap
|
||||
|
|
@ -88,7 +89,7 @@ class PlaintextKey(KeyBase):
|
|||
|
||||
@classmethod
|
||||
def create(cls, repository, args):
|
||||
print('Encryption NOT enabled.\nUse the "--encryption=repokey|keyfile|passphrase" to enable encryption.')
|
||||
logging.info('Encryption NOT enabled.\nUse the "--encryption=repokey|keyfile|passphrase" to enable encryption.')
|
||||
return cls(repository)
|
||||
|
||||
@classmethod
|
||||
|
|
@ -190,12 +191,12 @@ class Passphrase(str):
|
|||
if allow_empty or passphrase:
|
||||
passphrase2 = cls.getpass('Enter same passphrase again: ')
|
||||
if passphrase == passphrase2:
|
||||
print('Remember your passphrase. Your data will be inaccessible without it.')
|
||||
logging.info('Remember your passphrase. Your data will be inaccessible without it.')
|
||||
return passphrase
|
||||
else:
|
||||
print('Passphrases do not match')
|
||||
logging.warning('Passphrases do not match')
|
||||
else:
|
||||
print('Passphrase must not be blank')
|
||||
logging.warning('Passphrase must not be blank')
|
||||
|
||||
def __repr__(self):
|
||||
return '<Passphrase "***hidden***">'
|
||||
|
|
@ -215,8 +216,8 @@ class PassphraseKey(AESKeyBase):
|
|||
@classmethod
|
||||
def create(cls, repository, args):
|
||||
key = cls(repository)
|
||||
print('WARNING: "passphrase" mode is deprecated and will be removed in 1.0.')
|
||||
print('If you want something similar (but with less issues), use "repokey" mode.')
|
||||
logging.warning('WARNING: "passphrase" mode is deprecated and will be removed in 1.0.')
|
||||
logging.warning('If you want something similar (but with less issues), use "repokey" mode.')
|
||||
passphrase = Passphrase.new(allow_empty=False)
|
||||
key.init(repository, passphrase)
|
||||
return key
|
||||
|
|
@ -324,7 +325,7 @@ class KeyfileKeyBase(AESKeyBase):
|
|||
def change_passphrase(self):
|
||||
passphrase = Passphrase.new(allow_empty=True)
|
||||
self.save(self.target, passphrase)
|
||||
print('Key updated')
|
||||
logging.info('Key updated')
|
||||
|
||||
@classmethod
|
||||
def create(cls, repository, args):
|
||||
|
|
@ -335,8 +336,8 @@ class KeyfileKeyBase(AESKeyBase):
|
|||
key.init_ciphers()
|
||||
target = key.get_new_target(args)
|
||||
key.save(target, passphrase)
|
||||
print('Key in "%s" created.' % target)
|
||||
print('Keep this key safe. Your data will be inaccessible without it.')
|
||||
logging.info('Key in "%s" created.' % target)
|
||||
logging.info('Keep this key safe. Your data will be inaccessible without it.')
|
||||
return key
|
||||
|
||||
def save(self, target, passphrase):
|
||||
|
|
|
|||
|
|
@ -2,6 +2,7 @@ from configparser import RawConfigParser
|
|||
from binascii import hexlify
|
||||
from itertools import islice
|
||||
import errno
|
||||
import logging
|
||||
import os
|
||||
import shutil
|
||||
import struct
|
||||
|
|
@ -278,7 +279,7 @@ class Repository:
|
|||
def report_error(msg):
|
||||
nonlocal error_found
|
||||
error_found = True
|
||||
print(msg, file=sys.stderr)
|
||||
logging.error(msg)
|
||||
|
||||
assert not self._active_txn
|
||||
try:
|
||||
|
|
@ -566,7 +567,7 @@ class LoggedIO:
|
|||
with open(filename, 'rb') as fd:
|
||||
data = memoryview(fd.read())
|
||||
os.rename(filename, filename + '.beforerecover')
|
||||
print('attempting to recover ' + filename, file=sys.stderr)
|
||||
logging.info('attempting to recover ' + filename)
|
||||
with open(filename, 'wb') as fd:
|
||||
fd.write(MAGIC)
|
||||
while len(data) >= self.header_fmt.size:
|
||||
|
|
|
|||
Loading…
Reference in a new issue