change restricted councils to be councils to select from first

Author: struan

crowdsourcer/management/commands/import_volunteers.py

@@ -119,9 +119,9 @@ def add_arguments(self, parser):
         )
 
         parser.add_argument(
-            "--council_restrictions",
+            "--preferred_councils",
             action="store_true",
-            help="the data contains a column with council restrictions, e.g Welsh councils.",
+            help="the data contains a column with councils to select from first, e.g Welsh councils.",
         )
 
         parser.add_argument(
@@ -156,8 +156,8 @@ def init(self, file, options):
             self.column_names.append("assignment_count")
             self.usecols.append("How many sections?")
 
-        if options["council_restrictions"]:
-            self.column_names.append("council_restrictions")
+        if options["preferred_councils"]:
+            self.column_names.append("preferred_councils")
             self.usecols.append("Nations/London")
 
         if options["debug"]:
@@ -170,8 +170,8 @@ def get_df(self, filename):
         )
         df.columns = self.column_names
 
-        if "council_restrictions" in df.columns:
-            df["council_restrictions"] = df["council_restrictions"].astype(str)
+        if "preferred_councils" in df.columns:
+            df["preferred_councils"] = df["preferred_councils"].astype(str)
 
         return df
 
@@ -330,18 +330,18 @@ def add_users_and_assignments(self, df, response_type, session, rt, options):
 
             included_types = []
             included_countries = []
-            if options["council_restrictions"]:
-                restrictions = row["council_restrictions"].split(",")
+            if options["preferred_councils"]:
+                preferred = row["preferred_councils"].split(",")
 
