Merge pull request #2595 from gwen-sarapata/remove-extra-andriod-depe…

…ndency Remove extra android dependency
beeware · May 22, 2024 · 2bf76fe · 2bf76fe
2 parents 234544e + 745fe3a
commit 2bf76fe
Show file tree

Hide file tree

Showing 47 changed files with 27 additions and 50 deletions.
diff --git a/android/src/toga_android/widgets/detailedlist.py b/android/src/toga_android/widgets/detailedlist.py
@@ -6,9 +6,16 @@
 from android.graphics import Rect
 from android.view import Gravity, View
 from android.widget import ImageView, LinearLayout, RelativeLayout, ScrollView, TextView
-from androidx.swiperefreshlayout.widget import SwipeRefreshLayout
 from java import dynamic_proxy
 
+try:
+    from androidx.swiperefreshlayout.widget import SwipeRefreshLayout
+except ImportError:  # pragma: no cover
+    # Import will fail if SwipeRefreshLayout is not listed in dependencies
+    # No cover due to not being able to test in CI
+    SwipeRefreshLayout = None
+
+
 from .base import Widget
 
 
@@ -78,17 +85,25 @@ def onClick(self, dialog, which):
         self.actions[which].handler(row=self.row)
 
 
-class OnRefreshListener(dynamic_proxy(SwipeRefreshLayout.OnRefreshListener)):
-    def __init__(self, interface):
-        super().__init__()
-        self._interface = interface
+if SwipeRefreshLayout is not None:  # pragma: no cover
+
+    class OnRefreshListener(dynamic_proxy(SwipeRefreshLayout.OnRefreshListener)):
+        def __init__(self, interface):
+            super().__init__()
+            self._interface = interface
 
-    def onRefresh(self):
-        self._interface.on_refresh()
+        def onRefresh(self):
+            self._interface.on_refresh()
 
 
 class DetailedList(Widget):
     def create(self):
+        if SwipeRefreshLayout is None:  # pragma: no cover
+            raise RuntimeError(
+                "Unable to import SwipeRefreshLayout. Ensure that the AndroidX Swipe Refresh Layout "
+                "widget package (androidx.swiperefreshlayout:swiperefreshlayout:1.1.0) "
+                "is listed in your app's dependencies."
+            )
         # get the selection color from the current theme
         attrs = [R.attr.colorBackground, R.attr.colorControlHighlight]
         typed_array = self._native_activity.obtainStyledAttributes(attrs)

diff --git a/changes/2454.feature.rst b/changes/2454.feature.rst
@@ -0,0 +1 @@
+Android deployments no longer require the SwipeRefreshLayout component unless the app uses the Toga DetailedList widget.
diff --git a/docs/reference/api/widgets/detailedlist.rst b/docs/reference/api/widgets/detailedlist.rst
@@ -139,6 +139,9 @@ Notes
 * The WinForms implementation currently uses a column layout similar to :any:`Table`,
   and does not support the primary, secondary or refresh actions.
 
+* Using DetailedList on Android requires the AndroidX SwipeRefreshLayout widget in your project's Gradle dependencies. Ensure your app declares a dependency on ``androidx.swiperefreshlayout:swiperefreshlayout:1.1.0`` or later.
+
+
 Reference
 ---------
 

diff --git a/docs/spelling_wordlist b/docs/spelling_wordlist
@@ -101,3 +101,4 @@ whitespace
 Winforms
 Xcode
 zoomable
+AndroidX
diff --git a/examples/activityindicator/pyproject.toml b/examples/activityindicator/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/box/pyproject.toml b/examples/box/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/button/pyproject.toml b/examples/button/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/canvas/pyproject.toml b/examples/canvas/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/colors/pyproject.toml b/examples/colors/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/command/pyproject.toml b/examples/command/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/date_and_time/pyproject.toml b/examples/date_and_time/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/dialogs/pyproject.toml b/examples/dialogs/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/divider/pyproject.toml b/examples/divider/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/documentapp/pyproject.toml b/examples/documentapp/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/examples_overview/pyproject.toml b/examples/examples_overview/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/focus/pyproject.toml b/examples/focus/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/font/pyproject.toml b/examples/font/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/font_size/pyproject.toml b/examples/font_size/pyproject.toml
@@ -51,7 +51,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/handlers/pyproject.toml b/examples/handlers/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/hardware/pyproject.toml b/examples/hardware/pyproject.toml
@@ -56,6 +56,5 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
     "org.osmdroid:osmdroid-android:6.1.0",
 ]
diff --git a/examples/layout/pyproject.toml b/examples/layout/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/mapview/pyproject.toml b/examples/mapview/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
     "org.osmdroid:osmdroid-android:6.1.0",
 ]
 

diff --git a/examples/multilinetextinput/pyproject.toml b/examples/multilinetextinput/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/numberinput/pyproject.toml b/examples/numberinput/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/optioncontainer/pyproject.toml b/examples/optioncontainer/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/positron-django/pyproject.toml b/examples/positron-django/pyproject.toml
@@ -54,7 +54,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/positron-static/pyproject.toml b/examples/positron-static/pyproject.toml
@@ -53,7 +53,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/progressbar/pyproject.toml b/examples/progressbar/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/resize/pyproject.toml b/examples/resize/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/screenshot/pyproject.toml b/examples/screenshot/pyproject.toml
@@ -53,6 +53,5 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
     "org.osmdroid:osmdroid-android:6.1.0",
 ]
diff --git a/examples/scrollcontainer/pyproject.toml b/examples/scrollcontainer/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/selection/pyproject.toml b/examples/selection/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/slider/pyproject.toml b/examples/slider/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/splitcontainer/pyproject.toml b/examples/splitcontainer/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/switch_demo/pyproject.toml b/examples/switch_demo/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/table/pyproject.toml b/examples/table/pyproject.toml
@@ -51,7 +51,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/table_source/pyproject.toml b/examples/table_source/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/textinput/pyproject.toml b/examples/textinput/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/tree/pyproject.toml b/examples/tree/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/tree_source/pyproject.toml b/examples/tree_source/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/tutorial0/pyproject.toml b/examples/tutorial0/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/tutorial1/pyproject.toml b/examples/tutorial1/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/tutorial2/pyproject.toml b/examples/tutorial2/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/tutorial3/pyproject.toml b/examples/tutorial3/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment

diff --git a/examples/tutorial4/pyproject.toml b/examples/tutorial4/pyproject.toml
@@ -52,7 +52,6 @@ base_theme = "Theme.MaterialComponents.Light.DarkActionBar"
 build_gradle_dependencies = [
     "androidx.appcompat:appcompat:1.6.1",
     "com.google.android.material:material:1.11.0",
-    "androidx.swiperefreshlayout:swiperefreshlayout:1.1.0",
 ]
 
 # Web deployment
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Android deployments no longer require the SwipeRefreshLayout component unless the app uses the Toga DetailedList widget.