android-notify 1.60.4.dev0__tar.gz → 1.60.5.dev0__tar.gz

{android_notify-1.60.4.dev0 → android_notify-1.60.5.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: android-notify
-Version: 1.60.4.dev0
+Version: 1.60.5.dev0
 Summary: A Python package that simplifies creating Android notifications in Kivy and Flet apps.
 Author-email: Fabian <fector101@yahoo.com>
 License-Expression: MIT
@@ -79,7 +79,7 @@ In your **`buildozer.spec`** file, ensure you include the following:
 
 ```ini
 # Add pyjnius so ensure it's packaged with the build
-requirements = python3, kivy, pyjnius, android-notify==1.60.4.dev0
+requirements = python3, kivy, pyjnius, android-notify==1.60.5.dev0
 # Add permission for notifications
 android.permissions = POST_NOTIFICATIONS
 ```
@@ -91,7 +91,7 @@ In your `pyproject.toml` file, ensure you include the following:
 ```toml
 [tool.flet.android]
 dependencies = [
-  "pyjnius","android-notify==1.60.4.dev0"
+  "pyjnius","android-notify==1.60.5.dev0"
 ]
 
 [tool.flet.android.permission]
@@ -100,7 +100,7 @@ dependencies = [
 
 ### Pydroid 3
 In the [pydroid 3](https://play.google.com/store/apps/details?id=ru.iiec.pydroid3) mobile app for running python code you can test some features.
-- In pip section where you're asked to insert `Libary name` paste `android-notify==1.60.4.dev0`
+- In pip section where you're asked to insert `Libary name` paste `android-notify==1.60.5.dev0`
 
 
 ### Testing

{android_notify-1.60.4.dev0 → android_notify-1.60.5.dev0}/README.md

@@ -56,7 +56,7 @@ In your **`buildozer.spec`** file, ensure you include the following:
 
 ```ini
 # Add pyjnius so ensure it's packaged with the build
-requirements = python3, kivy, pyjnius, android-notify==1.60.4.dev0
+requirements = python3, kivy, pyjnius, android-notify==1.60.5.dev0
 # Add permission for notifications
 android.permissions = POST_NOTIFICATIONS
 ```
@@ -68,7 +68,7 @@ In your `pyproject.toml` file, ensure you include the following:
 ```toml
 [tool.flet.android]
 dependencies = [
-  "pyjnius","android-notify==1.60.4.dev0"
+  "pyjnius","android-notify==1.60.5.dev0"
 ]
 
 [tool.flet.android.permission]
@@ -77,7 +77,7 @@ dependencies = [
 
 ### Pydroid 3
 In the [pydroid 3](https://play.google.com/store/apps/details?id=ru.iiec.pydroid3) mobile app for running python code you can test some features.
-- In pip section where you're asked to insert `Libary name` paste `android-notify==1.60.4.dev0`
+- In pip section where you're asked to insert `Libary name` paste `android-notify==1.60.5.dev0`
 
 
 ### Testing

android_notify-1.60.5.dev0/android_notify/an_types.py

@@ -0,0 +1,341 @@
+"""For autocomplete Storing Reference to Available Methods"""
+from typing import Literal
+
+Importance = Literal['urgent', 'high', 'medium', 'low', 'none']
+"""
+    :argument urgent - Makes a sound and appears as a heads-up notification.
+    
+    :argument high - Makes a sound.
+    
+    :argument urgent - Makes no sound.
+    
+    :argument urgent - Makes no sound and doesn't appear in the status bar.
+    
+    :argument urgent - Makes no sound and doesn't in the status bar or shade.
+"""
+
+
+# For Dev
+# Idea for typing autocompletion and reference
+class Bundle:
+    def putString(self, key, value):
+        print(f"[MOCK] Bundle.putString called with key={key}, value={value}")
+
+    def putInt(self, key, value):
+        print(f"[MOCK] Bundle.putInt called with key={key}, value={value}")
+
+
+class String(str):
+    def __new__(cls, value):
+        print(f"[MOCK] String created with value={value}")
+        return str.__new__(cls, value)
+
+
+class Intent:
+    FLAG_ACTIVITY_NEW_TASK = 'FACADE_FLAG_ACTIVITY_NEW_TASK'
+    CATEGORY_DEFAULT = 'FACADE_FLAG_CATEGORY_DEFAULT'
+
+    def __init__(self, context='', activity=''):
+        self.obj = {}
+        print(f"[MOCK] Intent initialized with context={context}, activity={activity}")
+
+    def setAction(self, action):
+        print(f"[MOCK] Intent.setAction called with: {action}")
+        return self
+
+    def addFlags(self, *flags):
+        print(f"[MOCK] Intent.addFlags called with: {flags}")
+        return self
+
+    def setData(self, uri):
+        print(f"[MOCK] Intent.setData called with: {uri}")
+        return self
+
+    def setFlags(self, intent_flag):
+        print(f"[MOCK] Intent.setFlags called with: {intent_flag}")
+        return self
+
+    def addCategory(self, intent_category):
+        print(f"[MOCK] Intent.addCategory called with: {intent_category}")
+        return self
+
+    def getAction(self):
+        print("[MOCK] Intent.getAction called")
+        return self
+
+    def getStringExtra(self, key):
+        print(f"[MOCK] Intent.getStringExtra called with key={key}")
+        return self
+
+    def putExtra(self, key, value):
+        self.obj[key] = value
+        print(f"[MOCK] Intent.putExtra called with key={key}, value={value}")
+
+    def putExtras(self, bundle: Bundle):
+        self.obj['bundle'] = bundle
+        print(f"[MOCK] Intent.putExtras called with bundle={bundle}")
+
+
+class PendingIntent:
+    FLAG_IMMUTABLE = ''
+    FLAG_UPDATE_CURRENT = ''
+
+    def getActivity(self, context, value, action_intent, pending_intent_type):
+        print(
+            f"[MOCK] PendingIntent.getActivity called with context={context}, value={value}, action_intent={action_intent}, type={pending_intent_type}")
+
+
+class BitmapFactory:
+    def decodeStream(self, stream):
+        print(f"[MOCK] BitmapFactory.decodeStream called with stream={stream}")
+
+
+class BuildVersion:
+    SDK_INT = 0
+
+class Manifest:
+    POST_NOTIFICATIONS = 'FACADE_IMPORT'
+
+class Settings:
+    ACTION_APP_NOTIFICATION_SETTINGS = 'FACADE_IMPORT_ACTION_APP_NOTIFICATION_SETTINGS'
+    EXTRA_APP_PACKAGE = 'FACADE_IMPORT_EXTRA_APP_PACKAGE'
+    ACTION_APPLICATION_DETAILS_SETTINGS = 'FACADE_IMPORT_ACTION_APPLICATION_DETAILS_SETTINGS'
+
+class Uri:
+    def __init__(self,package_name):
+        print("FACADE_URI")
+
+class NotificationManager:
+    pass
+
+class NotificationManagerClass:
+    pass
+
+
+class NotificationChannel:
+    def __init__(self, channel_id, channel_name, importance):
+        self.description = None
+        self.channel_id = channel_id
+        self.channel = None
+        print(
+            f"[MOCK] NotificationChannel initialized with id={channel_id}, name={channel_name}, importance={importance}")
+
+    def createNotificationChannel(self, channel):
+        self.channel = channel
+        print(f"[MOCK] NotificationChannel.createNotificationChannel called with channel={channel}")
+
+    def getNotificationChannel(self, channel_id):
+        self.channel_id = channel_id
+        print(f"[MOCK] NotificationChannel.getNotificationChannel called with id={channel_id}")
+
+    def setDescription(self, description):
+        self.description = description
+        print(f"[MOCK] NotificationChannel.setDescription called with description={description}")
+
+    def getId(self):
+        print(f"[MOCK] NotificationChannel.getId called, returning {self.channel_id}")
+        return self.channel_id
+
+
+class IconCompat:
+    def createWithBitmap(self, bitmap):
+        print(f"[MOCK] IconCompat.createWithBitmap called with bitmap={bitmap}")
+
+
+class Color:
+    def __init__(self):
+        print("[MOCK] Color initialized")
+
+    def parseColor(self, color: str):
+        print(f"[MOCK] Color.parseColor called with color={color}")
+        return self
+
+
+class RemoteViews:
+    def __init__(self, package_name, small_layout_id):
+        print(f"[MOCK] RemoteViews initialized with package_name={package_name}, layout_id={small_layout_id}")
+
+    def createWithBitmap(self, bitmap):
+        print(f"[MOCK] RemoteViews.createWithBitmap called with bitmap={bitmap}")
+
+    def setTextViewText(self, id, text):
+        print(f"[MOCK] RemoteViews.setTextViewText called with id={id}, text={text}")
+
+    def setTextColor(self, id, color: Color):
+        print(f"[MOCK] RemoteViews.setTextColor called with id={id}, color={color}")
+
+
+class NotificationManagerCompat:
+    IMPORTANCE_HIGH = 4
+    IMPORTANCE_DEFAULT = 3
+    IMPORTANCE_LOW = ''
+    IMPORTANCE_MIN = ''
+    IMPORTANCE_NONE = ''
+
+class AndroidNotification:
+    DEFAULT_ALL = 3
+    PRIORITY_HIGH = 4
+    PRIORITY_DEFAULT = ''
+    PRIORITY_LOW = ''
+    PRIORITY_MIN = ''
+
+class NotificationCompat:
+    DEFAULT_ALL = 3
+    PRIORITY_HIGH = 4
+    PRIORITY_DEFAULT = ''
+    PRIORITY_LOW = ''
+    PRIORITY_MIN = ''
+
+
+class MActions:
+    def clear(self):
+        """This Removes all buttons"""
+        print('[MOCK] MActions.clear called')
+
+
+class NotificationCompatBuilder:
+    def __init__(self, context, channel_id):
+        self.mActions = MActions()
+        print(f"[MOCK] NotificationCompatBuilder initialized with context={context}, channel_id={channel_id}")
+
+    def setProgress(self, max_value, current_value, endless):
+        print(f"[MOCK] setProgress called with max={max_value}, current={current_value}, endless={endless}")
+
+    def setStyle(self, style):
+        print(f"[MOCK] setStyle called with style={style}")
+
+    def setContentTitle(self, title):
+        print(f"[MOCK] setContentTitle called with title={title}")
+
+    def setContentText(self, text):
+        print(f"[MOCK] setContentText called with text={text}")
+
+    def setSmallIcon(self, icon):
+        print(f"[MOCK] setSmallIcon called with icon={icon}")
+
+    def setLargeIcon(self, icon):
+        print(f"[MOCK] setLargeIcon called with icon={icon}")
+
+    def setAutoCancel(self, auto_cancel: bool):
+        print(f"[MOCK] setAutoCancel called with auto_cancel={auto_cancel}")
+
+    def setPriority(self, priority: Importance):
+        print(f"[MOCK] setPriority called with priority={priority}")
+
+    def setDefaults(self, defaults):
+        print(f"[MOCK] setDefaults called with defaults={defaults}")
+
+    def setOngoing(self, persistent: bool):
+        print(f"[MOCK] setOngoing called with persistent={persistent}")
+
+    def setOnlyAlertOnce(self, state):
+        print(f"[MOCK] setOnlyAlertOnce called with state={state}")
+
+    def build(self):
+        print("[MOCK] build called")
+
+    def setContentIntent(self, pending_action_intent: PendingIntent):
+        print(f"[MOCK] setContentIntent called with {pending_action_intent}")
+
+    def addAction(self, icon_int, action_text, pending_action_intent):
+        print(f"[MOCK] addAction called with icon={icon_int}, text={action_text}, intent={pending_action_intent}")
+
+    def setShowWhen(self, state):
+        print(f"[MOCK] setShowWhen called with state={state}")
+
+    def setWhen(self, time_ms):
+        print(f"[MOCK] setWhen called with time_ms={time_ms}")
+
+    def setCustomContentView(self, layout):
+        print(f"[MOCK] setCustomContentView called with layout={layout}")
+
+    def setCustomBigContentView(self, layout):
+        print(f"[MOCK] setCustomBigContentView called with layout={layout}")
+
+    def setSubText(self, text):
+        print(f"[MOCK] setSubText called with text={text}")
+
+    def setColor(self, color: Color) -> None:
+        print(f"[MOCK] setColor called with color={color}")
+
+
+class NotificationCompatBigTextStyle:
+    def bigText(self, body):
+        print(f"[MOCK] NotificationCompatBigTextStyle.bigText called with body={body}")
+        return self
+
+
+class NotificationCompatBigPictureStyle:
+    def bigPicture(self, bitmap):
+        print(f"[MOCK] NotificationCompatBigPictureStyle.bigPicture called with bitmap={bitmap}")
+        return self
+
+
+class NotificationCompatInboxStyle:
+    def addLine(self, line):
+        print(f"[MOCK] NotificationCompatInboxStyle.addLine called with line={line}")
+        return self
+
+
+class NotificationCompatDecoratedCustomViewStyle:
+    def __init__(self):
+        print("[MOCK] NotificationCompatDecoratedCustomViewStyle initialized")
+
+
+class Permission:
+    POST_NOTIFICATIONS = ''
+
+
+def check_permission(permission: Permission.POST_NOTIFICATIONS):
+    print(f"[MOCK] check_permission called with {permission}")
+    print(permission)
+
+
+def request_permissions(_list: [], _callback):
+    print(f"[MOCK] request_permissions called with {_list}")
+    _callback()
+
+
+class AndroidActivity:
+    def bind(self, on_new_intent):
+        print(f"[MOCK] AndroidActivity.bind called with {on_new_intent}")
+
+    def unbind(self, on_new_intent):
+        print(f"[MOCK] AndroidActivity.unbind called with {on_new_intent}")
+
+
+class PythonActivity:
+    mActivity = "[MOCK] mActivity used"
+    def __init__(self):
+        print("[MOCK] PythonActivity initialized")
+
+
+class DummyIcon:
+    icon = 101
+
+    def __init__(self):
+        print("[MOCK] DummyIcon initialized")
+
+
+class Context:
+    def __init__(self):
+        print("[MOCK] Context initialized")
+        pass
+
+    @staticmethod
+    def getApplicationInfo():
+        print("[MOCK] Context.getApplicationInfo called")
+        return DummyIcon
+
+    @staticmethod
+    def getResources():
+        print("[MOCK] Context.getResources called")
+        return None
+
+    @staticmethod
+    def getPackageName():
+        print("[MOCK] Context.getPackageName called")
+        return None  # TODO get package name from buildozer.spec file
+
+# Now writing Knowledge from errors
+# notify.(int, Builder.build()) # must be int

{android_notify-1.60.4.dev0 → android_notify-1.60.5.dev0}/android_notify/an_utils.py

@@ -4,16 +4,18 @@ import inspect, os, re, traceback
 from .config import autoclass
 from .an_types import Importance
 from .config import (
-                     get_python_activity_context, app_storage_path,ON_ANDROID,
-                     BitmapFactory, BuildVersion, Bundle,
-                     NotificationManagerClass,AndroidNotification
-                    )
+    get_python_activity_context, app_storage_path, ON_ANDROID,
+    BitmapFactory, BuildVersion, Bundle,
+    NotificationManagerClass, AndroidNotification, Intent, Settings, Uri, String, Manifest
+
+)
 
 if ON_ANDROID:
     Color = autoclass('android.graphics.Color')
 else:
     from .an_types import Color
 
+
 def can_accept_arguments(func, *args, **kwargs):
     try:
         sig = inspect.signature(func)
@@ -22,11 +24,13 @@ def can_accept_arguments(func, *args, **kwargs):
     except TypeError:
         return False
 
+
 if ON_ANDROID:
     context = get_python_activity_context()
 else:
     context = None
 
+
 def get_android_importance(importance: Importance):
     """
     Returns Android Importance Values
@@ -50,6 +54,7 @@ def get_android_importance(importance: Importance):
     return value
     # side-note 'medium' = NotificationCompat.PRIORITY_LOW and 'low' = NotificationCompat.PRIORITY_MIN # weird but from docs
 
+
 def generate_channel_id(channel_name: str) -> str:
     """
     Generate a readable and consistent channel ID from a channel name.
@@ -68,15 +73,15 @@ def generate_channel_id(channel_name: str) -> str:
     channel_id = channel_id.strip('_')
     return channel_id[:50]
 
+
 def get_img_from_path(relative_path):
-    app_folder = os.path.join(app_storage_path(), 'app')  
+    app_folder = os.path.join(app_storage_path(), 'app')
     img_full_path = os.path.join(app_folder, relative_path)
-    img_name = os.path.basename(img_full_path)
     if not os.path.exists(img_full_path):
-        print(f"\nImage - {img_name} not found at path: {app_folder}, (Local images gotten from App Path)")
+        print(f'\nImage: "{img_full_path}" Not Found, (Local images gotten from App Path)')
         try:
             print("- These are the existing files in your app Folder:")
-            print('[' + ', '.join(os.listdir(app_folder)) + ']')
+            print('[' + ', '.join(os.listdir(app_folder)) + ']\n')
         except Exception as could_not_get_files_in_path_error:
             print('Exception: ', could_not_get_files_in_path_error)
             print("Couldn't get Files in App Folder")
@@ -84,6 +89,7 @@ def get_img_from_path(relative_path):
     return get_bitmap_from_path(img_full_path)
     # TODO test with a badly written Image and catch error
 
+
 def setLayoutText(layout, id, text, color):
     # checked if self.title_color available before entering method
     if id and text:
@@ -91,6 +97,7 @@ def setLayoutText(layout, id, text, color):
         if color:
             layout.setTextColor(id, Color.parseColor(color))
 
+
 def get_bitmap_from_url(url, callback, logs):
     """Gets Bitmap from url
 
@@ -119,6 +126,7 @@ def get_bitmap_from_url(url, callback, logs):
         print('Error Type ', extracting_bitmap_frm_URL_error)
         print('Failed to get Bitmap from URL ', traceback.format_exc())
 
+
 def add_data_to_intent(intent, title):
     """Persist Some data to notification object for later use"""
     bundle = Bundle()
@@ -127,13 +135,14 @@ def add_data_to_intent(intent, title):
     bundle.putInt("notify_id", 101)
     intent.putExtras(bundle)
 
+
 def get_sound_uri(res_sound_name):
-  if not res_sound_name:
-    return None
+    if not res_sound_name:  # Incase it's None
+        return None
+
+    package_name = context.getPackageName()
+    return Uri.parse(f"android.resource://{package_name}/raw/{res_sound_name}")
 
-  package_name = context.getPackageName()
-  Uri = autoclass('android.net.Uri')
-  return Uri.parse(f"android.resource://{package_name}/raw/{res_sound_name}")
 
 def get_package_path():
     """
@@ -142,10 +151,11 @@ def get_package_path():
     """
     return os.path.dirname(os.path.abspath(__file__))
 
+
 def get_bitmap_from_path(img_full_path):
-  Uri = autoclass('android.net.Uri')
-  uri = Uri.parse(f"file://{img_full_path}")
-  return BitmapFactory.decodeStream(context.getContentResolver().openInputStream(uri))
+    uri = Uri.parse(f"file://{img_full_path}")
+    return BitmapFactory.decodeStream(context.getContentResolver().openInputStream(uri))
+
 
 def icon_finder(icon_name):
     """Get the full path to an icon file."""
@@ -156,3 +166,44 @@ def icon_finder(icon_name):
         # Fallback if pkg_resources not available
         package_dir = get_package_path()
         return os.path.join(package_dir, "fallback-icons", icon_name)
+
+
+def can_show_permission_request_popup():
+    """
+    Check if we can show permission request popup for POST_NOTIFICATIONS
+    :return: bool
+    """
+    if not ON_ANDROID:
+        return False
+
+    if BuildVersion.SDK_INT < 33:
+        return False
+
+    return context.shouldShowRequestPermissionRationale(Manifest.POST_NOTIFICATIONS)
+
+
+def open_settings_screen():
+    if not context:
+        print("android_notify - Can't open settings screen, No context [not On Android]")
+        return None
+    intent = Intent()
+    intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
+    package_name = String(context.getPackageName())  # String() is very important else fails silently with a toast
+    # saying "The app wasn't found in the list of installed apps" - Xiaomi or "unable to find application to perform this action" - Samsung and Techno
+
+    if BuildVersion.SDK_INT >= 26:  # Android 8.0 - android.os.Build.VERSION_CODES.O
+        intent.setAction(Settings.ACTION_APP_NOTIFICATION_SETTINGS)
+        intent.putExtra(Settings.EXTRA_APP_PACKAGE, package_name)
+    elif BuildVersion.SDK_INT >= 22:  # Android 5.0 - Build.VERSION_CODES.LOLLIPOP
+        intent.setAction("android.settings.APP_NOTIFICATION_SETTINGS")
+        intent.putExtra("app_package", package_name)
+        intent.putExtra("app_uid", context.getApplicationInfo().uid)
+    else:  # Last Retort is to open App Settings Screen
+        intent.setAction(Settings.ACTION_APPLICATION_DETAILS_SETTINGS)
+        intent.addCategory(Intent.CATEGORY_DEFAULT)
+        intent.setData(Uri.parse("package:" + package_name))
+
+    context.startActivity(intent)
+    return None
+
+    # https://stackoverflow.com/a/45192258/19961621