Back In Time Development Documentation Release 1.1.12 Germar Reitze Nov 17, 2018 Contents 1 common 3 1.1 applicationinstance module.......................................3 1.2 askpass module..............................................4 1.3 backintime module............................................4 1.4 bcolors module..............................................7 1.5 cli module................................................7 1.6 config module..............................................8 1.7 configfile module............................................. 15 1.8 driveinfo module............................................. 21 1.9 dummytools module........................................... 21 1.10 encfstools module............................................ 22 1.11 exceptions module............................................ 23 1.12 guiapplicationinstance module...................................... 24 1.13 logger module.............................................. 24 1.14 mount module.............................................. 25 1.15 password module............................................. 32 1.16 password_ipc module.......................................... 33 1.17 pluginmanager module.......................................... 33 1.18 progress module............................................. 34 1.19 snapshotlog module........................................... 34 1.20 snapshots module............................................. 36 1.21 sshMaxArg module............................................ 47 1.22 sshtools module............................................. 48 1.23 tools module............................................... 51 2 Indices and tables 65 Python Module Index 67 i ii Back In Time Development Documentation, Release 1.1.12 Contents: Contents 1 Back In Time Development Documentation, Release 1.1.12 2 Contents CHAPTER 1 common 1.1 applicationinstance module class applicationinstance.ApplicationInstance(pidFile, autoExit=True, flock=False) Bases: object Class used to handle one application instance mechanism. Parameters • pidFile (str) – full path of file used to save pid and procname • autoExit (bool) – automatically call sys.exit if there is an other instance running • flock (bool) – use file-locks to make sure only one instance is checking at the same time busy() Check if one application with this instance is currently running. Returns True if an other instance is currently running. Return type bool check(autoExit=False) Check if the current application is already running Parameters autoExit (bool) – automatically call sys.exit if there is an other instance run- ning Returns True if this is the only application instance Return type bool exitApplication() Called when the single instance exit (remove pid file) flockExclusiv() Create an exclusive lock to block a second instance while the first instance is starting. 3 Back In Time Development Documentation, Release 1.1.12 flockUnlock() Remove the exclusive lock. Second instance can now continue but should find it self to be obsolete. readPidFile() Read the pid and procname from the file Returns tuple of (pid(int), procname(str)) Return type tuple startApplication() Called when the single instance starts to save its pid 1.2 askpass module 1.3 backintime module class backintime.PseudoAliasAction(option_strings, dest, nargs=None, const=None, de- fault=None, type=None, choices=None, required=False, help=None, metavar=None) Bases: argparse.Action Translate ‘–COMMAND’ into ‘COMMAND’ for backwards compatibility. backintime._mount(cfg) Mount external filesystems. Parameters cfg (config.Config) – config that should be used backintime._umount(cfg) Unmount external filesystems. Parameters cfg (config.Config) – config that should be used backintime.aliasParser(args) Call commands which where given with leading – for backwards compatibility. Parameters args (argparse.Namespace) – previously parsed arguments backintime.argParse(args) Parse arguments given on commandline. Parameters args (argparse.Namespace) – Namespace that should be enhanced or None Returns new parsed Namespace Return type argparser.Namespace backintime.backup(args, force=True) Command for force taking a new snapshot. Parameters • args (argparse.Namespace) – previously parsed arguments • force (bool) – take the snapshot even if it wouldn’t need to or would be prevented (e.g. running on battery) Raises SystemExit – 0 if successful, 1 if not 4 Chapter 1. common Back In Time Development Documentation, Release 1.1.12 backintime.backupJob(args) Command for taking a new snapshot in background. Mainly used for cronjobs. This will run the snapshot inside a daemon and detach from it. It will return immediately back to commandline. Parameters args (argparse.Namespace) – previously parsed arguments Raises SystemExit – 0 backintime.benchmarkCipher(args) Command for transferring a file with scp to remote host with all available ciphers and print its speed and time. Parameters args (argparse.Namespace) – previously parsed arguments Raises SystemExit – 0 backintime.checkConfig(args) Command for checking the config file. Parameters args (argparse.Namespace) – previously parsed arguments Raises SystemExit – 0 if config is okay, 1 if not backintime.createParsers(app_name=’backintime’) Define parsers for commandline arguments. Parameters app_name (str) – string representing the current application backintime.decode(args) Command for decoding paths given paths with ‘encfsctl’. Will listen on stdin if no path was given. Parameters args (argparse.Namespace) – previously parsed arguments Raises SystemExit – 0 backintime.getConfig(args, check=True) Load config and change to profile selected on commandline. Parameters • args (argparse.Namespace) – previously parsed arguments • check (bool) – if True check if config is valid Returns current config with requested profile selected Return type config.Config Raises SystemExit – 1 if profile or profile_id is no valid profile 2 if check is True and config is not configured backintime.lastSnapshot(args) Command for printing the very last snapshot in current profile. Parameters args (argparse.Namespace) – previously parsed arguments Raises SystemExit – 0 backintime.lastSnapshotPath(args) Command for printing the path of the very last snapshot in current profile. Parameters args (argparse.Namespace) – previously parsed arguments Raises SystemExit – 0 backintime.printHeader() Print application name, version and legal notes. 1.3. backintime module 5 Back In Time Development Documentation, Release 1.1.12 class backintime.printLicense(*args, **kwargs) Bases: argparse.Action Print custom license backintime.pwCache(args) Command for starting password cache daemon. Parameters args (argparse.Namespace) – previously parsed arguments Raises SystemExit – 0 if daemon is running, 1 if not backintime.remove(args, force=False) Command for removing snapshots. Parameters • args (argparse.Namespace) – previously parsed arguments • force (bool) – don’t ask before removing (BE CAREFUL!) Raises SystemExit – 0 backintime.removeAndDoNotAskAgain(args) Command for removing snapshots without asking before remove (BE CAREFUL!) Parameters args (argparse.Namespace) – previously parsed arguments Raises SystemExit – 0 backintime.restore(args) Command for restoring files from snapshots. Parameters args (argparse.Namespace) – previously parsed arguments Raises SystemExit – 0 backintime.setQuiet(args) Redirect sys.stdout to /dev/null if --quiet was set on commandline. Return the original sys. stdout file object which can be used to print absolute necessary information. Parameters args (argparse.Namespace) – previously parsed arguments Returns default sys.stdout Return type sys.stdout backintime.shutdown(args) Command for shutting down the computer after the current snapshot has finished. Parameters args (argparse.Namespace) – previously parsed arguments Raises SystemExit – 0 if successful; 1 if it failed either because there is no active snapshot for this profile or shutdown is not supported. backintime.smartRemove(args) Command for running Smart-Remove from Terminal. Parameters args (argparse.Namespace) – previously parsed arguments Raises SystemExit – 0 if okay 2 if Smart-Remove is not configured backintime.snapshotsList(args) Command for printing a list of all snapshots in current profile. Parameters args (argparse.Namespace) – previously parsed arguments Raises SystemExit – 0 6 Chapter 1. common Back In Time Development Documentation, Release 1.1.12 backintime.snapshotsListPath(args) Command for printing a list of all snapshots pathes in current profile. Parameters args (argparse.Namespace) – previously parsed arguments Raises SystemExit – 0 backintime.snapshotsPath(args) Command for printing the full snapshot path of current profile. Parameters args (argparse.Namespace) – previously parsed arguments Raises SystemExit – 0 backintime.startApp(app_name=’backintime’) Start the requested command or return config if there was no command in arguments. Parameters app_name (str) – string representing the current application Returns current config if no command was given in arguments Return type config.Config backintime.takeSnapshot(cfg, force=True) Take a new snapshot. Parameters • cfg (config.Config) – config that should be used • force (bool) – take the snapshot even if it wouldn’t need to or would be prevented (e.g. running on battery) Returns True if successful Return type bool backintime.takeSnapshotAsync(cfg, checksum=False) Fork a new backintime process with ‘backup’ command which will take a new snapshot in background. Parameters cfg (config.Config)