-                for r in restrictions:
-                    if r.lower() in [
+                for p in preferred:
+                    if p.lower() in [
                         "scotland",
                         "england",
                         "wales",
                         "northern ireland",
                     ]:
-                        included_countries.append(r.lower())
-                    elif r == "London":
+                        included_countries.append(p.lower())
+                    elif p == "London":
                         included_types.append("LBO")
 
             councils_to_assign = PublicAuthority.objects.filter(
@@ -350,25 +350,53 @@ def add_users_and_assignments(self, df, response_type, session, rt, options):
                 Q(id__in=assigned_councils) | Q(type="COMB") | Q(do_not_mark=True)
             )
 
+            preferred_councils = councils_to_assign
+            has_preferred = False
             if len(included_types) > 0 and len(included_countries) > 0:
-                councils_to_assign = councils_to_assign.filter(
+                has_preferred = True
+                preferred_councils = preferred_councils.filter(
                     Q(country__in=included_countries) | Q(type__in=included_types)
                 )
             elif len(included_types) > 0:
-                councils_to_assign = councils_to_assign.filter(type__in=included_types)
+                has_preferred = True
+                preferred_councils = preferred_councils.filter(type__in=included_types)
             elif len(included_countries) > 0:
-                councils_to_assign = councils_to_assign.filter(
+                has_preferred = True
+                preferred_councils = preferred_councils.filter(
                     country__in=included_countries
                 )
 
-            councils_to_assign = councils_to_assign[:num_councils]
+            if has_preferred:
+                preferred_councils = preferred_councils[:num_councils]
+                councils_left = num_councils - preferred_councils.count()
+                councils_to_assign = councils_to_assign.exclude(
+                    id__in=preferred_councils
+                )[:councils_left]
+                council_count = preferred_councils.count() + councils_to_assign.count()
+            else:
+                councils_to_assign = councils_to_assign[:num_councils]
+                council_count = councils_to_assign.count()
 
-            if councils_to_assign.count() == 0:
+            if council_count == 0:
                 self.stdout.write(
                     f"{YELLOW}No councils left in {s.title} for {u.email}{NOBOLD}"
                 )
 
             if options["make_assignments"] is True:
+                if self.debug:
+                    self.stdout.write(
+                        f"{YELLOW}Assigning {council_count} councils in {s.title} to {u.email}{NOBOLD}"
+                    )
+
+                if has_preferred:
+                    for council in preferred_councils:
+                        a, created = Assigned.objects.update_or_create(
+                            user=u,
+                            section=s,
+                            authority=council,
+                            marking_session=session,
+                            response_type=rt,
+                        )
                 for council in councils_to_assign:
                     a, created = Assigned.objects.update_or_create(
                         user=u,
@@ -415,7 +443,7 @@ def handle(
             ).count()
             for section in Section.objects.filter(marking_session=session).all():
                 assigned = Assigned.objects.filter(
-                    section=section, response_type=rt
+                    section=section, response_type=rt, marking_session=session
                 ).count()
                 if assigned != council_count:
                     self.stdout.write(

crowdsourcer/tests/data/volunteers_with_council_restriction.csv

@@ -1,2 +1,2 @@
 First name,Last name,Email,Council Area,Type of Volunteering,Assigned Section,Nations/London
-First,Last,first_last@example.org,Aberdeenshire Council,Scorecards Volunteering,Transport,"Scotland,London"
+First,Last,first_last@example.org,Aberdeenshire Council,Scorecards Volunteering,Transport,"England,London"

crowdsourcer/tests/test_import_volunteers_script.py

@@ -51,7 +51,11 @@ def add_extra_councils(self):
         ms = MarkingSession.objects.get(label="Default")
         for council in councils:
             a = PublicAuthority.objects.create(
-                name=council[0], unique_id=council[1], type="DIS", questiongroup_id=2
+                name=council[0],
+                country="england",
+                unique_id=council[1],
+                type="DIS",
+                questiongroup_id=2,
             )
             a.marking_session.set([ms])
 
@@ -442,7 +446,7 @@ def test_assignment_limits_in_file(self):
             3,
         )
 
-    def test_council_restrictions(self):
+    def test_council_preferences(self):
         data_file = (
             pathlib.Path(__file__).parent.resolve()
             / "data"
@@ -457,53 +461,53 @@ def test_council_restrictions(self):
             file=data_file,
             add_users=True,
             make_assignments=True,
-            council_restrictions=True,
+            preferred_councils=True,
         )
         self.assertEquals(User.objects.count(), 1)
         self.assertEquals(Marker.objects.count(), 1)
-        self.assertEquals(Assigned.objects.count(), 1)
+        self.assertEquals(Assigned.objects.count(), 6)
         self.assertEquals(
             Assigned.objects.filter(
                 marking_session__label="Default", section__title="Transport"
             ).count(),
-            1,
+            6,
         )
 
-        a = Assigned.objects.filter(
-            marking_session__label="Default", section__title="Transport"
-        ).first()
-        self.assertEquals(a.authority.name, "Aberdeen City Council")
+        councils = [a.authority.name for a in Assigned.objects.all()]
+        self.assertTrue("Aberdeen City Council" not in councils)
 
         # need to remove them all as won't assign to people with existing assignments
         Assigned.objects.all().delete()
 
-        ob = PublicAuthority.objects.get(unique_id="E90008")
+        ob = PublicAuthority.objects.get(unique_id="E90001")
         ob.type = "LBO"
         ob.save()
 
+        PublicAuthority.objects.filter(
+            unique_id__in=("E90004", "E90005", "E90006", "E90007")
+        ).delete()
+
         self.call_command(
             "import_volunteers",
             session="Default",
             file=data_file,
             add_users=True,
             make_assignments=True,
-            council_restrictions=True,
+            preferred_councils=True,
         )
         self.assertEquals(User.objects.count(), 1)
         self.assertEquals(Marker.objects.count(), 1)
-        self.assertEquals(Assigned.objects.count(), 2)
+        self.assertEquals(Assigned.objects.count(), 6)
         self.assertEquals(
             Assigned.objects.filter(
                 marking_session__label="Default", section__title="Transport"
             ).count(),
-            2,
+            6,
         )
 
-        a = Assigned.objects.filter(
-            marking_session__label="Default", section__title="Transport"
-        )
-        self.assertEquals(a[0].authority.name, "Aberdeen City Council")
-        self.assertEquals(a[1].authority.name, "Old Borsetshire")
+        councils = [a.authority.name for a in Assigned.objects.all()]
+        self.assertTrue("East Borsetshire" in councils)
+        self.assertTrue("Aberdeen City Council" in councils)
 
     def test_audit_assignments(self):
         data_file = pathlib.Path(__file__).parent.resolve() / "data" / "volunteers.csv"