fix: Prevent circular dependencies when your own models import our types

Author: kevinrenskers

generic_notifications/types.py

@@ -1,11 +1,13 @@
 from abc import ABC
-from typing import Any, Type
+from typing import TYPE_CHECKING, Any, Type
 
 from .channels import EmailChannel, NotificationChannel
 from .frequencies import DailyFrequency, NotificationFrequency, RealtimeFrequency
-from .models import DisabledNotificationTypeChannel, EmailFrequency, Notification
 from .registry import registry
 
+if TYPE_CHECKING:
+    from .models import Notification
+
 
 class NotificationType(ABC):
     """
@@ -22,7 +24,7 @@ def __str__(self) -> str:
         return self.name
 
     @classmethod
-    def should_save(cls, notification: Notification) -> bool:
+    def should_save(cls, notification: "Notification") -> bool:
         """
         A hook to prevent the saving of a new notification. You can use
         this hook to find similar (unread) notifications and then instead
@@ -34,14 +36,14 @@ def should_save(cls, notification: Notification) -> bool:
         """
         return True
 
-    def get_subject(self, notification: Notification) -> str:
+    def get_subject(self, notification: "Notification") -> str:
         """
         Generate dynamic subject based on notification data.
         Override this in subclasses for custom behavior.
         """
         return ""
 
-    def get_text(self, notification: Notification) -> str:
+    def get_text(self, notification: "Notification") -> str:
         """
         Generate dynamic text based on notification data.
         Override this in subclasses for custom behavior.
@@ -57,6 +59,7 @@ def set_email_frequency(cls, user: Any, frequency: Type[NotificationFrequency])
             user: The user to set the frequency for
             frequency: NotificationFrequency class
         """
+        from .models import EmailFrequency
 
         EmailFrequency.objects.update_or_create(
             user=user, notification_type=cls.key, defaults={"frequency": frequency.key}
@@ -73,6 +76,7 @@ def get_email_frequency(cls, user: Any) -> Type[NotificationFrequency]:
         Returns:
             NotificationFrequency class (either user preference or default)
         """
+        from .models import EmailFrequency
 
         try:
             user_frequency = EmailFrequency.objects.get(user=user, notification_type=cls.key)
@@ -88,6 +92,7 @@ def reset_email_frequency_to_default(cls, user: Any) -> None:
         Args:
             user: The user to reset the frequency for
         """
+        from .models import EmailFrequency
 
         EmailFrequency.objects.filter(user=user, notification_type=cls.key).delete()
 
@@ -103,6 +108,7 @@ def get_enabled_channels(cls, user: Any) -> list[Type[NotificationChannel]]:
         Returns:
             List of enabled NotificationChannel classes
         """
+        from .models import DisabledNotificationTypeChannel
 
         # Get all disabled channel keys for this user/notification type in one query
         disabled_channel_keys = set(
@@ -131,6 +137,7 @@ def is_channel_enabled(cls, user: Any, channel: Type[NotificationChannel]) -> bo
         Returns:
             True if channel is enabled, False if disabled
         """
+        from .models import DisabledNotificationTypeChannel
 
         return not DisabledNotificationTypeChannel.objects.filter(
             user=user, notification_type=cls.key, channel=channel.key
@@ -145,6 +152,7 @@ def disable_channel(cls, user: Any, channel: Type[NotificationChannel]) -> None:
             user: User instance
             channel: NotificationChannel class
         """
+        from .models import DisabledNotificationTypeChannel
 
         DisabledNotificationTypeChannel.objects.get_or_create(user=user, notification_type=cls.key, channel=channel.key)
 
@@ -157,6 +165,7 @@ def enable_channel(cls, user: Any, channel: Type[NotificationChannel]) -> None:
             user: User instance
             channel: NotificationChannel class
         """
+        from .models import DisabledNotificationTypeChannel
 
         DisabledNotificationTypeChannel.objects.filter(
             user=user, notification_type=cls.key, channel=channel.key

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "django-generic-notifications"
-version = "1.1.0"
+version = "1.1.1"
 description = "A flexible, multi-channel notification system for Django applications with built-in support for email digests, user preferences, and extensible delivery channels."
 authors = [
     {name = "Kevin Renskers", email = "kevin@loopwerk.io"},