android-notify 1.55__py3-none-any.whl → 1.56__py3-none-any.whl

android_notify/base.py

@@ -0,0 +1,82 @@
+"""Assists Notification Class with Args keeps sub class cleaner"""
+from dataclasses import dataclass, fields
+import difflib
+from .styles import NotificationStyles
+
+@dataclass
+class BaseNotification:
+    """Encapsulator"""
+
+    # Basic options
+    title: str = ''
+    message: str = ''
+    style: str = 'simple'
+
+    # Style-specific attributes
+    big_picture_path: str = ''
+    large_icon_path: str = ''
+    progress_max_value: int = 100
+    progress_current_value: float = 0.0 # Also Takes in Ints
+    body: str = ''
+
+    # Notification Functions
+    identifer: str = ''
+    callback: object = None
+
+    # Advanced Options
+    app_icon: str = 'Defaults to package app icon'
+    channel_name: str = 'Default Channel'
+    channel_id: str = 'default_channel'
+    silent: bool = False
+    logs: bool = False
+
+    def __init__(self, **kwargs):
+        """Custom init to handle validation before dataclass assigns values"""
+        # Validate provided arguments
+        self.validate_args(kwargs)
+
+        # Assign validated values using the normal dataclass behavior
+        for field_ in fields(self):
+            field_name = field_.name
+            setattr(self, field_name, kwargs.get(field_name, getattr(self, field_name)))
+
+    def validate_args(self, inputted_kwargs):
+        """Check for unexpected arguments and suggest corrections before Python validation"""
+        default_fields =  {field.name : field.type for field in fields(self)} #{'title': <class 'str'>, 'message': <class 'str'>,...
+        allowed_fields_keys = set(default_fields.keys())
+
+        # Identify invalid arguments
+        invalid_args = set(inputted_kwargs) - allowed_fields_keys
+        if invalid_args:
+            suggestions = []
+            for arg in invalid_args:
+                closest_match = difflib.get_close_matches(arg, allowed_fields_keys, n=1, cutoff=0.6)
+                if closest_match:
+                    suggestions.append(f"* '{arg}' is invalid -> Did you mean '{closest_match[0]}'?")
+                else:
+                    suggestions.append(f"* '{arg}' is not a valid argument.")
+
+            suggestion_text = '\n'.join(suggestions)
+            raise ValueError(f"Invalid arguments provided:\n{suggestion_text}")
+
+        # Validating types
+        for each_arg in inputted_kwargs.keys():
+            expected_type = default_fields[each_arg]
+            actual_value = inputted_kwargs[each_arg]
+
+            # Allow both int and float for progress_current_value
+            if each_arg == "progress_current_value":
+                if not isinstance(actual_value, (int, float)):
+                    raise TypeError(f"Expected '{each_arg}' to be int or float, got {type(actual_value)} instead.")
+            else:
+                if not isinstance(actual_value, expected_type):
+                    raise TypeError(f"Expected '{each_arg}' to be {expected_type}, got {type(actual_value)} instead.")
+
+        # Validate `style` values
+        style_values = [value for key, value in vars(NotificationStyles).items() if not key.startswith("__")]
+        if 'style' in inputted_kwargs and inputted_kwargs['style'] not in ['',*style_values]:
+            inputted_style=inputted_kwargs['style']
+            allowed_styles=', '.join(style_values)
+            raise ValueError(
+                f"Invalid style '{inputted_style}'. Allowed styles: {allowed_styles}"
+            )

android_notify/styles.py

@@ -1,6 +1,6 @@
 """Contains Safe way to call Styles"""
 
-class NotificationStyles():
+class NotificationStyles:
     """ Safely Adding Styles"""
     DEFAULT = "simple"
 
@@ -12,5 +12,5 @@ class NotificationStyles():
     BIG_PICTURE = "big_picture"
     BOTH_IMGS = "both_imgs"
 
