Add type hints plus minor code fixes

If allowed by the remote server, try using sudo to remove
old backups (rm needs to be allowed in sudoers to run
without password)

README.md

@@ -68,4 +68,4 @@ sudo --preserve-env=SSH_AUTH_SOCK -s simple_backup [options]
 
 or by editing the sudoers file.
 If SSH key authentication is not available, password authentication will be used instead.
-
+Check the man page for more details.

man/simple_backup.1

@@ -93,19 +93,19 @@ Don't use systemd journal for logging.
 .B \-\-rsync\-options OPTIONS [OPTION...]
 By default, the following rsync options are used:
 .RS
-.PP
+.P
     \-a \-r \-v \-h \-s \-H \-X
-.PP
+.P
 Using \-\-rsync\-options it is possible to manually select which options to use. Supported values are the following:
-.PP
+.P
     \-a, \-l, \-p, \-t, \-g, \-o, \-c, \-h, \-D, \-H, \-X, \-s
-.PP
+.P
 Options \-r and \-v are used in any case. Not that options must be specified without dash (\-), for example:
-.PP
+.P
 .EX
     simple_backup \-\-rsync\-options a l p
 .EE
-.TP
+.P
 Check
 .BR rsync (1)
 for details about the options.
@@ -114,8 +114,12 @@ for details about the options.
 .B \-\-remote\-sudo
 Run rsync on the remote server with sudo. This is needed if you want to preserve the owner of the files/folders to be copied (rsync \-\-owner option). For this to work the user used to login to the server obviously need to be allowed to use sudo. In addition, the user need to be able to run rsync with sudo without a password. To do this, /etc/sudoers on the server need to be edited adding a line like this one:
 .RS
-.PP
+.P
     <username> ALL=NOPASSWD:<path/to/rsync>
+.P
+To be able to remove old backups generated with \-\-remote\-sudo (see \-\-keep option), also
+.BR rm (1)
+needs to be allowed to run without password in the same way.
 .RE
 .TP
 .B \-\-numeric\-ids
@@ -139,7 +143,7 @@ When running
 .B simple_backup
 with
 .B sudo,
