Respect local environment configuration for app file storage

changes/2867.bugfix.md

@@ -0,0 +1 @@
+Desktop backends now respect user and system environment configuration (`XDG_CONFIG_HOME`, `XDG_DATA_HOME`, `XDG_CACHE_HOME`, and `XDG_STATE_HOME` on Linux; `%LOCALAPPDATA%` on Windows) for application storage paths.

core/tests/test_paths.py

@@ -136,6 +136,5 @@ def test_subclassed_as_deep_module():
 )
 def test_cant_reassign(app, path_name):
     """App path attributes are read-only."""
-    # Theoretically, this could leak out of this test... but only if it fails!
     with pytest.raises(AttributeError):
         setattr(app.paths, path_name, "")

gtk/src/toga_gtk/paths.py

@@ -1,3 +1,4 @@
+import os
 from pathlib import Path
 
 from toga import App
@@ -8,13 +9,26 @@ def __init__(self, interface):
         self.interface = interface
 
     def get_config_path(self):
-        return Path.home() / f".config/{App.app.app_name}"
+        return (
+            Path(os.environ.get("XDG_CONFIG_HOME") or (Path.home() / ".config"))
+            / App.app.app_name
+        )
 
     def get_data_path(self):
-        return Path.home() / f".local/share/{App.app.app_name}"
+        return (
+            Path(os.environ.get("XDG_DATA_HOME") or (Path.home() / ".local/share"))
+            / App.app.app_name
+        )
 
     def get_cache_path(self):
-        return Path.home() / f".cache/{App.app.app_name}"
+        return (
+            Path(os.environ.get("XDG_CACHE_HOME") or (Path.home() / ".cache"))
+            / App.app.app_name
+        )
 
     def get_logs_path(self):
-        return Path.home() / f".local/state/{App.app.app_name}/log"
+        return (
+            Path(os.environ.get("XDG_STATE_HOME") or (Path.home() / ".local/state"))
+            / App.app.app_name
+            / "log"
+        )

gtk/tests_backend/app.py

@@ -37,19 +37,31 @@ def __init__(self, app):
 
     @property
     def config_path(self):
-        return Path.home() / ".config/testbed"
+        return (
+            Path(os.environ.get("XDG_CONFIG_HOME") or (Path.home() / ".config"))
+            / "testbed"
+        )
 
     @property
     def data_path(self):
-        return Path.home() / ".local/share/testbed"
+        return (
+            Path(os.environ.get("XDG_DATA_HOME") or (Path.home() / ".local/share"))
+            / "testbed"
+        )
 
     @property
     def cache_path(self):
-        return Path.home() / ".cache/testbed"
+        return (
+            Path(os.environ.get("XDG_CACHE_HOME") or (Path.home() / ".cache"))
+            / "testbed"
+        )
 
     @property
     def logs_path(self):
-        return Path.home() / ".local/state/testbed/log"
+        return (
+            Path(os.environ.get("XDG_STATE_HOME") or (Path.home() / ".local/state"))
+            / "testbed/log"
+        )
 
     @property
     def is_cursor_visible(self):

qt/src/toga_qt/paths.py

@@ -1,3 +1,4 @@
+import os
 from pathlib import Path
 
 from toga import App
@@ -8,13 +9,26 @@ def __init__(self, interface):
         self.interface = interface
 
     def get_config_path(self):
-        return Path.home() / f".config/{App.app.app_name}"
+        return (
+            Path(os.environ.get("XDG_CONFIG_HOME") or (Path.home() / ".config"))
+            / App.app.app_name
+        )
 
     def get_data_path(self):
-        return Path.home() / f".local/share/{App.app.app_name}"
+        return (
+            Path(os.environ.get("XDG_DATA_HOME") or (Path.home() / ".local/share"))
+            / App.app.app_name
+        )
 
     def get_cache_path(self):
-        return Path.home() / f".cache/{App.app.app_name}"
+        return (
+            Path(os.environ.get("XDG_CACHE_HOME") or (Path.home() / ".cache"))
+            / App.app.app_name
+        )
 
     def get_logs_path(self):
-        return Path.home() / f".local/state/{App.app.app_name}/log"
+        return (
+            Path(os.environ.get("XDG_STATE_HOME") or (Path.home() / ".local/state"))
+            / App.app.app_name
+            / "log"
+        )

qt/src/toga_qt/widgets/selection.py

@@ -1,7 +1,7 @@
 from contextlib import contextmanager
 
 from PySide6.QtGui import QPalette