-    MESSAGING = "messaging" # TODO
-    CUSTOM = "custom" # TODO
+    # MESSAGING = "messaging" # TODO
+    # CUSTOM = "custom" # TODO

android_notify/sword.py

@@ -5,7 +5,7 @@ import os
 import threading
 import re
 from .styles import NotificationStyles
-from .facade import BaseNotification
+from .base import BaseNotification
 DEV=0
 ON_ANDROID = False
 
@@ -31,7 +31,7 @@ try:
     ON_ANDROID = True
 except Exception as e:# pylint: disable=W0718
     MESSAGE='This Package Only Runs on Android !!! ---> Check "https://github.com/Fector101/android_notify/" to see design patterns and more info.' # pylint: disable=C0301
-    print(MESSAGE)
+    # print(MESSAGE) Already Printing in core.py
 
     # This is so no crashes when developing on PC
     def run_on_ui_thread(func):
@@ -55,8 +55,7 @@ if ON_ANDROID:
         NotificationCompatBigPictureStyle = autoclass('androidx.core.app.NotificationCompat$BigPictureStyle') # pylint: disable=C0301
         NotificationCompatInboxStyle = autoclass('androidx.core.app.NotificationCompat$InboxStyle')
     except Exception as e:# pylint: disable=W0718
-        print(e)# if DEV else '','Import Fector101')
-        # print(e if DEV else '')
+        print(e)
         print("""
         Dependency Error: Add the following in buildozer.spec:
         * android.gradle_dependencies = androidx.core:core-ktx:1.15.0, androidx.core:core:1.6.0
@@ -91,46 +90,28 @@ class Notification(BaseNotification):
     button_ids=[0]
     btns_box={}
     main_functions={}
-    style_values=[
-                  '','simple',
-                  'progress','big_text',
-                  'inbox', 'big_picture',
-                  'large_icon','both_imgs',
-                  'custom'
-                ] # TODO make pattern for non-android Notifications
-    defaults={
-        'title':'Default Title',
-        'message':'Default Message',
-        'style':'simple',
-        'big_picture_path':'',
-        'large_icon_path':'',
-        'progress_max_value': 0.5,
-        'progress_current_value': 0.5,
-        'body':'',
-        'channel_name':'Default Channel',
-        'channel_id':'default_channel',
-        'logs':True,
-        "identifer": '',
-        'callback': None,
-        'app_icon': 'Defaults to package app icon'
-    }
 
     # During Development (When running on PC)
-    logs=not ON_ANDROID
+    BaseNotification.logs=not ON_ANDROID
     def __init__(self,**kwargs): #pylint: disable=W0231 #@dataclass already does work
-        self.__validateArgs(kwargs)
-        # Private (Don't Touch)
+        super().__init__(**kwargs)
+
         self.__id = self.__getUniqueID()
-        self.__setArgs(kwargs)
         self.__update_timer = None  # To Track progressbar last update (According to Android Docs Don't update bar to often, I also faced so issues when doing that)
-
+        self.__formatChannel(kwargs)
         if not ON_ANDROID:
             return
         # TODO make send method wait for __asks_permission_if_needed method
         self.__asks_permission_if_needed()
         self.notification_manager = context.getSystemService(context.NOTIFICATION_SERVICE)
         self.__builder=NotificationCompatBuilder(context, self.channel_id)# pylint: disable=E0606
-
+    def showInfiniteProgressBar(self):
+        """Displays an (Infinite) progress Bar in Notification, that continues loading indefinitely.
+        Can be Removed By `removeProgressBar` Method
+        """
+        self.__builder.setProgress(0,0, True)
+        self.__dispatchNotification()
+        
     def updateTitle(self,new_title):
         """Changes Old Title
 
@@ -142,7 +123,7 @@ class Notification(BaseNotification):
             print(f'new notification title: {self.title}')
         if ON_ANDROID:
             self.__builder.setContentTitle(String(self.title))
-            self.notification_manager.notify(self.__id, self.__builder.build())
+            self.__dispatchNotification()
 
     def updateMessage(self,new_message):
         """Changes Old Message
@@ -155,7 +136,7 @@ class Notification(BaseNotification):
             print(f'new notification message: {self.message}')
         if ON_ANDROID:
             self.__builder.setContentText(String(self.message))
-            self.notification_manager.notify(self.__id, self.__builder.build())
+            self.__dispatchNotification()
 
     def updateProgressBar(self,current_value:int,message:str='',title:str=''):
         """Updates progress bar current value
@@ -189,14 +170,14 @@ class Notification(BaseNotification):
                 self.updateMessage(message)
             if title:
                 self.updateTitle(title)
-            self.notification_manager.notify(self.__id, self.__builder.build())
+            self.__dispatchNotification()
             self.__update_timer = None
 
 
         # Start a new timer that runs after 0.5 seconds
         self.__update_timer = threading.Timer(0.5, delayed_update)
         self.__update_timer.start()
-        
+
     def removeProgressBar(self,message='',show_on_update=True, title:str='') -> None:
         """Removes Progress Bar from Notification
 
@@ -223,7 +204,7 @@ class Notification(BaseNotification):
         if title:
             self.updateTitle(title)
         self.__builder.setProgress(0, 0, False)
-        self.notification_manager.notify(self.__id, self.__builder.build())
+        self.__dispatchNotification()
         return True
 
     def send(self,silent:bool=False,persistent=False,close_on_click=True):
@@ -237,13 +218,18 @@ class Notification(BaseNotification):
         self.silent=self.silent or silent
         if ON_ANDROID:
             self.__startNotificationBuild(persistent,close_on_click)
-            self.notification_manager.notify(self.__id, self.__builder.build())
-        elif self.logs:
+            self.__dispatchNotification()
+        if self.logs:
             string_to_display=''
             print("\n Sent Notification!!!")
             for name,value in vars(self).items():
                 if value and name in ["title", "message", "style", "body", "large_icon_path", "big_picture_path", "progress_current_value", "progress_max_value", "channel_name"]:
-                    string_to_display += f'\n {name}: {value}'
+                    if name == "progress_max_value":
+                        if self.style == NotificationStyles.PROGRESS:
+                            string_to_display += f'\n {name}: {value}'
+                    else:
+                        string_to_display += f'\n {name}: {value}'
+
             string_to_display +="\n (Won't Print Logs When Complied,except if selected `Notification.logs=True`)"
             print(string_to_display)
             if DEV:
@@ -304,7 +290,7 @@ class Notification(BaseNotification):
         """
         if ON_ANDROID:
             self.__builder.mActions.clear()
-            self.notification_manager.notify(self.__id, self.__builder.build())
+            self.__dispatchNotification()
         if self.logs:
             print('Removed Notication Buttons')
 
@@ -343,60 +329,17 @@ class Notification(BaseNotification):
                 self.__buildImg(self.large_icon_path, NotificationStyles.LARGE_ICON)
 
         elif style == NotificationStyles.PROGRESS:
-            self.__builder.setContentTitle(String(self.title))
-            self.__builder.setContentText(String(self.message))
             self.__builder.setProgress(self.progress_max_value, self.progress_current_value, False)
 
         if already_sent:
-            self.notification_manager.notify(self.__id, self.__builder.build())
+            self.__dispatchNotification()
 
         return True
         # elif style == 'custom':
         #     self.__builder = self.__doCustomStyle()
 
-    def __validateArgs(self,inputted_kwargs):
-
-        def checkInReference(inputted_keywords,accepteable_inputs,input_type):
-            def singularForm(plural_form):
-                return plural_form[:-1]
-            invalid_args= set(inputted_keywords) - set(accepteable_inputs)
-            if invalid_args:
-                suggestions=[]
-                for arg in invalid_args:
-                    closest_match = difflib.get_close_matches(arg,accepteable_inputs,n=2,cutoff=0.6)
-                    if closest_match:
-                        suggestions.append(f"* '{arg}' Invalid -> Did you mean '{closest_match[0]}'? ") # pylint: disable=C0301
-                    else:
-                        suggestions.append(f"* {arg} is not a valid {singularForm(input_type)}.")
-                suggestion_text='\n'.join(suggestions)
-                hint_msg=singularForm(input_type) if len(invalid_args) < 2 else input_type
-
-                raise ValueError(f"Invalid {hint_msg} provided: \n\t{suggestion_text}\n\t* list of valid {input_type}: [{', '.join(accepteable_inputs)}]")
-
-        allowed_keywords=self.defaults.keys()
-        inputted_keywords_=inputted_kwargs.keys()
-        checkInReference(inputted_keywords_,allowed_keywords,'arguments')
-
-        # Validate style values
-        if 'style' in inputted_keywords_ and inputted_kwargs['style'] not in self.style_values:
-            checkInReference([inputted_kwargs['style']],self.style_values,'values')
-
-    def __setArgs(self,options_dict:dict):
-        non_string_keys=['progress_max_value','progress_current_value','callback','logs']
-
-        for key,value in options_dict.items():
-            if key not in non_string_keys: # Fixing Types
-                value = str(value)
-            if key == 'channel_name' and value.strip():
-                setattr(self,key, value[:40])
-            elif key == 'channel_id' and value.strip(): # If user input's a channel id (i format properly)
-                setattr(self,key, self.__generate_channel_id(value))
-            else:
-                setattr(self,key, value if value or isinstance(value, bool) else self.defaults[key])
-
-        if "channel_id" not in options_dict and 'channel_name' in options_dict: # if User doesn't input channel id but inputs channel_name
-            setattr(self,'channel_id', self.__generate_channel_id(options_dict['channel_name']))
-
+    def __dispatchNotification(self):
+        self.notification_manager.notify(self.__id, self.__builder.build())
     def __startNotificationBuild(self,persistent,close_on_click):
         self.__createBasicNotification(persistent,close_on_click)
         if self.style not in ['simple','']:
@@ -427,7 +370,7 @@ class Notification(BaseNotification):
         self.__builder.setOngoing(persistent)
         self.__builder.setAutoCancel(close_on_click)
         self.__addIntentToOpenApp()
-    
+
     # def __doCustomStyle(self):
     #     # TODO Will implement when needed
     #     return self.__builder
@@ -436,7 +379,7 @@ class Notification(BaseNotification):
             self.__setIconFromBitmap(self.app_icon)
         else:
             self.__builder.setSmallIcon(context.getApplicationInfo().icon)
-        
+
     def __buildImg(self, user_img,img_style):
         if user_img.startswith('http://') or user_img.startswith('https://'):
             def callback(bitmap):
@@ -450,7 +393,7 @@ class Notification(BaseNotification):
             bitmap = self.__getImgFromPath(user_img)
             if bitmap:
                 self.__applyNotificationImage(bitmap,img_style)
-    
+
     def __setIconFromBitmap(self,img_path):
         """Path can be link or relative path"""
         if img_path.startswith('http://') or img_path.startswith('https://'):
@@ -470,8 +413,7 @@ class Notification(BaseNotification):
                 if self.logs:
                     print('Failed getting img for custom notification icon defaulting to app icon')
                 self.__builder.setSmallIcon(context.getApplicationInfo().icon)
-                
-        
+
     def __getImgFromPath(self, relative_path):
         app_folder=os.path.join(app_storage_path(),'app') # pylint: disable=possibly-used-before-assignment
         output_path = os.path.join(app_folder, relative_path)
@@ -511,25 +453,6 @@ class Notification(BaseNotification):
             print('Error Type ',e)
             print('Failed to get Bitmap from URL ',traceback.format_exc())
 
-    # def __getImgFromURL(self,url,img_style):
-    #     if self.logs:
-    #         print("getting image from URL---")
-    #     try:
-    #         URL = autoclass('java.net.URL')
-    #         url = URL(url)
-    #         connection = url.openConnection()
-    #         connection.connect()
-    #         input_stream = connection.getInputStream()
-    #         bitmap = BitmapFactory.decodeStream(input_stream)
-    #         input_stream.close()
-    #         if bitmap:
-    #             self.__applyNotificationImage(bitmap,img_style)
-                
-    #     except Exception as e:
-    #         # TODO get type of JAVA Error
-    #         print('Error Type ',e)
-    #         print('Failed to get Img from URL ',traceback.format_exc())
-
     @run_on_ui_thread
     def __applyNotificationImage(self,bitmap,img_style):
         if self.logs:
@@ -540,7 +463,7 @@ class Notification(BaseNotification):
                 self.__builder.setStyle(big_picture_style)
             elif img_style == NotificationStyles.LARGE_ICON:
                 self.__builder.setLargeIcon(bitmap)
-            self.notification_manager.notify(self.__id, self.__builder.build())
+            self.__dispatchNotification()
             if self.logs:
                 print('Done adding image to notification-------')
         except Exception as e:
@@ -565,24 +488,6 @@ class Notification(BaseNotification):
         if not all(check_permission(p) for p in permissions):
             request_permissions(permissions,on_permissions_result) # pylint: disable=E0606
 
-    def __generate_channel_id(self,channel_name: str) -> str:
-        """
-        Generate a readable and consistent channel ID from a channel name.
-        
-        Args:
-            channel_name (str): The name of the notification channel.
-        
-        Returns:
-            str: A sanitized channel ID.
-        """
-        # Normalize the channel name
-        channel_id = channel_name.strip().lower()
-        # Replace spaces and special characters with underscores
-        channel_id = re.sub(r'[^a-z0-9]+', '_', channel_id)
-        # Remove leading/trailing underscores
-        channel_id = channel_id.strip('_')
-        return channel_id[:50]
-
     def __addIntentToOpenApp(self):
         intent = Intent(context, PythonActivity)
         action = str(self.identifer) or f"ACTION_{self.__id}"
@@ -609,6 +514,36 @@ class Notification(BaseNotification):
         self.button_ids.append(btn_id)
         return btn_id
 
+    def __formatChannel(self, inputted_kwargs):
+        if 'channel_name' in inputted_kwargs:
+            cleaned_name = inputted_kwargs['channel_name'].strip()
+            self.channel_name = cleaned_name[:40] if cleaned_name else 'Default Channel'
+
+        if 'channel_id' in inputted_kwargs:
+            cleaned_id = inputted_kwargs['channel_id'].strip()
+            self.channel_id = self.__generate_channel_id(cleaned_id) if cleaned_id else 'default_channel'
+        elif 'channel_name' in inputted_kwargs:  
+            # Generate channel_id from channel_name if only channel_name is provided
+            generated_id = self.__generate_channel_id(inputted_kwargs['channel_name'])
+            self.channel_id = generated_id
+
+    def __generate_channel_id(self,channel_name: str) -> str:
+        """
+        Generate a readable and consistent channel ID from a channel name.
+        
+        Args:
+            channel_name (str): The name of the notification channel.
+        
+        Returns:
+            str: A sanitized channel ID.
+        """
+        # Normalize the channel name
+        channel_id = channel_name.strip().lower()
+        # Replace spaces and special characters with underscores
+        channel_id = re.sub(r'[^a-z0-9]+', '_', channel_id)
+        # Remove leading/trailing underscores
+        channel_id = channel_id.strip('_')
+        return channel_id[:50]
 
 class NotificationHandler:
     """For Notification Operations """

{android_notify-1.55.dist-info → android_notify-1.56.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: android-notify
-Version: 1.55
+Version: 1.56
 Summary: A Python package that simpilfies creating Android notifications in Kivy apps.
 Home-page: https://github.com/fector101/android-notify
 Author: Fabian
@@ -464,6 +464,10 @@ args
 
 - new_message : String to be set as New notification Message
 
+### Instance.showInfiniteProgressBar
+
+Displays an Infinite Progress Bar in Notification, Can be Removed using `removeProgressBar` and updated using `updateProgressBar` method
+
 ### Instance.updateProgressBar
 
 if updating title,msg with progressbar frequenlty pass them in too to avoid update issues.

android_notify-1.56.dist-info/RECORD

@@ -0,0 +1,10 @@
+android_notify/__init__.py,sha256=lcLjyfegXgU7cyGhfSphAOBipXwemrVkdYy3mcF6X5Y,172
+android_notify/__main__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+android_notify/base.py,sha256=QkNSNFX8KtNnRRm0r1wXsQa6TWMRKySn-3PT-XpY1mM,3377
+android_notify/core.py,sha256=Per4HFwYwP-mxHJqnwcLlWXsbZsSeeAYN49MmFU2qVk,6113
+android_notify/styles.py,sha256=QBkCY8ZO26FnS-jPtRLf9CKEEnnYylmH9enCa5CNDes,354
+android_notify/sword.py,sha256=OzSaIlxegxStd5fy_RuFyOBCTBSJff2VOHpD5qqASfo,27851
+android_notify-1.56.dist-info/METADATA,sha256=2UdPjO20-SVKnQ5Xh1I-cx0iwNRHrVT24UHd2lyKBXs,16568
+android_notify-1.56.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
+android_notify-1.56.dist-info/top_level.txt,sha256=IR1ONMrRSRINZpWn2X0dL5gbWwWINsK7PW8Jy2p4fU8,15
+android_notify-1.56.dist-info/RECORD,,

android_notify/facade.py

@@ -1,28 +0,0 @@
-"""Assists Notification Class with Args auto-complete: keeps sub class cleaner"""
-from dataclasses import dataclass
-
-@dataclass
-class BaseNotification:
-    """Encapsulator"""
-    
-    # Basic options
-    title: str = ''
-    message: str = ''
-    style: str = 'simple'
-    
-    # Style specfic attributes
-    big_picture_path: str = ''
-    large_icon_path: str = ''
-    progress_max_value: int = 100
-    progress_current_value: int = 0
-    body: str = ''
-    
-    # For Nofitication Functions
-    identifer: str = ''
-    callback: object = None
-    
-    # Advance Options
-    channel_name: str = 'Default Channel'
-    channel_id: str = 'default_channel'
-    silent: bool = False
-    app_icon: str = 'Defaults to package app icon'

android_notify-1.55.dist-info/RECORD

@@ -1,10 +0,0 @@
-android_notify/__init__.py,sha256=lcLjyfegXgU7cyGhfSphAOBipXwemrVkdYy3mcF6X5Y,172
-android_notify/__main__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-android_notify/core.py,sha256=Per4HFwYwP-mxHJqnwcLlWXsbZsSeeAYN49MmFU2qVk,6113
-android_notify/facade.py,sha256=A19qXM703aUeZux87SsM2BpDpXOpiC-kVdRS7yZy-5k,729
-android_notify/styles.py,sha256=3olKruhAbTrk5OzuhDnk_Pgpv8XYk8dWFmr48Q9rQVk,352
-android_notify/sword.py,sha256=BwjmVEXpFpFyknlrpOHY38qKm-t3UEnUHUPXLHrii_A,30886
-android_notify-1.55.dist-info/METADATA,sha256=ebm_bvvLThI-l4EASaOfsaLRtGNgtGCcwOtWdeMwV2I,16392
-android_notify-1.55.dist-info/WHEEL,sha256=jB7zZ3N9hIM9adW7qlTAyycLYW9npaWKLRzaoVcLKcM,91
-android_notify-1.55.dist-info/top_level.txt,sha256=IR1ONMrRSRINZpWn2X0dL5gbWwWINsK7PW8Jy2p4fU8,15
-android_notify-1.55.dist-info/RECORD,,