Classifications refactor

archeryutils/__init__.py

@@ -1,7 +1,7 @@
 """Package providing code for various archery utilities."""
 from archeryutils import load_rounds, rounds, targets
 from archeryutils.handicaps import handicap_equations, handicap_functions
-from archeryutils.classifications import classifications
+import archeryutils.classifications as classifications
 
 __all__ = [
     "rounds",

archeryutils/classifications/__init__.py

@@ -1 +1,28 @@
 """Module providing various classification functionalities."""
+from .agb_outdoor_classifications import (
+    calculate_agb_outdoor_classification,
+    agb_outdoor_classification_scores,
+)
+from .agb_indoor_classifications import (
+    calculate_agb_indoor_classification,
+    agb_indoor_classification_scores,
+)
+from .agb_old_indoor_classifications import (
+    calculate_agb_old_indoor_classification,
+    agb_old_indoor_classification_scores,
+)
+from .agb_field_classifications import (
+    calculate_agb_field_classification,
+    agb_field_classification_scores,
+)
+
+__all__ = [
+    "calculate_agb_outdoor_classification",
+    "agb_outdoor_classification_scores",
+    "calculate_agb_indoor_classification",
+    "agb_indoor_classification_scores",
+    "calculate_agb_old_indoor_classification",
+    "agb_old_indoor_classification_scores",
+    "calculate_agb_field_classification",
+    "agb_field_classification_scores",
+]

archeryutils/classifications/agb_field_classifications.py

@@ -0,0 +1,312 @@
+"""
+Code for calculating Archery GB classifications.
+
+Extended Summary
+----------------
+Code to add functionality to the basic handicap equations code
+in handicap_equations.py including inverse function and display.
+
+Routine Listings
+----------------
+_make_agb_field_classification_dict
+calculate_agb_field_classification
+agb_field_classification_scores
+
+"""
+import re
+from typing import List, Dict, Any
+import numpy as np
+
+from archeryutils import load_rounds
+import archeryutils.classifications.classification_utils as cls_funcs
+
+
+ALL_AGBFIELD_ROUNDS = load_rounds.read_json_to_round_dict(
+    [
+        "WA_field.json",
+    ]
+)
+
+
+def _make_agb_field_classification_dict() -> Dict[str, Dict[str, Any]]:
+    """
+    Generate AGB outdoor classification data.
+
+    Generate a dictionary of dictionaries providing handicaps for
+    each classification band.
+
+    Parameters
+    ----------
+    None
+
+    Returns
+    -------
+    classification_dict : dict of str : dict of str: list
+        dictionary indexed on group name (e.g 'adult_female_recurve')
+        containing list of scores associated with each classification
+
+    References
+    ----------
+    ArcheryGB 2023 Rules of Shooting
+    ArcheryGB Shooting Administrative Procedures - SAP7 (2023)
+    """
+    agb_field_classes = [
+        "Grand Master Bowman",
+        "Master Bowman",
+        "Bowman",
+        "1st Class",
+        "2nd Class",
+        "3rd Class",
+    ]
+
+    # Generate dict of classifications
+    # for both bowstyles, for both genders
+    classification_dict = {}
+    classification_dict[cls_funcs.get_groupname("Compound", "Male", "Adult")] = {
+        "classes": agb_field_classes,
+        "class_scores": [393, 377, 344, 312, 279, 247],
+    }
+    classification_dict[cls_funcs.get_groupname("Compound", "Female", "Adult")] = {
+        "classes": agb_field_classes,
+        "class_scores": [376, 361, 330, 299, 268, 237],
+    }
+    classification_dict[cls_funcs.get_groupname("Recurve", "Male", "Adult")] = {
+        "classes": agb_field_classes,
+        "class_scores": [338, 317, 288, 260, 231, 203],
+    }
+    classification_dict[cls_funcs.get_groupname("Recurve", "Female", "Adult")] = {
+        "classes": agb_field_classes,
+        "class_scores": [322, 302, 275, 247, 220, 193],
+    }
+    classification_dict[cls_funcs.get_groupname("Barebow", "Male", "Adult")] = {
+        "classes": agb_field_classes,
+        "class_scores": [328, 307, 279, 252, 224, 197],
+    }
+    classification_dict[cls_funcs.get_groupname("Barebow", "Female", "Adult")] = {
+        "classes": agb_field_classes,
+        "class_scores": [303, 284, 258, 233, 207, 182],
+    }
+    classification_dict[cls_funcs.get_groupname("Longbow", "Male", "Adult")] = {
+        "classes": agb_field_classes,
+        "class_scores": [201, 188, 171, 155, 137, 121],
+    }
+    classification_dict[cls_funcs.get_groupname("Longbow", "Female", "Adult")] = {
+        "classes": agb_field_classes,
+        "class_scores": [303, 284, 258, 233, 207, 182],
+    }
+    classification_dict[cls_funcs.get_groupname("Traditional", "Male", "Adult")] = {
+        "classes": agb_field_classes,
+        "class_scores": [262, 245, 223, 202, 178, 157],
+    }
+    classification_dict[cls_funcs.get_groupname("Traditional", "Female", "Adult")] = {
+        "classes": agb_field_classes,
+        "class_scores": [197, 184, 167, 152, 134, 118],
+    }
+    classification_dict[cls_funcs.get_groupname("Flatbow", "Male", "Adult")] = {
+        "classes": agb_field_classes,
+        "class_scores": [262, 245, 223, 202, 178, 157],
+    }
+    classification_dict[cls_funcs.get_groupname("Flatbow", "Female", "Adult")] = {
+        "classes": agb_field_classes,
+        "class_scores": [197, 184, 167, 152, 134, 118],
+    }
+
+    # Juniors
+    classification_dict[cls_funcs.get_groupname("Compound", "Male", "Under 18")] = {
+        "classes": agb_field_classes,
+        "class_scores": [385, 369, 337, 306, 273, 242],
+    }
+
+    classification_dict[cls_funcs.get_groupname("Compound", "Female", "Under 18")] = {
+        "classes": agb_field_classes,
+        "class_scores": [357, 343, 314, 284, 255, 225],
+    }
+
+    classification_dict[cls_funcs.get_groupname("Recurve", "Male", "Under 18")] = {
+        "classes": agb_field_classes,
+        "class_scores": [311, 292, 265, 239, 213, 187],
+    }
+
+    classification_dict[cls_funcs.get_groupname("Recurve", "Female", "Under 18")] = {
+        "classes": agb_field_classes,
+        "class_scores": [280, 263, 239, 215, 191, 168],
+    }
+
+    classification_dict[cls_funcs.get_groupname("Barebow", "Male", "Under 18")] = {
+        "classes": agb_field_classes,
+        "class_scores": [298, 279, 254, 229, 204, 179],
+    }
+
+    classification_dict[cls_funcs.get_groupname("Barebow", "Female", "Under 18")] = {
+        "classes": agb_field_classes,
+        "class_scores": [251, 236, 214, 193, 172, 151],
+    }
+
+    classification_dict[cls_funcs.get_groupname("Longbow", "Male", "Under 18")] = {
+        "classes": agb_field_classes,
+        "class_scores": [161, 150, 137, 124, 109, 96],
+    }
+
+    classification_dict[cls_funcs.get_groupname("Longbow", "Female", "Under 18")] = {
+        "classes": agb_field_classes,
+        "class_scores": [122, 114, 103, 94, 83, 73],
+    }
+
+    classification_dict[cls_funcs.get_groupname("Traditional", "Male", "Under 18")] = {
+        "classes": agb_field_classes,
+        "class_scores": [210, 196, 178, 161, 143, 126],
+    }
+
+    classification_dict[
+        cls_funcs.get_groupname("Traditional", "Female", "Under 18")
+    ] = {
+        "classes": agb_field_classes,
+        "class_scores": [158, 147, 134, 121, 107, 95],
+    }
+
+    classification_dict[cls_funcs.get_groupname("Flatbow", "Male", "Under 18")] = {
+        "classes": agb_field_classes,
+        "class_scores": [210, 196, 178, 161, 143, 126],
+    }
+
+    classification_dict[cls_funcs.get_groupname("Flatbow", "Female", "Under 18")] = {
+        "classes": agb_field_classes,
+        "class_scores": [158, 147, 134, 121, 107, 95],
+    }
+
+    return classification_dict
+
+
+agb_field_classifications = _make_agb_field_classification_dict()
+
+del _make_agb_field_classification_dict
+
+
+def calculate_agb_field_classification(
+    roundname: str, score: float, bowstyle: str, gender: str, age_group: str
+) -> str:
+    """
+    Calculate AGB field classification from score.
+
+    Subroutine to calculate a classification from a score given suitable inputs.
+
+    Parameters
+    ----------
+    roundname : str
+        name of round shot as given by 'codename' in json
+    score : int
+        numerical score on the round to calculate classification for
+    bowstyle : str
+        archer's bowstyle under AGB outdoor target rules
+    gender : str
+        archer's gender under AGB outdoor target rules
+    age_group : str
+        archer's age group under AGB outdoor target rules
+
+    Returns
+    -------
+    classification_from_score : str
+        the classification appropriate for this score
+
+    References
+    ----------
+    ArcheryGB 2023 Rules of Shooting
+    ArcheryGB Shooting Administrative Procedures - SAP7 (2023)
+    """
+    # Check score is valid
+    if score < 0 or score > ALL_AGBFIELD_ROUNDS[roundname].max_score():
+        raise ValueError(
+            f"Invalid score of {score} for a {roundname}. "
+            f"Should be in range 0-{ALL_AGBFIELD_ROUNDS[roundname].max_score()}."
+        )
+
+    # deal with reduced categories:
+    if age_group.lower().replace(" ", "") in ("adult", "50+", "under21"):
+        age_group = "Adult"
+    elif re.compile("under(18|16|15|14|12)").match(age_group.lower().replace(" ", "")):
+        age_group = "Under 18"
+
+    groupname = cls_funcs.get_groupname(bowstyle, gender, age_group)
+
+    # Get scores required on this round for each classification
+    group_data = agb_field_classifications[groupname]
+
+    # Check Round is appropriate:
+    # Sighted can have any Red 24, unsightes can have any blue 24
+    if (
+        bowstyle.lower() in ("compound", "recurve")
+        and "wa_field_24_red_" not in roundname
+    ):
+        return "unclassified"
+    if (
+        bowstyle.lower() in ("barebow", "longbow", "traditional", "flatbow")
+        and "wa_field_24_blue_" not in roundname
+    ):
+        return "unclassified"
+
+    # What is the highest classification this score gets?
+    class_scores: Dict[str, Any] = dict(
+        zip(group_data["classes"], group_data["class_scores"])
+    )
+    for item in class_scores:
+        if class_scores[item] > score:
+            pass
+        else:
+            return item
+
+    # if lower than 3rd class score return "UC"
+    return "unclassified"
+
+
+def agb_field_classification_scores(
+    roundname: str, bowstyle: str, gender: str, age_group: str
+) -> List[int]:
+    """
+    Calculate AGB field classification scores for category.
+
+    Subroutine to calculate classification scores for a specific category and round.
+    Appropriate ArcheryGB age groups and classifications.
+
+    Parameters
+    ----------
+    roundname : str
+        name of round shot as given by 'codename' in json
+    bowstyle : str
+        archer's bowstyle under AGB outdoor target rules
+    gender : str
+        archer's gender under AGB outdoor target rules
+    age_group : str
+        archer's age group under AGB outdoor target rules
+
+    Returns
+    -------
+    classification_scores : ndarray
+        abbreviation of the classification appropriate for this score
+
+    References
+    ----------
+    ArcheryGB Rules of Shooting
+    ArcheryGB Shooting Administrative Procedures - SAP7
+    """
+    # deal with reduced categories:
+    if age_group.lower().replace(" ", "") in ("adult", "50+", "under21"):
+        age_group = "Adult"
+    elif re.compile("under(18|16|15|14|12)").match(age_group.lower().replace(" ", "")):
+        age_group = "Under 18"
+
+    groupname = cls_funcs.get_groupname(bowstyle, gender, age_group)
+    group_data = agb_field_classifications[groupname]
+
+    # Get scores required on this round for each classification
+    class_scores = group_data["class_scores"]
+
+    # Make sure that hc.eq.score_for_round did not return array to satisfy mypy
+    if any(isinstance(x, np.ndarray) for x in class_scores):
+        raise TypeError(
+            "score_for_round is attempting to return an array when float expected."
+        )
+    # Score threshold should be int (score_for_round called with round=True)
+    # Enforce this for better code and to satisfy mypy
+    int_class_scores = [int(x) for x in class_scores]
+
+    return int_class_scores