moving save_carefully()

core/TESTS/test_imports.py

@@ -32,7 +32,7 @@ class SimpleTest(SimpleTestCase):
         from troggle.core.models_caves import Cave
     def test_import_parsers_surveys(self):
         from PIL import Image
-        from utils import save_carefully
+        from troggle.core.utils import save_carefully
         from functools import reduce
     def test_import_parsers_survex(self):
         import troggle.settings as settings
@@ -43,7 +43,6 @@ class SimpleTest(SimpleTestCase):
         from troggle.core.views.caves import MapLocations
     def test_import_parsers_QMs(self):
         from troggle.core.models_caves import QM, Cave, LogbookEntry
-        from utils import save_carefully
     def test_import_parsers_people(self):
         from html.parser import HTMLParser
         from unidecode import unidecode

core/utils.py

@@ -60,6 +60,48 @@ def chaosmonkey(n):
     # print("CHAOS strikes !", file=sys.stderr)
     return True
 
+
+def save_carefully(objectType, lookupAttribs={}, nonLookupAttribs={}):
+    """Looks up instance using lookupAttribs and carries out the following:
+            -if instance does not exist in DB: add instance to DB, return (new instance, True)
+            -if instance exists in DB and was modified using Troggle: do nothing, return (existing instance, False)
+            -if instance exists in DB and was not modified using Troggle: overwrite instance, return (instance, False)
+            
+        The checking is accomplished using Django's get_or_create and the new_since_parsing boolean field
+        defined in core.models.TroggleModel.
+    
+    """
+    try:
+        instance, created = objectType.objects.get_or_create(defaults=nonLookupAttribs, **lookupAttribs)
+    except:
+        print(" !! - SAVE CAREFULLY   ===================", objectType)
+        print(" !! - -- objects.get_or_create()")
+        print(" !! - lookupAttribs:{}\n !! - nonLookupAttribs:{}".format(lookupAttribs,nonLookupAttribs))
+        raise
+    if not created and not instance.new_since_parsing:
+        for k, v in list(nonLookupAttribs.items()): #overwrite the existing attributes from the logbook text (except date and title)
+            setattr(instance, k, v)
+        try:
+            instance.save()
+        except:
+            print(" !! - SAVE CAREFULLY   ===================", objectType)
+            print(" !! - -- instance.save()")
+            print(" !! - lookupAttribs:{}\n !! - nonLookupAttribs:{}".format(lookupAttribs,nonLookupAttribs))
+            raise
+    try:
+        msg = str(instance)
+    except:
+        msg = "FAULT getting __str__ for instance with lookupattribs: {}:".format(lookupAttribs)
+    if created:
+        logging.info(str(instance) + ' was just added to the database for the first time. \n')
+    
+    if not created and instance.new_since_parsing:
+        logging.info(str(instance) + " has been modified using Troggle, so the current script left it as is. \n")
+
+    if not created and not instance.new_since_parsing:
+        logging.info(str(instance) + " existed in the database unchanged since last parse. It was overwritten by the current script. \n")
+    return (instance, created)
+ 
 # def get_related_by_wikilinks(wiki_text):
     # found=re.findall(settings.QM_PATTERN,wiki_text)
     # res=[]