Reformat special deletion rules

Author: melton-jason

specifyweb/specify/build_models.py

@@ -7,6 +7,7 @@
 from .datamodel import Datamodel, Table, Relationship, Field
 from .deletion_rules import SPECIAL_DELETION_RULES, ADDITIONAL_DELETE_BLOCKERS
 
+# this moduel's parent directory, 'specify'
 appname = __name__.split('.')[-2]
 
 orderings = {
@@ -18,7 +19,7 @@
     'Collector': ('ordernumber',),
 }
 
-def make_model(module: str, table: Table, datamodel: Datamodel) -> models.base.ModelBase:
+def make_model(module: str, table: Table, datamodel: Datamodel) -> models.Model:
     """Returns a Django model class based on the
     definition of a Specify table.
     """
@@ -96,18 +97,23 @@ def make_relationship(modelname : str, rel: Relationship, datamodel: Datamodel)
         return None
 
     try:
-        on_delete = SPECIAL_DELETION_RULES[f"{rel.name.capitalize()}"][f"{modelname.lower()}"]
+        on_delete = SPECIAL_DELETION_RULES[f"{modelname}"][f"{rel.name.lower()}"]
     except KeyError:
         reverse = datamodel.reverse_relationship(rel)
 
         if reverse is not None and reverse.dependent:
+
+            # Example: Current `rel` is Accessionagent.accession, 
+            # Reverse (Accession.accessionAgents) is flagged as dependent 
+            # (see dependent_fields in .load_datamodel.py), so Cascade Accession Agent
+            # when deleting Accession 
             on_delete = models.CASCADE
         elif modelname in ADDITIONAL_DELETE_BLOCKERS.keys():
             on_delete = protect
         else:
             on_delete = protect
 
-    def make_to_one(Field: type) -> models.ForeignKey or models.OneToOneField:
+    def make_to_one(Field: (models.ForeignKey or models.OneToOneField)) -> models.ForeignKey or models.OneToOneField:
         """Setup a field of the given 'Field' type which can be either
         ForeignKey (many-to-one) or OneToOneField.
         """
@@ -259,7 +265,7 @@ def make_args(cls, fld: Field):
 
 # Build the table information as Django models
 # See .models.py
-def build_models(module : str, datamodel: Datamodel):
+def build_models(module : str, datamodel: Datamodel) -> Dict[int, models.Model]:
     return { model.specify_model.tableId: model
              for table in datamodel.tables
              for model in [ make_model(module, table, datamodel) ]}

specifyweb/specify/deletion_rules.py

@@ -2,7 +2,14 @@
 
 """ Special Deletion Rules for table relationships 
     
-    Of the form: base_table : { field_name: action}
+    Of the form: 'relatedTable.relName' : action, 
+        where relName is the field name of the relationship in relatedTable
+
+    For example, 'Accessionagent.accession' : models.CASCADE 
+        would delete the associated Accession Agent when Accession is deleted
+    
+    The field and relationship names can be viewed at
+        https://files.specifysoftware.org/schema/version/2.10/
 
     Possible Django actions (w/ django 2.2) are:
         CASCADE, PROTECT, SET_NULL, SET_DEFAULT, SET(...), DO_NOTHING
@@ -13,49 +20,31 @@
     See .build_models.py for uses
 """
 SPECIAL_DELETION_RULES = {
-    'Spappresource' : {'spreport': models.CASCADE},
-
-    'Recordset' : {'recordsetitem' : models.CASCADE},
-
-    'Specifyuser' : {
-        'agent' : models.SET_NULL,
-        'spAppResourceDir' : models.CASCADE,
-        'spAppResource': models.CASCADE,
-        'spPrincipal': models.CASCADE,
-        },
-
-    # Handle workbench deletion using raw sql in business rules.
-    'Workbench' : {'workbenchrow': models.DO_NOTHING},
-    'Workbenchrow' : {
-        'workbenchdataitem' : models.DO_NOTHING,
-        'workbenchrowimage' : models.DO_NOTHING,
-        'workbenchrowexportedrelationship' : models.DO_NOTHING,
-    },
-
-    # System Tables
-
-    'Spauditlog' : {'field' : models.CASCADE},
-
-    'Spappresource' : {'spAppResourceData': models.CASCADE},
-    'Spappresourcedir' : {
-        'spPersistedAppResource': models.CASCADE,
-        'spPersistedViewSet' : models.CASCADE,
-        },
-    'Spviewsetobj' : {'spAppResourceData' : models.CASCADE},
-    
-    'Splocalecontainer' : {
-        'item' : models.CASCADE,
-        'name' : models.CASCADE
-    },
-    'Splocalecontaineritem' : {
-        'name' : models.CASCADE
-    },
-    'SpQuery' : {"field" : models.CASCADE},
+    'Agent.specifyuser' : models.SET_NULL,
+
+     # Handle workbench deletion using raw sql in business rules.
+    'Workbenchrow.workbench': models.DO_NOTHING,
+    'Workbenchdataitem.workbenchrow': models.DO_NOTHING,
+    'Workbenchrowimage.workbenchrow': models.DO_NOTHING,
+    'Workbenchrowexportedrelationship.workbenchrow': models.DO_NOTHING,
+
+    # These fields are not marked as dependent because the relationship
+    # can be null
+    'Spappresourcedir.specifyuser': models.CASCADE,
+    'Spappresource.specifyuser': models.CASCADE,
+    'Spappresourcedata.spappresource': models.CASCADE,
+    'Spappresourcedata.spviewsetobj': models.CASCADE,
+
+    # In addition to these rules, Specify Cascades relationships tagged as dependent
+    # For the complete list, see the global variable called 
+    # dependent_fields in .load_datamodel.py 
+
+    # If the field/relationship is not dependent and not defined here, then it is 
+    # protected
 }
 
 """ Any additional desired delete blockers 
 Of the form 'base_table': ['field_1_name', 'field_2_name', ...]
-Use the django attributes from the 'base_table' for field names
 
 See .build_models.py and .views.py for uses
 """

specifyweb/specify/load_datamodel.py

@@ -342,11 +342,15 @@ def flag_system_tables(datamodel: Datamodel) -> None:
     'Preparation.preparationattrs',
     'Preparation.preparationproperties',
     'Preptype.attributedefs',
+    'Recordset.recordsetitems',
     'Referencework.authors',
     'Repositoryagreement.addressofrecord',
     'Repositoryagreement.repositoryagreementagents',
     'Repositoryagreement.repositoryagreementauthorizations',
+    'Spappresource.spAppResourceDir',
+    'Spauditlog.fields',
     'Spquery.fields',
+    'Spreport.appResource',
     'Taxon.commonnames',
     'Taxon.taxoncitations',
     'Taxon.taxonattribute',

specifyweb/specify/models.py

@@ -2,7 +2,7 @@
 Sets up Django ORM with the Specify datamodel
 """
 from typing import Dict
-from django.db.models.base import ModelBase
+from django.db.models import Model
 
 from .build_models import build_models
 from .check_versions import check_versions
@@ -11,7 +11,7 @@
 # Returns a dictonary with the table's TableId as keys and the reated django models as values
 # The values (class paths) are constructed with this Module's name followed by the table name
 # Example: {7: <class 'specifyweb.specify.models.Accession'>}
-models_by_tableid : Dict[int, ModelBase] = build_models(__name__, datamodel)
+models_by_tableid : Dict[int, Model] = build_models(__name__, datamodel)
 
 # inject the model definitions into this module's namespace
 globals().update((model.__name__, model)