Restructure utils.py to its own package

.gitignore

@@ -93,6 +93,9 @@ vagrant/puppet/.tmp
 .vscode/**
 *.code-workspace
 
+# Operating system files
+**/.DS_Store
+
 node_modules/
 OpenOverSight/app/static/dist/
 static/

Makefile

@@ -85,5 +85,6 @@ help: ## Print this message and exit
 		| sort \
 		| column -s ':' -t
 
+.PHONY: attach
 attach:
 	docker-compose exec postgres psql -h localhost -U openoversight openoversight-dev

OpenOversight/app/auth/forms.py

@@ -10,7 +10,7 @@
 from wtforms.validators import DataRequired, Email, EqualTo, Length, Optional, Regexp
 
 from ..models import User
-from ..utils import dept_choices
+from ..utils.db import dept_choices
 
 
 class LoginForm(Form):

OpenOversight/app/auth/views.py

@@ -11,15 +11,13 @@
 )
 from flask_login import current_user, login_required, login_user, logout_user
 
+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 ..utils import (
-    HTTP_METHOD_GET,
-    HTTP_METHOD_POST,
-    set_dynamic_default,
-    validate_redirect_url,
-)
 from . import auth
 from .forms import (
     ChangeDefaultDepartmentForm,

OpenOversight/app/commands.py

@@ -12,15 +12,12 @@
 from flask import current_app
 from flask.cli import with_appcontext
 
+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
-from .utils import (
-    ENCODING_UTF_8,
-    get_officer,
-    normalize_gender,
-    prompt_yes_no,
-    str_is_true,
-)
 
 
 @click.command()

OpenOversight/app/main/forms.py

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

OpenOversight/app/main/model_view.py

@@ -7,14 +7,12 @@
 from flask_sqlalchemy.model import DefaultMeta
 from flask_wtf import FlaskForm as Form
 
+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
-from ..utils import (
-    HTTP_METHOD_GET,
-    HTTP_METHOD_POST,
-    add_department_query,
-    set_dynamic_default,
-)
 
 
 class ModelView(MethodView):

OpenOversight/app/main/views.py

@@ -21,6 +21,36 @@
 from sqlalchemy.orm import contains_eager, joinedload, selectinload
 from sqlalchemy.orm.exc import NoResultFound
 
+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 (
+    add_department_query,
+    add_unit_query,
+    compute_leaderboard_stats,
+    dept_choices,
+    unit_choices,
+)
+from OpenOversight.app.utils.forms import (
+    add_new_assignment,
+    add_officer_profile,
+    create_description,
+    create_incident,
+    create_note,
+    edit_existing_assignment,
+    edit_officer_profile,
+    filter_by_form,
+    set_dynamic_default,
+)
+from OpenOversight.app.utils.general import (
+    ac_can_edit_officer,
+    allowed_file,
+    get_or_create,
+    get_random_image,
+    replace_list,
+    serve_image,
+    validate_redirect_url,
+)
+
 from .. import limiter, sitemap
 from ..auth.forms import LoginForm
 from ..auth.utils import ac_or_admin_required, admin_required
@@ -42,33 +72,6 @@
     User,
     db,
 )
-from ..utils import (
-    HTTP_METHOD_GET,
-    HTTP_METHOD_POST,
-    ac_can_edit_officer,
-    add_department_query,
-    add_new_assignment,
-    add_officer_profile,
-    add_unit_query,
-    allowed_file,
-    compute_leaderboard_stats,
-    create_description,
-    create_incident,
-    create_note,
-    crop_image,
-    dept_choices,
-    edit_existing_assignment,
-    edit_officer_profile,
-    filter_by_form,
-    get_or_create,
-    get_random_image,
-    replace_list,
-    serve_image,
-    set_dynamic_default,
-    unit_choices,
-    upload_image_to_s3_and_store_in_db,
-    validate_redirect_url,
-)
 from . import downloads, main
 from .choices import AGE_CHOICES, GENDER_CHOICES, RACE_CHOICES
 from .forms import (
@@ -153,7 +156,8 @@ def get_officer():
                 else None,
                 rank=form.data["rank"] if form.data["rank"] != "Not Sure" else None,
                 unit=form.data["unit"] if form.data["unit"] != "Not Sure" else None,
-                current_job=form.data["current_job"] or None,  # set to None if False
+                current_job=form.data["current_job"] or None,
+                # set to None if False
                 min_age=form.data["min_age"],
                 max_age=form.data["max_age"],
                 first_name=form.data["first_name"],

OpenOversight/app/model_imports.py

@@ -2,6 +2,8 @@
 
 import dateutil.parser
 
+from OpenOversight.app.utils.general import get_or_create, str_is_true
+
 from .main import choices
 from .models import (
     Assignment,
@@ -13,7 +15,6 @@
     Salary,
     db,
 )
-from .utils import get_or_create, str_is_true
 from .validators import state_validator, url_validator
 
 

OpenOversight/app/models.py

@@ -12,11 +12,11 @@
 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
 
 
 db = SQLAlchemy()
-model_encoding = "utf-8"
 jwt = JsonWebToken("HS512")
 
 BaseModel = db.Model  # type: DefaultMeta
@@ -552,7 +552,7 @@ def verify_password(self, password):
 
     def generate_confirmation_token(self, expiration=3600):
         payload = {"confirm": self.id}
-        return self._jwt_encode(payload, expiration).decode(model_encoding)
+        return self._jwt_encode(payload, expiration).decode(ENCODING_UTF_8)
 
     def confirm(self, token):
         try:
@@ -572,7 +572,7 @@ def confirm(self, token):
 
     def generate_reset_token(self, expiration=3600):
         payload = {"reset": self.id}
-        return self._jwt_encode(payload, expiration).decode(model_encoding)
+        return self._jwt_encode(payload, expiration).decode(ENCODING_UTF_8)
 
     def reset_password(self, token, new_password):
         try:
@@ -588,7 +588,7 @@ def reset_password(self, token, new_password):
 
     def generate_email_change_token(self, new_email, expiration=3600):
         payload = {"change_email": self.id, "new_email": new_email}
-        return self._jwt_encode(payload, expiration).decode(model_encoding)
+        return self._jwt_encode(payload, expiration).decode(ENCODING_UTF_8)
 
     def change_email(self, token):
         try: