Add state to departments table

OpenOversight/app/commands.py

@@ -6,6 +6,7 @@
 from typing import Dict, List
 
 import click
+import us
 from dateutil.parser import parse
 from flask import current_app
 from flask.cli import with_appcontext
@@ -565,7 +566,11 @@ def bulk_add_officers(filename, no_create, update_by_name, update_static_fields)
 
 
 @click.command()
-@click.argument("department-name")
+@click.argument("department-name", required=True)
+@click.argument(
+    "department-state",
+    type=click.Choice([state.abbr for state in us.STATES]),
+)
 @click.option("--officers-csv", type=click.Path(exists=True))
 @click.option("--assignments-csv", type=click.Path(exists=True))
 @click.option("--salaries-csv", type=click.Path(exists=True))
@@ -576,6 +581,7 @@ def bulk_add_officers(filename, no_create, update_by_name, update_static_fields)
 @with_appcontext
 def advanced_csv_import(
     department_name,
+    department_state,
     officers_csv,
     assignments_csv,
     salaries_csv,
@@ -585,8 +591,8 @@ def advanced_csv_import(
     overwrite_assignments,
 ):
     """
-    Add or update officers, assignments, salaries, links and incidents from csv
-    files in the department DEPARTMENT_NAME.
+    Add or update officers, assignments, salaries, links and incidents from
+    csv files in the department using the DEPARTMENT_NAME and DEPARTMENT_STATE.
 
     The csv files are treated as the source of truth.
     Existing entries might be overwritten as a result, backing up the
@@ -599,6 +605,7 @@ def advanced_csv_import(
 
     import_csv_files(
         department_name,
+        department_state,
         officers_csv,
         assignments_csv,
         salaries_csv,
@@ -610,20 +617,25 @@ def advanced_csv_import(
 
 
 @click.command()
-@click.argument("name")
-@click.argument("short_name")
+@click.argument("name", required=True)
+@click.argument("short_name", required=True)
+@click.argument(
+    "state",
+    type=click.Choice([state.abbr for state in us.STATES]),
+)
 @click.argument("unique_internal_identifier", required=False)
 @with_appcontext
-def add_department(name, short_name, unique_internal_identifier):
+def add_department(name, short_name, state, unique_internal_identifier):
     """Add a new department to OpenOversight."""
     dept = Department(
         name=name,
         short_name=short_name,
+        state=state.upper(),
         unique_internal_identifier_label=unique_internal_identifier,
     )
     db.session.add(dept)
     db.session.commit()
-    print("Department added with id {}".format(dept.id))
+    print(f"Department added with id {dept.id}")
 
 
 @click.command()

OpenOversight/app/csv_imports.py

@@ -94,6 +94,7 @@ def _csv_reader(csv_filename):
 def _handle_officers_csv(
     officers_csv: str,
     department_name: str,
+    department_state: str,
     department_id: int,
     id_to_officer,
     force_create,
@@ -103,7 +104,9 @@ def _handle_officers_csv(
     with _csv_reader(officers_csv) as csv_reader:
         _check_provided_fields(
             csv_reader,
-            required_fields=["id", "department_name"] if not force_create else ["id"],
+            required_fields=["id", "department_name", "department_state"]
+            if not force_create
+            else ["id"],
             optional_fields=[
                 "last_name",
                 "first_name",
@@ -115,6 +118,7 @@ def _handle_officers_csv(
                 "birth_year",
                 "unique_internal_identifier",
                 "department_name",
+                "department_state",
                 # the following are unused, but allowed since they are included in the
                 # csv output
                 "badge_number",
@@ -131,6 +135,7 @@ def _handle_officers_csv(
             # can only update department with given name
             if not force_create:
                 assert row["department_name"] == department_name
+                assert row["department_state"] == department_state
             row["department_id"] = department_id
             connection_id = row["id"]
             if row["id"].startswith("#"):
@@ -352,6 +357,7 @@ def _handle_salaries(
 def _handle_incidents_csv(
     incidents_csv: str,
     department_name: str,
+    department_state: str,
     department_id: int,
     all_officers: Dict[str, Officer],
     id_to_incident: Dict[int, Incident],
@@ -362,7 +368,7 @@ def _handle_incidents_csv(
     with _csv_reader(incidents_csv) as csv_reader:
         _check_provided_fields(
             csv_reader,
-            required_fields=["id", "department_name"],
+            required_fields=["id", "department_name", "department_state"],
             optional_fields=[
                 "date",
                 "time",
@@ -384,6 +390,7 @@ def _handle_incidents_csv(
 
         for row in csv_reader:
             assert row["department_name"] == department_name
+            assert row["department_state"] == department_state
             row["department_id"] = department_id
             row["officers"] = _objects_from_split_field(
                 row.get("officer_ids"), all_officers
@@ -481,6 +488,7 @@ def _handle_links_csv(
 
 def import_csv_files(
     department_name: str,
+    department_state: str,
     officers_csv: Optional[str],
     assignments_csv: Optional[str],
     salaries_csv: Optional[str],
@@ -489,10 +497,13 @@ def import_csv_files(
     force_create: bool = False,
     overwrite_assignments: bool = False,
 ):
-    department = Department.query.filter_by(name=department_name).one_or_none()
+    department = Department.query.filter_by(
+        name=department_name, state=department_state
+    ).one_or_none()
     if department is None:
         raise Exception(
-            "Department with name '{}' does not exist!".format(department_name)
+            f"Department with name '{department_name}' in {department_state} "
+            "does not exist!"
         )
     department_id = department.id
 
@@ -502,7 +513,12 @@ def import_csv_files(
 
     if officers_csv is not None:
         new_officers = _handle_officers_csv(
-            officers_csv, department_name, department_id, id_to_officer, force_create
+            officers_csv,
+            department_name,
+            department_state,
+            department_id,
+            id_to_officer,
+            force_create,
         )
         all_officers.update(new_officers)
 
@@ -527,6 +543,7 @@ def import_csv_files(
         new_incidents = _handle_incidents_csv(
             incidents_csv,
             department_name,
+            department_state,
             department_id,
             all_officers,
             id_to_incident,

OpenOversight/app/models/database.py

@@ -39,22 +39,26 @@
 class Department(BaseModel):
     __tablename__ = "departments"
     id = db.Column(db.Integer, primary_key=True)
-    name = db.Column(db.String(255), index=True, unique=True, nullable=False)
+    name = db.Column(db.String(255), index=False, unique=False, nullable=False)
     short_name = db.Column(db.String(100), unique=False, nullable=False)
+    state = db.Column(db.String(2), server_default="", nullable=False)
 
     # See https://github.com/lucyparsons/OpenOversight/issues/462
     unique_internal_identifier_label = db.Column(
         db.String(100), unique=False, nullable=True
     )
 
+    __table_args__ = (UniqueConstraint("name", "state", name="departments_name_state"),)
+
     def __repr__(self):
-        return "<Department ID {}: {}>".format(self.id, self.name)
+        return f"<Department ID {self.id}: {self.name} {self.state}>"
 
     def to_custom_dict(self):
         return {
             "id": self.id,
             "name": self.name,
             "short_name": self.short_name,
+            "state": self.state,
             "unique_internal_identifier_label": self.unique_internal_identifier_label,
         }
 
@@ -76,7 +80,7 @@ class Job(BaseModel):
     )
 
     def __repr__(self):
-        return "<Job ID {}: {}>".format(self.id, self.job_title)
+        return f"<Job ID {self.id,}: {self.job_title}>"
 
     def __str__(self):
         return self.job_title
@@ -164,16 +168,14 @@ def full_name(self):
                 else self.middle_initial
             )
             if self.suffix:
-                return "{} {} {} {}".format(
-                    self.first_name, middle_initial, self.last_name, self.suffix
+                return (
+                    f"{self.first_name} {middle_initial} {self.last_name} {self.suffix}"
                 )
             else:
-                return "{} {} {}".format(
-                    self.first_name, middle_initial, self.last_name
-                )
+                return f"{self.first_name} {middle_initial} {self.last_name}"
         if self.suffix:
-            return "{} {} {}".format(self.first_name, self.last_name, self.suffix)
-        return "{} {}".format(self.first_name, self.last_name)
+            return f"{self.first_name} {self.last_name} {self.suffix}"
+        return f"{self.first_name} {self.last_name}"
 
     def race_label(self):
         if self.race is None:
@@ -222,16 +224,13 @@ def currently_on_force(self):
 
     def __repr__(self):
         if self.unique_internal_identifier:
-            return "<Officer ID {}: {} {} {} {} ({})>".format(
-                self.id,
-                self.first_name,
-                self.middle_initial,
-                self.last_name,
-                self.suffix,
-                self.unique_internal_identifier,
+            return (
+                f"<Officer ID {self.id}: {self.first_name} {self.middle_initial} "
+                + f"{self.last_name} {self.suffix} ({self.unique_internal_identifier})>"
             )
-        return "<Officer ID {}: {} {} {} {}>".format(
-            self.id, self.first_name, self.middle_initial, self.last_name, self.suffix
+        return (
+            f"<Officer ID {self.id}: {self.first_name} {self.middle_initial} "
+            + f"{self.last_name} {self.suffix}>"
         )
 
 
@@ -247,7 +246,7 @@ class Salary(BaseModel):
     is_fiscal_year = db.Column(db.Boolean, index=False, unique=False, nullable=False)
 
     def __repr__(self):
-        return "<Salary: ID {} : {}".format(self.officer_id, self.salary)
+        return f"<Salary: ID {self.officer_id} : {self.salary}"
 
 
 class Assignment(BaseModel):
@@ -265,7 +264,7 @@ class Assignment(BaseModel):
     resign_date = db.Column(db.Date, index=True, unique=False, nullable=True)
 
     def __repr__(self):
-        return "<Assignment: ID {} : {}>".format(self.officer_id, self.star_no)
+        return f"<Assignment: ID {self.officer_id} : {self.star_no}>"
 
 
 class Unit(BaseModel):
@@ -279,7 +278,7 @@ class Unit(BaseModel):
     )
 
     def __repr__(self):
-        return "Unit: {}".format(self.description)
+        return f"Unit: {self.description}"
 
 
 class Face(BaseModel):
@@ -324,7 +323,7 @@ class Face(BaseModel):
     __table_args__ = (UniqueConstraint("officer_id", "img_id", name="unique_faces"),)
 
     def __repr__(self):
-        return "<Tag ID {}: {} - {}>".format(self.id, self.officer_id, self.img_id)
+        return f"<Tag ID {self.id}: {self.officer_id} - {self.img_id}>"
 
 
 class Image(BaseModel):
@@ -356,7 +355,7 @@ class Image(BaseModel):
     department = db.relationship("Department", backref="raw_images")
 
     def __repr__(self):
-        return "<Image ID {}: {}>".format(self.id, self.filepath)
+        return f"<Image ID {self.id}: {self.filepath}>"
 
 
 incident_links = db.Table(
@@ -416,23 +415,22 @@ def validate_state(self, key, state):
 
     def __repr__(self):
         if self.street_name and self.cross_street2:
-            return "Intersection of {} and {}, {} {}".format(
-                self.street_name, self.cross_street2, self.city, self.state
+            return (
+                f"Intersection of {self.street_name} and {self.cross_street2}, "
+                + f"{self.city} {self.state}"
             )
         elif self.street_name and self.cross_street1:
-            return "Intersection of {} and {}, {} {}".format(
-                self.street_name, self.cross_street1, self.city, self.state
+            return (
+                f"Intersection of {self.street_name} and {self.cross_street1}, "
+                + f"{self.city} {self.state}"
             )
         elif self.street_name and self.cross_street1 and self.cross_street2:
-            return "Intersection of {} between {} and {}, {} {}".format(
-                self.street_name,
-                self.cross_street1,
-                self.cross_street2,
-                self.city,
-                self.state,
+            return (
+                f"Intersection of {self.street_name} between {self.cross_street1} "
+                f"and {self.cross_street2}, {self.city} {self.state}"
             )
         else:
-            return "{} {}".format(self.city, self.state)
+            return f"{self.city} {self.state}"
 
 
 class LicensePlate(BaseModel):

OpenOversight/migrations/versions/2023-07-26-1551_18f43ac4622f_add_state_column_to_departments.py

@@ -0,0 +1,38 @@
+"""add state column to departments
+
+Revision ID: 18f43ac4622f
+Revises: 1931b987ce0d
+Create Date: 2023-07-26 15:51:05.329701
+
+"""
+import sqlalchemy as sa
+from alembic import op
+
+
+# revision identifiers, used by Alembic.
+revision = "18f43ac4622f"
+down_revision = "1931b987ce0d"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("departments", schema=None) as batch_op:
+        batch_op.add_column(
+            sa.Column("state", sa.String(length=2), server_default="", nullable=False)
+        )
+        batch_op.drop_index("ix_departments_name")
+        batch_op.create_unique_constraint("departments_name_state", ["name", "state"])
+
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("departments", schema=None) as batch_op:
+        batch_op.drop_constraint("departments_name_state", type_="unique")
+        batch_op.create_index("ix_departments_name", ["name"], unique=False)
+        batch_op.drop_column("state")
+
+    # ### end Alembic commands ###