-from PySide6.QtWidgets import QComboBox
+from PySide6.QtWidgets import QComboBox, QSizePolicy
 from travertino.size import at_least
 
 from .base import Widget
@@ -11,6 +11,10 @@ class Selection(Widget):
     def create(self):
         self.native = QComboBox()
         self.native.setSizeAdjustPolicy(QComboBox.SizeAdjustPolicy.AdjustToContents)
+        self.native.setSizePolicy(
+            QSizePolicy.Policy.Expanding,
+            QSizePolicy.Policy.Fixed,
+        )
         self.native.currentIndexChanged.connect(self.qt_on_current_index_changed)
         self._item_id_count = 0
         self._last_selected_item_id = 0

qt/tests_backend/app.py

@@ -1,3 +1,4 @@
+import os
 from pathlib import Path
 
 import PIL.Image
@@ -37,19 +38,31 @@ def __init__(self, app):
 
     @property
     def config_path(self):
-        return Path.home() / ".config/testbed-qt"
+        return (
+            Path(os.environ.get("XDG_CONFIG_HOME") or (Path.home() / ".config"))
+            / "testbed-qt"
+        )
 
     @property
     def data_path(self):
-        return Path.home() / ".local/share/testbed-qt"
+        return (
+            Path(os.environ.get("XDG_DATA_HOME") or (Path.home() / ".local/share"))
+            / "testbed-qt"
+        )
 
     @property
     def cache_path(self):
-        return Path.home() / ".cache/testbed-qt"
+        return (
+            Path(os.environ.get("XDG_CACHE_HOME") or (Path.home() / ".cache"))
+            / "testbed-qt"
+        )
 
     @property
     def logs_path(self):
-        return Path.home() / ".local/state/testbed-qt/log"
+        return (
+            Path(os.environ.get("XDG_STATE_HOME") or (Path.home() / ".local/state"))
+            / "testbed-qt/log"
+        )
 
     @property
     def is_cursor_visible(self):

testbed/tests/widgets/test_webview.py

@@ -374,6 +374,9 @@ async def test_dom_storage_enabled(widget, probe, on_load):
         LOAD_TIMEOUT,
     )
 
+    # Add initial delay to ensure page is fully loaded
+    await probe.redraw("Waiting for page to be fully ready", delay=1)
+
     for _ in range(10):
         expected_value = "Hello World"
         expression = f"""\
@@ -393,7 +396,7 @@ async def test_dom_storage_enabled(widget, probe, on_load):
             # Success!
             return
 
-        await probe.redraw("Wait for DOM to be ready", delay=0.2)
+        await probe.redraw("Wait for DOM to be ready", delay=0.5)
 
     pytest.fail(
         f"Didn't receive expected result ({expected_value!r}) after multiple tries; "
@@ -421,7 +424,7 @@ async def test_retrieve_cookies(widget, probe, on_load):
 
     # On iOS and macOS, setting a cookie can fail if it's done too soon after page load.
     # Try a couple of times to make sure the cookie is actually set.
-    for _ in range(5):
+    for attempt in range(10):
         # JavaScript expression to set a cookie and return the current cookies
         expression = """
         (function setCookie() {
@@ -442,7 +445,11 @@ async def test_retrieve_cookies(widget, probe, on_load):
 
         if cookie is None:
             # Cookie wasn't set; wait a little bit before trying again.
-            await probe.redraw("Cookie wasn't set; wait and try again", delay=0.2)
+            delay = 0.5 if attempt < 3 else 1.0
+            await probe.redraw("Cookie wasn't set; wait and try again", delay=delay)
+            continue
+
+        break
 
     assert cookie is not None, "Test cookie not found in CookieJar"
 

textual/src/toga_textual/paths.py

@@ -1,3 +1,4 @@
+import os
 import sys
 from functools import cached_property
 from pathlib import Path
@@ -33,7 +34,13 @@ def _app_dir(self):
             # No coverage testing of this because we can't easily configure
             # the app to have no author.
             author = "Unknown" if App.app.author is None else App.app.author
-            return Path.home() / f"AppData/Local/{author}/{App.app.formal_name}"
+            local_app_data = os.environ.get("LOCALAPPDATA")
+            base_dir = (
+                Path(local_app_data)
+                if local_app_data
+                else (Path.home() / "AppData/Local")
+            )
+            return base_dir / author / App.app.formal_name
 
         # The rest are cached at the interface level:
 
@@ -56,13 +63,26 @@ def __init__(self, interface):
             self.interface = interface
 
         def get_config_path(self):
-            return Path.home() / f".config/{App.app.app_name}"
+            return (
+                Path(os.environ.get("XDG_CONFIG_HOME") or (Path.home() / ".config"))
+                / App.app.app_name
+            )
 
         def get_data_path(self):
-            return Path.home() / f".local/share/{App.app.app_name}"
+            return (
+                Path(os.environ.get("XDG_DATA_HOME") or (Path.home() / ".local/share"))
+                / App.app.app_name
+            )
 
         def get_cache_path(self):
-            return Path.home() / f".cache/{App.app.app_name}"
+            return (
+                Path(os.environ.get("XDG_CACHE_HOME") or (Path.home() / ".cache"))
+                / App.app.app_name
+            )
 
         def get_logs_path(self):
-            return Path.home() / f".local/state/{App.app.app_name}/log"
+            return (
+                Path(os.environ.get("XDG_STATE_HOME") or (Path.home() / ".local/state"))
+                / App.app.app_name
+                / "log"
+            )

textual/tests_backend/app.py

@@ -1,3 +1,4 @@
+import os
 import sys
 from pathlib import Path
 
@@ -35,41 +36,62 @@ def __init__(self, app):
         self.app = app
         assert isinstance(self.app._impl.native, TextualApp)
 
+    @property
+    def _win32_app_dir(self):
+        local_app_data = os.environ.get("LOCALAPPDATA")
+        base_dir = (
+            Path(local_app_data) if local_app_data else (Path.home() / "AppData/Local")
+        )
+        return base_dir / AUTHOR / FORMAL_NAME
+
     @property
     def config_path(self):
         if sys.platform == "darwin":
             return Path.home() / f"Library/Preferences/{APP_ID}"
         elif sys.platform == "win32":
-            return Path.home() / f"AppData/Local/{AUTHOR}/{FORMAL_NAME}/Config"
+            return self._win32_app_dir / "Config"
         else:
-            return Path.home() / f".config/{APP_NAME}"
+            return (
+                Path(os.environ.get("XDG_CONFIG_HOME") or (Path.home() / ".config"))
+                / APP_NAME
+            )
 
     @property
     def data_path(self):
         if sys.platform == "darwin":
             return Path.home() / f"Library/Application Support/{APP_ID}"
         elif sys.platform == "win32":
-            return Path.home() / f"AppData/Local/{AUTHOR}/{FORMAL_NAME}/Data"
+            return self._win32_app_dir / "Data"
         else:
-            return Path.home() / f".local/share/{APP_NAME}"
+            return (
+                Path(os.environ.get("XDG_DATA_HOME") or (Path.home() / ".local/share"))
+                / APP_NAME
+            )
 
     @property
     def cache_path(self):
         if sys.platform == "darwin":
             return Path.home() / f"Library/Caches/{APP_ID}"
         elif sys.platform == "win32":
-            return Path.home() / f"AppData/Local/{AUTHOR}/{FORMAL_NAME}/Cache"
+            return self._win32_app_dir / "Cache"
         else:
-            return Path.home() / f".cache/{APP_NAME}"
+            return (
+                Path(os.environ.get("XDG_CACHE_HOME") or (Path.home() / ".cache"))
+                / APP_NAME
+            )
 
     @property
     def logs_path(self):
         if sys.platform == "darwin":
             return Path.home() / f"Library/Logs/{APP_ID}"
         elif sys.platform == "win32":
-            return Path.home() / f"AppData/Local/{AUTHOR}/{FORMAL_NAME}/Logs"
+            return self._win32_app_dir / "Logs"
         else:
-            return Path.home() / f".local/state/{APP_NAME}/log"
+            return (
+                Path(os.environ.get("XDG_STATE_HOME") or (Path.home() / ".local/state"))
+                / APP_NAME
+                / "log"
+            )
 
     async def assert_event_loop(self):
         pytest.skip("Event loop assertions are not implemented on Textual.")

winforms/src/toga_winforms/paths.py

@@ -1,3 +1,4 @@
+import os
 from functools import cached_property
 from pathlib import Path
 
@@ -13,7 +14,11 @@ def _app_dir(self):
         # No coverage testing of this because we can't easily configure
         # the app to have no author.
         author = "Unknown" if App.app.author is None else App.app.author
-        return Path.home() / f"AppData/Local/{author}/{App.app.formal_name}"
+        local_app_data = os.environ.get("LOCALAPPDATA")
+        base_dir = (
+            Path(local_app_data) if local_app_data else (Path.home() / "AppData/Local")
+        )
+        return base_dir / author / App.app.formal_name
 
     # The rest are cached at the interface level: