Support for filename patterns in configuration files (#10)

For details refer to the following feature request:
#10

Author: xolox

requirements.txt

@@ -1,5 +1,5 @@
-coloredlogs >= 5.0
-executor >= 16.0.1
+coloredlogs >= 5.1
+executor >= 19.2
 humanfriendly >= 3.4
 naturalsort >= 1.4
 property-manager >= 2.3
@@ -8,4 +8,4 @@ python-dateutil >= 2.2
 simpleeval >= 0.8.7, < 0.9.2
 six >= 1.9.0
 update-dotdee >= 5.0
-verboselogs >= 1.4
+verboselogs >= 1.5

rotate_backups/__init__.py

@@ -146,12 +146,14 @@ def coerce_retention_period(value):
     return value
 
 
-def load_config_file(configuration_file=None):
+def load_config_file(configuration_file=None, expand=True):
     """
     Load a configuration file with backup directories and rotation schemes.
 
     :param configuration_file: Override the pathname of the configuration file
                                to load (a string or :data:`None`).
+    :param expand: :data:`True` to expand filename patterns to their matches,
+                   :data:`False` otherwise.
     :returns: A generator of tuples with four values each:
 
               1. An execution context created using :mod:`executor.contexts`.
@@ -175,6 +177,7 @@ def load_config_file(configuration_file=None):
     above, so that sections in user-specific configuration files override
     sections by the same name in system-wide configuration files.
     """
+    expand_notice_given = False
     if configuration_file:
         loader = ConfigLoader(available_files=[configuration_file], strict=True)
     else:
@@ -195,7 +198,21 @@ def load_config_file(configuration_file=None):
                        io_scheduling_class=items.get('ionice'),
                        strict=coerce_boolean(items.get('strict', 'yes')),
                        prefer_recent=coerce_boolean(items.get('prefer-recent', 'no')))
-        yield location, rotation_scheme, options
+        # Expand filename patterns?
+        if expand and location.have_wildcards:
+            logger.verbose("Expanding filename pattern %s on %s ..", location.directory, location.context)
+            if location.is_remote and not expand_notice_given:
+                logger.notice("Expanding remote filename patterns (may be slow) ..")
+                expand_notice_given = True
+            for match in sorted(location.context.glob(location.directory)):
+                if location.context.is_directory(match):
+                    logger.verbose("Matched directory: %s", match)
+                    expanded = Location(context=location.context, directory=match)
+                    yield expanded, rotation_scheme, options
+                else:
+                    logger.verbose("Ignoring match (not a directory): %s", match)
+        else:
+            yield location, rotation_scheme, options
 
 
 def rotate_backups(directory, rotation_scheme, **options):
@@ -472,15 +489,27 @@ def load_config_file(self, location):
         :returns: The configured or given :class:`Location` object.
         """
         location = coerce_location(location)
-        for configured_location, rotation_scheme, options in load_config_file(self.config_file):
-            if location == configured_location:
+        for configured_location, rotation_scheme, options in load_config_file(self.config_file, expand=False):
+            if configured_location.match(location):
                 logger.verbose("Loading configuration for %s ..", location)
                 if rotation_scheme:
                     self.rotation_scheme = rotation_scheme
                 for name, value in options.items():
                     if value:
                         setattr(self, name, value)
-                return configured_location
+                # Create a new Location object based on the directory of the
+                # given location and the execution context of the configured
+                # location, because:
+                #
+                # 1. The directory of the configured location may be a filename
+                #    pattern whereas we are interested in the expanded name.
+                #
+                # 2. The execution context of the given location may lack some
+                #    details of the configured location.
+                return Location(
+                    context=configured_location.context,
+                    directory=location.directory,
+                )
         logger.verbose("No configuration found for %s.", location)
         return location
 
@@ -622,6 +651,11 @@ def have_ionice(self):
         """:data:`True` when ionice_ is available, :data:`False` otherwise."""
         return self.context.have_ionice
 
+    @lazy_property
+    def have_wildcards(self):
+        """:data:`True` if :attr:`directory` is a filename pattern, :data:`False` otherwise."""
+        return '*' in self.directory
+
     @lazy_property
     def mount_point(self):
         """
@@ -703,6 +737,27 @@ def ensure_writable(self):
                     to permissions. Consider using the --use-sudo option.
                 """, location=self))
 
+    def match(self, location):
+        """
+        Check if the given location "matches".
+
+        :param location: The :class:`Location` object to try to match.
+        :returns: :data:`True` if the two locations are on the same system and
+                  the :attr:`directory` can be matched as a filename pattern or
+                  a literal match on the normalized pathname.
+        """
+        if self.ssh_alias != location.ssh_alias:
+            # Never match locations on other systems.
+            return False
+        elif self.have_wildcards:
+            # Match filename patterns using fnmatch().
+            return fnmatch.fnmatch(location.directory, self.directory)
+        else:
+            # Compare normalized directory pathnames.
+            self = os.path.normpath(self.directory)
+            other = os.path.normpath(location.directory)
+            return self == other
+
     def __str__(self):
         """Render a simple human readable representation of a location."""
         return '%s:%s' % (self.ssh_alias, self.directory) if self.ssh_alias else self.directory

rotate_backups/cli.py

@@ -1,7 +1,7 @@
 # rotate-backups: Simple command line interface for backup rotation.
 #
 # Author: Peter Odding <peter@peterodding.com>
-# Last Change: March 25, 2018
+# Last Change: April 27, 2018
 # URL: https://github.com/xolox/python-rotate-backups
 
 """
@@ -260,9 +260,8 @@ def main():
             # Rotation of all configured locations.
             location_source = 'configuration file'
             selected_locations.extend(
-                location
-                for location, rotation_scheme, options
-                in load_config_file(kw.get('config_file'))
+                location for location, rotation_scheme, options
+                in load_config_file(configuration_file=kw.get('config_file'), expand=True)
             )
         # Inform the user which location(s) will be rotated.
         if selected_locations: