#154: Move common.models to common.database

- The only model in common.models was for the database backend (there's no model for the Python ICAT backend), hence the change
- This commit also includes the changes required to correctly import the file from the new location
- Updated the file tree in the README

README.md

@@ -83,10 +83,9 @@ This is illustrated below.
     │   ├── database
     │   │   ├── backend.py
     │   │   ├── filters.py
-    │   │   └── helpers.py
+    │   │   ├── helpers.py
+    │   │   └── models.py
     │   ├── icat
-    │   ├── models
-    │   │   └── db_models.py
     │   ├── backends.py
     │   ├── constants.py
     │   ├── exceptions.py
@@ -134,7 +133,7 @@ session endpoint.
 
 
 #### Mapped classes
-The classes mapped from the database are stored in `/common/models/db_models.py`. Each model was 
+The classes mapped from the database are stored in `/common/database/models.py`. Each model was 
 automatically generated using sqlacodegen. A class `EntityHelper` is defined so that each model may
 inherit two methods `to_dict()` and `update_from_dict(dictionary)`, both used for returning entities 
 and updating them, in a form easily converted to JSON.  

common/database/backend.py

@@ -16,7 +16,7 @@
     requires_session_id,
 )
 from common.helpers import queries_records
-from common.models.db_models import SESSION
+from common.database.models import SESSION
 import uuid
 from common.exceptions import AuthenticationError
 import datetime

common/database/filters.py

@@ -7,7 +7,7 @@
     IncludeFilter,
 )
 from common.exceptions import FilterError, MultipleIncludeError
-from common.models import db_models
+from common.database import models
 
 from sqlalchemy import asc, desc
 import logging
@@ -57,15 +57,15 @@ def apply_filter(self, query):
             )
 
         if self.included_included_field:
-            included_table = getattr(db_models, self.field)
-            included_included_table = getattr(db_models, self.included_field)
+            included_table = getattr(models, self.field)
+            included_included_table = getattr(models, self.included_field)
             query.base_query = query.base_query.join(included_table).join(
                 included_included_table
             )
             field = getattr(included_included_table, self.included_included_field)
 
         elif self.included_field:
-            included_table = getattr(db_models, self.field)
+            included_table = getattr(models, self.field)
             query.base_query = query.base_query.join(included_table)
             field = getattr(included_table, self.included_field)
 

common/database/helpers.py

@@ -13,9 +13,7 @@
     BadRequestError,
     MultipleIncludeError,
 )
-from common.models import db_models
-from common.models.db_models import (
-    INVESTIGATIONUSER,
+from common.database.models import (
     INVESTIGATION,
     INSTRUMENT,
     FACILITYCYCLE,

common/icat/backend.py

@@ -26,7 +26,6 @@
 
 from common.config import config
 from common.exceptions import AuthenticationError
-from common.models.db_models import SESSION
 
 log = logging.getLogger()
 

src/resources/entities/entity_map.py

@@ -1,4 +1,4 @@
-from common.models.db_models import (
+from common.database.models import (
     APPLICATION,
     DATACOLLECTIONDATAFILE,
     DATACOLLECTIONPARAMETER,

src/resources/non_entities/sessions_endpoints.py

@@ -10,7 +10,7 @@
     get_row_by_id,
 )
 from common.helpers import get_session_id_from_auth_header
-from common.models.db_models import SESSION
+from common.database.models import SESSION
 from common.backends import backend
 from common.exceptions import AuthenticationError
 

test/test_entityHelper.py

@@ -1,7 +1,7 @@
 import datetime
 from unittest import TestCase
 
-from common.models.db_models import DATAFILE, DATASET, DATAFILEFORMAT, INVESTIGATION
+from common.database.models import DATAFILE, DATASET, DATAFILEFORMAT, INVESTIGATION
 
 
 class TestEntityHelper(TestCase):

test/test_helpers.py

@@ -25,7 +25,7 @@
     get_session_id_from_auth_header,
     get_filters_from_query_string,
 )
-from common.models.db_models import SESSION
+from common.database.models import SESSION
 from test.test_base import FlaskAppTest