-in order to connect to the user\(aq s SSH agent it is necessary to preserve the \(aq SSH_AUTH_SOCK\(aq environment variable, for example:
+in order to connect to the user\(aqs SSH agent it is necessary to preserve the \(aqSSH_AUTH_SOCK\(aq environment variable, for example:
 .P
 .EX
     sudo --preserve-env=SSH_AUTH_SOCK -s simple_backup [options]
@@ -148,8 +152,7 @@ in order to connect to the user\(aq s SSH agent it is necessary to preserve the
 It is also possible to make this permanent by editing the
 .B sudoers
 file (see
-.BR sudoers (5)
+.BR sudoers (5))
-)
 .P
 If SSH key authentication is not available, password authentication will be used instead.
 Note that in this case

simple_backup/__init__.py

@@ -1,3 +1,3 @@
 """Init."""
 
-__version__ = '4.1.2'
+__version__ = '4.1.5'

simple_backup/simple_backup.conf

@@ -2,7 +2,7 @@
 
 [backup]
 # Files and directories to backup. Multiple items can be separated using a comma (','). It is possible to use wildcards (i.e. '*' to match multiple characters and '~' for the user's home directory).
-inputs=/home/my_home,/etc
+inputs=/home/user
 
 # Output directory.
 backup_dir=/media/Backup

simple_backup/simple_backup.py

@@ -14,6 +14,7 @@ Classes:
 # Import libraries
 import sys
 import os
+from typing import Callable, List, Optional, ParamSpec, TypeVar, Union
 import warnings
 from functools import wraps
 from shutil import rmtree, which
@@ -26,7 +27,7 @@ from timeit import default_timer
 from subprocess import Popen, PIPE, STDOUT
 from datetime import datetime
 from tempfile import mkstemp
-from getpass import getpass
+from getpass import GetPassWarning, getpass
 from glob import glob
 
 from dotenv import load_dotenv
@@ -67,29 +68,29 @@ if journal:
     j_handler.setFormatter(j_format)
     logger.addHandler(j_handler)
 
+P = ParamSpec('P')
+R = TypeVar('R')
 
-def timing(_logger):
+
+def timing(func: Callable[P, R]) -> Callable[P, R]:
     """Decorator to measure execution time of a function
 
         Parameters:
-            _logger: Logger object
+            func: Function to decorate
     """
-    def decorator_timing(func):
     @wraps(func)
-        def wrapper_timing(*args, **kwargs):
+    def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
         start = default_timer()
 
         value = func(*args, **kwargs)
 
         end = default_timer()
 
-            _logger.info(f'Elapsed time: {end - start:.3f} seconds')
+        logger.info('Elapsed time: %.3f seconds', end - start)
 
         return value
 
-        return wrapper_timing
+    return wrapper
-
-    return decorator_timing
 
 
 class MyFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter):
@@ -134,8 +135,9 @@ class Backup:
             Perform the backup
     """
 
-    def __init__(self, inputs, output, exclude, keep, options, ssh_host=None, ssh_user=None,
+    def __init__(self, inputs: List[str], output: str, exclude: List[str], keep: int, options: str,
-                 ssh_keyfile=None, remote_sudo=False, remove_before=False, verbose=False):
+                 ssh_host: Optional[str] = None, ssh_user: Optional[str] = None, ssh_keyfile: Optional[str] = None,
+                 remote_sudo: bool = False, remove_before: bool = False, verbose: bool = False) -> None:
         self.inputs = inputs
         self.output = output
         self.exclude = exclude
@@ -152,12 +154,12 @@ class Backup:
         self._output_dir = ''
         self._inputs_path = ''
         self._exclude_path = ''
-        self._remote = None
+        self._remote = False
         self._ssh = None
         self._password_auth = False
         self._password = None
 
-    def check_params(self, homedir=''):
+    def check_params(self, homedir: str = '') -> int:
         """Check if parameters for the backup are valid"""
 
         if self.inputs is None or len(self.inputs) == 0:
@@ -201,7 +203,7 @@ class Backup:
         return 0
 
     # Function to create the actual backup directory
-    def define_backup_dir(self):
+    def define_backup_dir(self) -> None:
         """Define the actual backup dir"""
         now = datetime.now().strftime('%Y-%m-%d %H:%M:%S')
         self._output_dir = f'{self.output}/simple_backup/{now}'
@@ -209,10 +211,12 @@ class Backup:
         if self._remote:
             self._server = f'{self.ssh_user}@{self.ssh_host}:'
 
-    def remove_old_backups(self):
+    def remove_old_backups(self) -> None:
         """Remove old backups if there are more than indicated by 'keep'"""
 
         if self._remote:
+            assert self._ssh is not None
+
             _, stdout, _ = self._ssh.exec_command(f'ls {self.output}/simple_backup')
 
             dirs = stdout.read().decode('utf-8').strip().split('\n')
@@ -229,6 +233,9 @@ class Backup:
                 dirs.sort()
 
                 for i in range(n_backup - self.keep):
+                    if self.remote_sudo:
+                        _, _, stderr = self._ssh.exec_command(f'sudo rm -r "{self.output}/simple_backup/{dirs[i]}"')
+                    else:
                         _, _, stderr = self._ssh.exec_command(f'rm -r "{self.output}/simple_backup/{dirs[i]}"')
 
                     err = stderr.read().decode('utf-8').strip().split('\n')[0]
@@ -269,7 +276,7 @@ class Backup:
         elif count > 1:
             logger.info('Removed %d backups', count)
 
-    def find_last_backup(self):
+    def find_last_backup(self) -> None:
         """Get path of last backup (from last_backup symlink) for rsync --link-dest"""
 
         if self._remote:
@@ -295,7 +302,7 @@ class Backup:
                 logger.critical('Cannot access the backup directory. Permission denied')
 
                 try:
-                    notify('Backup failed (check log for details)')
+                    _notify('Backup failed (check log for details)')
                 except NameError:
                     pass
 
@@ -306,17 +313,18 @@ class Backup:
             except IndexError:
                 logger.info('No previous backups available')
 
-    def _ssh_connect(self, homedir=''):
+    def _ssh_connect(self, homedir: str = '') -> paramiko.client.SSHClient:
         try:
             ssh = paramiko.SSHClient()
         except NameError:
             logger.error('Install paramiko for ssh support')
+
             return None
 
         try:
             ssh.load_host_keys(filename=f'{homedir}/.ssh/known_hosts')
         except FileNotFoundError:
-            logger.warning(f'Cannot find file {homedir}/.ssh/known_hosts')
+            logger.warning('Cannot find file %s/.ssh/known_hosts', homedir)
 
         ssh.set_missing_host_key_policy(paramiko.WarningPolicy())
 
@@ -355,6 +363,11 @@ class Backup:
                 os.environ['SSHPASS'] = password
 
                 return ssh
+            except GetPassWarning as e:
+                logger.critical('Unable to get password')
+                logger.critical(e)
+
+                return None
             except paramiko.SSHException as e:
                 logger.critical('Can\'t connect to the server.')
                 logger.critical(e)
@@ -409,7 +422,7 @@ class Backup:
 
         return ssh
 
-    def _returncode_log(self, returncode):
+    def _returncode_log(self, returncode: int) -> None:
         match returncode:
             case 2:
                 logger.error('Rsync error (return code 2) - Protocol incompatibility')
@@ -439,8 +452,8 @@ class Backup:
                 logger.error('Rsync error (return code %d) - Check rsync(1) for details', returncode)
 
     # Function to read configuration file
-    @timing(logger)
+    @timing
-    def run(self):
+    def run(self) -> int:
         """Perform the backup"""
 
         logger.info('Starting backup...')
@@ -469,7 +482,7 @@ class Backup:
             logger.info('No existing files or directories specified for backup. Nothing to do')
 
             try:
-                notify('Backup finished. No files copied')
+                _notify('Backup finished. No files copied')
             except NameError:
                 pass
 
@@ -510,6 +523,7 @@ class Backup:
         args = shlex.split(rsync)
 
         with Popen(args, stdin=PIPE, stdout=PIPE, stderr=STDOUT, shell=False) as p:
+            output: Union[bytes, List[str]]
             output, _ = p.communicate()
 
             try:
@@ -543,6 +557,8 @@ class Backup:
         os.remove(self._exclude_path)
 
         if self._remote:
+            assert self._ssh is not None
+
             _, stdout, _ = self._ssh.exec_command(f'if [ -d "{self._output_dir}" ]; then echo "ok"; fi')
 
             output = stdout.read().decode('utf-8').strip()
@@ -795,6 +811,7 @@ def simple_backup():
         config_args = _read_config(args.config, user)
     except (configparser.NoSectionError, configparser.NoOptionError):
         logger.critical('Bad configuration file')
+
         return 6
 
     inputs = args.inputs if args.inputs is not None else config_args['inputs']