Deprecate "target profession" and "current profession" kwargs

This library is being stripped back to a more basic form. There is now a PendingDeprecationWarning if users use either "target profession" or "current profession" keyword arguments, and in version 7 they will be fully deprecated. Please consider subclassing these classes if you wish to continue using these keyword arguments!

Author: jonodrew

example.csv

@@ -1 +1 @@
-first name,last name,email,role,organisation,grade,current profession,target profession
+first name,last name,email,role,organisation,grade,profession

matching/mentee.py

@@ -1,3 +1,4 @@
+import warnings
 from typing import TYPE_CHECKING
 
 from matching.person import Person
@@ -13,9 +14,16 @@ def __init__(self, **kwargs):
         they're in at the moment
         :param kwargs:
         """
-        self.target_profession = kwargs.get(
-            "target profession", kwargs.get("current profession")
-        )
+        if (profession := kwargs.get("target profession")) is not None:
+            warnings.warn(
+                "In version 7, 'target profession' will be deprecated in favour of"
+                " 'profession'. If you need to keep using 'target profession', please"
+                " subclass Mentee",
+                PendingDeprecationWarning,
+            )
+            self.target_profession = profession
+        else:
+            self.profession = self.target_profession = kwargs.get("profession", "")
         super(Mentee, self).__init__(**kwargs)
 
     @property

matching/person.py

@@ -1,3 +1,4 @@
+import warnings
 from typing import List, Dict, Union
 
 CorePersonDict = Dict[str, Dict[str, Union[str, int]]]
@@ -13,7 +14,16 @@ def __init__(self, **kwargs):
         """
         self.grade: int = int(kwargs.get("grade"))
         self.organisation: str = kwargs.get("organisation", None)
-        self.current_profession: str = kwargs.get("current profession", None)
+        if (profession := kwargs.get("current profession")) is not None:
+            warnings.warn(
+                "In version 7, 'current profession' will be deprecated in favour of"
+                " 'profession'. If you need to keep using 'current profession', please"
+                " subclass Person",
+                PendingDeprecationWarning,
+            )
+            self.current_profession = self.profession = profession
+        else:
+            self.profession = self.current_profession = kwargs.get("profession", "")
         self.email = kwargs.get("email", None)
         self.first_name = kwargs.get("first name", None)
         self.last_name = kwargs.get("last name", None)
@@ -55,6 +65,7 @@ def core_to_dict(self) -> CorePersonDict:
                 "role": self.role,
                 "organisation": self.organisation,
                 "grade": self.grade,
+                "profession": self.profession,
                 "current profession": self.current_profession,
             }
         }

tests/conftest.py

@@ -67,7 +67,7 @@ def base_data() -> dict:
         "role": "N/A",
         "organisation": "Department of Fun",
         "grade": 5,
-        "current profession": "Policy",
+        "profession": "Policy",
     }
 
 

tests/test_person.py

@@ -49,3 +49,12 @@ def test_person_is_deserializable(
         person_as_dict = json.loads(person_as_json)
         recreated_person = ParticipantFactory.create_from_dict(person_as_dict)
         assert recreated_person == test_person
+
+    @pytest.mark.parametrize(
+        ["match_class", "attribute"],
+        [(Person, "current profession"), (Mentee, "target profession")],
+    )
+    def test_deprecation_warnings(self, match_class, attribute, base_data):
+        with pytest.deprecated_call():
+            base_data[attribute] = "error"
+            match_class(**base_data)