feat: merge mail-types into single function

Author: crosspolar

tapir/accounts/forms.py

@@ -6,18 +6,22 @@
 
 from tapir import settings
 from tapir.accounts.models import TapirUser
-from tapir.core.tapir_email_base import get_mails_not_mandatory, get_mails_mandatory
+from tapir.core.tapir_email_base import (
+    get_mail_types,
+)
 from tapir.settings import PERMISSION_COOP_ADMIN, GROUP_VORSTAND
 from tapir.utils.forms import DateInputTapir, TapirPhoneNumberField
 
 
 class TapirUserSelfUpdateForm(forms.ModelForm):
     mandatory_mails = forms.MultipleChoiceField(
         required=False,
-        choices=get_mails_mandatory(default="both"),
+        choices=get_mail_types(enabled_by_default="both", mandatory=True),
         label=_("Mandatory Emails"),
         widget=CheckboxSelectMultiple(),
-        initial=[m[0] for m in get_mails_mandatory(default="both")],
+        initial=[
+            m[0] for m in get_mail_types(enabled_by_default="both", mandatory=True)
+        ],
     )
 
     def __init__(self, *args, **kwargs):
@@ -29,7 +33,7 @@ class Meta:
         fields = ["usage_name", "pronouns", "additional_mails"]
         widgets = {
             "additional_mails": forms.widgets.CheckboxSelectMultiple(
-                choices=get_mails_not_mandatory(default="both")
+                choices=get_mail_types(enabled_by_default="both", mandatory=False)
             )
         }
 

tapir/accounts/models.py

@@ -16,7 +16,7 @@
 from tapir import utils, settings
 from tapir.coop.config import get_ids_of_users_registered_to_a_shift_with_capability
 from tapir.core.config import help_text_displayed_name
-from tapir.core.tapir_email_base import get_mails_not_mandatory
+from tapir.core.tapir_email_base import get_mails_not_mandatory, get_mail_types
 from tapir.log.models import UpdateModelLogEntry
 from tapir.settings import (
     PERMISSIONS,
@@ -62,7 +62,7 @@ class TapirUserManager(UserManager.from_queryset(TapirUserQuerySet)):
 
 
 def get_mails_not_mandatory_and_default():
-    return [m[0] for m in get_mails_not_mandatory(default=True)]
+    return [m[0] for m in get_mail_types(mandatory=False, enabled_by_default=True)]
 
 
 class TapirUser(AbstractUser):

tapir/core/tapir_email_base.py

@@ -17,46 +17,35 @@
 
 all_emails: Dict[str, Type[TapirEmailBase]] = {}
 
-enabled_by_default_options = Literal[True, False, "both"]
+MAIL_OPTIONS_ = Literal[True, False, "both"]
 
 
-def get_all_emails(
-    default: enabled_by_default_options = True,
-) -> list[Type[TapirEmailBase]]:
+def get_mail_types(
+    enabled_by_default: MAIL_OPTIONS_ = True,
+    mandatory: MAIL_OPTIONS_ = True,
+) -> List[Tuple[str, str]]:
     """
     default="both" returns both, default and non-default mails.
     default=False returns mails not being sent by default
     """
-    if default != "both":
-        return [
-            mail
-            for mail in TapirEmailBase.__subclasses__()
-            if mail.enabled_by_default is default
-        ]
-    else:
-        return [mail for mail in TapirEmailBase.__subclasses__()]
-
-
-def get_mails_not_mandatory(
-    default: enabled_by_default_options = "both",
-) -> List[Tuple[str, str]]:
-    return [
-        (mail.get_unique_id(), mail.get_name())
-        for mail in get_all_emails(default=default)
-        if mail.mandatory is False
-    ]
 
+    def filter_mail(mail):
+        return (
+            enabled_by_default == "both"
+            or mail.enabled_by_default is enabled_by_default
+        ) and (mandatory == "both" or mail.mandatory is mandatory)
 
-def get_mails_mandatory(
-    default: enabled_by_default_options = "both",
-) -> List[Tuple[str, str]]:
     return [
         (mail.get_unique_id(), mail.get_name())
-        for mail in get_all_emails(default=default)
-        if mail.mandatory is True
+        for mail in TapirEmailBase.__subclasses__()
+        if filter_mail(mail)
     ]
 
 
+def get_mails_not_mandatory() -> List[Tuple[str, str]]:
+    return get_mail_types(mandatory=False, enabled_by_default="both")
+
+
 class TapirEmailBase:
     enabled_by_default = True  # mails are opt-out by default
     mandatory = True  # mails are mandatory by default
@@ -145,7 +134,7 @@ def send_to_share_owner(self, actor: User | None, recipient: ShareOwner):
 
     def user_wants_to_or_has_to_receive_mail(self, user: TapirUser):
         return (self.get_unique_id() in user.additional_mails) | (
-            self.get_unique_id() in [x[0] for x in get_mails_mandatory()]
+            self.get_unique_id() in [x[0] for x in get_mail_types(mandatory=True)]
         )
 
     def send_to_tapir_user(self, actor: User | None, recipient: TapirUser):