Changeset d0deae5 in rattail

Timestamp:

07/29/2020 01:22:50 AM (3 years ago)

Author:

Lance Edgar <lance@…>

Branches:

master

Children:

f7aa709

Parents:

e16175f

Message:

Add BatchHandler.delete_extra_data() method

and update related logic to use it etc.

Location:

rattail

Files:

• batch/handlers.py (modified) (8 diffs)
• commands/batch.py (modified) (3 diffs)
• db/model/batch/core.py (modified) (3 diffs)

rattail/batch/handlers.py

@@ -31 +31 @@
 import datetime
 import warnings
+import logging
 
 from sqlalchemy import orm
@@ -41 +42 @@
 from rattail.time import localtime, make_utc
 from rattail.util import progress_loop, load_object
+
+
+log = logging.getLogger(__name__)
 
 
@@ -185 +189 @@
 
     def purge_batches(self, session, before=None, before_days=90,
-                      delete_all_data=True, progress=None, **kwargs):
+                      dry_run=False, delete_all_data=None,
+                      progress=None, **kwargs):
         """
         Purge all batches which were executed prior to a given date.
@@ -196 +201 @@
            as the cutoff date if ``before`` is not specified.
 
+        :param dry_run: Flag indicating that this is a "dry run" and all logic
+           involved should be (made) aware of that fact.
+
         :param delete_all_data: Flag indicating whether *all* data should be
            deleted for each batch being purged.  This flag is passed along to
-           :meth:`delete()`; see that for more info.
+           :meth:`delete()`; see that for more info.  NOTE: This flag should
+           probably be deprecated, but so far has not been...but ``dry_run``
+           should be preferred for readability etc.
 
         :returns: Integer indicating the number of batches purged.
         """
+        if delete_all_data and dry_run:
+            raise ValueError("You can enable (n)either of `dry_run` or "
+                             "`delete_all_data` but both cannot be True")
+        delete_all_data = not dry_run
+
         if not before:
             before = localtime(self.config).date() - datetime.timedelta(days=before_days)
@@ -207 +222 @@
             before = localtime(self.config, before)
 
+        log.info("will purge '%s' batches, executed before %s",
+                 self.batch_key, before.date())
+
         old_batches = session.query(self.batch_model_class)\
                              .filter(self.batch_model_class.executed < before)\
-                             .options(orm.joinedload(self.batch_model_class.data_rows))
+                             .options(orm.joinedload(self.batch_model_class.data_rows))\
+                             .all()
+        log.info("found %s batches to purge", len(old_batches))
         result = Object()
         result.purged = 0
@@ -224 +244 @@
 
         session.flush()
+        if old_batches:
+            log.info("%spurged %s '%s' batches",
+                     "(would have) " if dry_run else "",
+                     result.purged, self.batch_key)
         return result.purged
 
@@ -721 +745 @@
         """
         if delete_all_data:
-            if hasattr(batch, 'delete_data'):
-                batch.delete_data(self.config)
+            self.delete_extra_data(batch, progress=progress)
 
         # delete all rows from batch, one by one.  maybe would be nicer if we
@@ -745 +768 @@
             # rows being deleted
             del batch.data_rows[:]
+
+    def delete_extra_data(self, batch, progress=None, **kwargs):
+        """
+        Delete all "extra" data for the batch.  This method should *not* bother
+        trying to delete the batch itself, or rows thereof.  It typically is
+        only concerned with deleting extra files on disk, related to the batch.
+        """
+        path = self.config.batch_filepath(self.batch_key, batch.uuid)
+        if os.path.exists(path):
+            shutil.rmtree(path)
 
     def setup_clone(self, oldbatch, progress=None):

rattail/commands/batch.py

@@ -3 +3 @@
 #
 #  Rattail -- Retail Software Framework
-#  Copyright © 2010-2019 Lance Edgar
+#  Copyright © 2010-2020 Lance Edgar
 #
 #  This file is part of Rattail.
@@ -224 +224 @@
 
         handler = self.get_handler(args)
-        log.info("purging batches of type: %s", args.batch_type)
         session = self.make_session()
 
         kwargs = {
-            'delete_all_data': not args.dry_run,
+            'dry_run': args.dry_run,
             'progress': self.progress,
         }
@@ -239 +238 @@
 
         purged = handler.purge_batches(session, **kwargs)
-        log.info("%spurged %s batches", "(would have) " if args.dry_run else "", purged)
 
         if args.dry_run:

rattail/db/model/batch/core.py

@@ -3 +3 @@
 #
 #  Rattail -- Retail Software Framework
-#  Copyright © 2010-2018 Lance Edgar
+#  Copyright © 2010-2020 Lance Edgar
 #
 #  This file is part of Rattail.
@@ -33 +33 @@
 import datetime
 import shutil
+import warnings
 
 import six
@@ -258 +259 @@
         Delete the data folder for the batch
         """
+        warnings.warn("This method has been deprecated; please see/use "
+                      "BatchHandler.delete_extra_data() instead",
+                      DeprecationWarning)
+
         # TODO: should this logic be in the handler instead?
         path = config.batch_filepath(self.batch_key, self.uuid)