Move models to its own package

OpenOversight/app/__init__.py

@@ -18,7 +18,8 @@
 from flask_wtf.csrf import CSRFProtect
 from markupsafe import Markup
 
-from .config import config
+from OpenOversight.app.config import config
+from OpenOversight.app.models.database import db
 
 
 bootstrap = Bootstrap()
@@ -40,7 +41,6 @@ def create_app(config_name="default"):
     app = Flask(__name__)
     app.config.from_object(config[config_name])
     config[config_name].init_app(app)
-    from .models import db
 
     bootstrap.init_app(app)
     mail.init_app(app)

OpenOversight/app/auth/forms.py

@@ -9,7 +9,8 @@
 from wtforms.validators import DataRequired, Email, EqualTo, Length, Optional, Regexp
 from wtforms_sqlalchemy.fields import QuerySelectField
 
-from ..models import User
+from OpenOversight.app.models.database import User
+
 from ..utils.db import dept_choices
 
 

OpenOversight/app/auth/views.py

@@ -11,13 +11,13 @@
 )
 from flask_login import current_user, login_required, login_user, logout_user
 
+from OpenOversight.app.models.database import User, db
 from OpenOversight.app.utils.constants import HTTP_METHOD_GET, HTTP_METHOD_POST
 from OpenOversight.app.utils.forms import set_dynamic_default
 from OpenOversight.app.utils.general import validate_redirect_url
 
 from .. import sitemap
 from ..email import send_email
-from ..models import User, db
 from . import auth
 from .forms import (
     ChangeDefaultDepartmentForm,

OpenOversight/app/commands.py

@@ -10,13 +10,20 @@
 from flask import current_app
 from flask.cli import with_appcontext
 
+from OpenOversight.app.csv_imports import import_csv_files
+from OpenOversight.app.models.database import (
+    Assignment,
+    Department,
+    Job,
+    Officer,
+    Salary,
+    User,
+    db,
+)
 from OpenOversight.app.utils.constants import ENCODING_UTF_8
 from OpenOversight.app.utils.db import get_officer
 from OpenOversight.app.utils.general import normalize_gender, prompt_yes_no, str_is_true
 
-from .csv_imports import import_csv_files
-from .models import Assignment, Department, Job, Officer, Salary, User, db
-
 
 @click.command()
 @with_appcontext

OpenOversight/app/csv_imports.py

@@ -4,7 +4,18 @@
 
 from sqlalchemy.exc import SQLAlchemyError
 
-from .model_imports import (
+from OpenOversight.app.models.database import (
+    Assignment,
+    Department,
+    Incident,
+    Job,
+    Link,
+    Officer,
+    Salary,
+    Unit,
+    db,
+)
+from OpenOversight.app.models.database_imports import (
     create_assignment_from_dict,
     create_incident_from_dict,
     create_link_from_dict,
@@ -18,17 +29,6 @@
     update_officer_from_dict,
     update_salary_from_dict,
 )
-from .models import (
-    Assignment,
-    Department,
-    Incident,
-    Job,
-    Link,
-    Officer,
-    Salary,
-    Unit,
-    db,
-)
 
 
 def _create_or_update_model(

OpenOversight/app/main/downloads.py

@@ -6,7 +6,7 @@
 from flask import Response, abort
 from sqlalchemy.orm import Query
 
-from ..models import (
+from OpenOversight.app.models.database import (
     Assignment,
     Department,
     Description,

OpenOversight/app/main/forms.py

@@ -29,10 +29,10 @@
 )
 from wtforms_sqlalchemy.fields import QuerySelectField
 
+from OpenOversight.app.models.database import Officer
 from OpenOversight.app.utils.db import dept_choices, unit_choices
 
 from ..formfields import TimeField
-from ..models import Officer
 from ..widgets import BootstrapListWidget, FormFieldWidget
 from .choices import (
     AGE_CHOICES,

OpenOversight/app/main/model_view.py

@@ -7,12 +7,12 @@
 from flask_sqlalchemy.model import DefaultMeta
 from flask_wtf import FlaskForm as Form
 
+from OpenOversight.app.models.database import db
 from OpenOversight.app.utils.constants import HTTP_METHOD_GET, HTTP_METHOD_POST
 from OpenOversight.app.utils.db import add_department_query
 from OpenOversight.app.utils.forms import set_dynamic_default
 
 from ..auth.utils import ac_or_admin_required
-from ..models import db
 
 
 class ModelView(MethodView):

OpenOversight/app/main/views.py

@@ -21,6 +21,24 @@
 from sqlalchemy.orm import contains_eager, joinedload, selectinload
 from sqlalchemy.orm.exc import NoResultFound
 
+from OpenOversight.app.models.database import (
+    Assignment,
+    Department,
+    Description,
+    Face,
+    Image,
+    Incident,
+    Job,
+    LicensePlate,
+    Link,
+    Location,
+    Note,
+    Officer,
+    Salary,
+    Unit,
+    User,
+    db,
+)
 from OpenOversight.app.utils.cloud import crop_image, upload_image_to_s3_and_store_in_db
 from OpenOversight.app.utils.constants import HTTP_METHOD_GET, HTTP_METHOD_POST
 from OpenOversight.app.utils.db import (
@@ -54,24 +72,6 @@
 from .. import limiter, sitemap
 from ..auth.forms import LoginForm
 from ..auth.utils import ac_or_admin_required, admin_required
-from ..models import (
-    Assignment,
-    Department,
-    Description,
-    Face,
-    Image,
-    Incident,
-    Job,
-    LicensePlate,
-    Link,
-    Location,
-    Note,
-    Officer,
-    Salary,
-    Unit,
-    User,
-    db,
-)
 from . import downloads, main
 from .choices import AGE_CHOICES, GENDER_CHOICES, RACE_CHOICES
 from .forms import (

OpenOversight/app/models.py → OpenOversight/app/models/database.py

@@ -11,9 +11,8 @@
 from sqlalchemy.orm import validates
 from werkzeug.security import check_password_hash, generate_password_hash
 
-from . import login_manager
-from .utils.constants import ENCODING_UTF_8
-from .validators import state_validator, url_validator
+from OpenOversight.app.utils.constants import ENCODING_UTF_8
+from OpenOversight.app.validators import state_validator, url_validator
 
 
 db = SQLAlchemy()
@@ -168,7 +167,7 @@ def full_name(self):
     def race_label(self):
         if self.race is None:
             return "Data Missing"
-        from .main.choices import RACE_CHOICES
+        from OpenOversight.app.main.choices import RACE_CHOICES
 
         for race, label in RACE_CHOICES:
             if self.race == race:
@@ -177,7 +176,7 @@ def race_label(self):
     def gender_label(self):
         if self.gender is None:
             return "Data Missing"
-        from .main.choices import GENDER_CHOICES
+        from OpenOversight.app.main.choices import GENDER_CHOICES
 
         for gender, label in GENDER_CHOICES:
             if self.gender == gender:
@@ -614,8 +613,3 @@ def is_active(self):
 
     def __repr__(self):
         return "<User %r>" % self.username
-
-
-@login_manager.user_loader
-def load_user(user_id):
-    return User.query.get(int(user_id))

OpenOversight/app/model_imports.py → OpenOversight/app/models/database_imports.py

@@ -2,20 +2,21 @@
 
 import dateutil.parser
 
-from OpenOversight.app.utils.general import get_or_create, str_is_true
-
-from .main import choices
-from .models import (
+from OpenOversight.app import login_manager
+from OpenOversight.app.main import choices
+from OpenOversight.app.models.database import (
     Assignment,
     Incident,
     LicensePlate,
     Link,
     Location,
     Officer,
     Salary,
+    User,
     db,
 )
-from .validators import state_validator, url_validator
+from OpenOversight.app.utils.general import get_or_create, str_is_true
+from OpenOversight.app.validators import state_validator, url_validator
 
 
 if TYPE_CHECKING:
@@ -70,7 +71,6 @@ def parse_str(value: Optional[str], default: Optional[str] = "") -> Optional[str
 
 
 def create_officer_from_dict(data: Dict[str, Any], force_id: bool = False) -> Officer:
-
     officer = Officer(
         department_id=int(data["department_id"]),
         last_name=parse_str(data.get("last_name", "")),
@@ -94,7 +94,6 @@ def create_officer_from_dict(data: Dict[str, Any], force_id: bool = False) -> Of
 
 
 def update_officer_from_dict(data: Dict[str, Any], officer: Officer) -> Officer:
-
     if "department_id" in data.keys():
         officer.department_id = int(data["department_id"])
     if "last_name" in data.keys():
@@ -124,7 +123,6 @@ def update_officer_from_dict(data: Dict[str, Any], officer: Officer) -> Officer:
 def create_assignment_from_dict(
     data: Dict[str, Any], force_id: bool = False
 ) -> Assignment:
-
     assignment = Assignment(
         officer_id=int(data["officer_id"]),
         star_no=parse_str(data.get("star_no"), None),
@@ -320,3 +318,8 @@ def update_incident_from_dict(data: Dict[str, Any], incident: Incident) -> Incid
         incident.license_plates = data["license_plate_objects"] or []
     db.session.flush()
     return incident
+
+
+@login_manager.user_loader
+def load_user(user_id):
+    return User.query.get(int(user_id))

OpenOversight/app/utils/cloud.py

@@ -15,7 +15,7 @@
 from PIL import Image as Pimage
 from PIL.PngImagePlugin import PngImageFile
 
-from ..models import Image, db
+from OpenOversight.app.models.database import Image, db
 
 
 def compute_hash(data_to_hash):

OpenOversight/app/utils/db.py

@@ -2,7 +2,16 @@
 
 from sqlalchemy import func
 
-from ..models import Assignment, Department, Face, Image, Officer, Unit, User, db
+from OpenOversight.app.models.database import (
+    Assignment,
+    Department,
+    Face,
+    Image,
+    Officer,
+    Unit,
+    User,
+    db,
+)
 
 
 def add_department_query(form, current_user):

OpenOversight/app/utils/forms.py

@@ -4,8 +4,7 @@
 from sqlalchemy.orm import selectinload
 from sqlalchemy.sql.expression import cast
 
-from ...app.main.choices import GENDER_CHOICES, RACE_CHOICES
-from ..models import (
+from OpenOversight.app.models.database import (
     Assignment,
     Description,
     Face,
@@ -20,6 +19,8 @@
     Unit,
     db,
 )
+
+from ...app.main.choices import GENDER_CHOICES, RACE_CHOICES
 from .general import get_or_create