Merge pull request #44 from DavidCEllis/fix_dtrun_paths

Move the data folder to a more standard location on linux

Author: DavidCEllis

README.md

@@ -60,7 +60,9 @@ version automatically and use that to build the environment.
 Environment data and the application itself will be stored in the following locations:
 
 * Windows: `%LOCALAPPDATA%\ducktools\env`
-* Linux/Mac/Other: `~/.ducktools/env`
+* Linux/Mac/Other: 
+  * Data: `~/.local/share/ducktools/env`
+  * Config: `~/.config/ducktools/env` (Not yet used)
 
 ## Usage ##
 

src/ducktools/env/__main__.py

@@ -227,6 +227,17 @@ def get_parser(prog, exit_on_error=True) -> FixedArgumentParser:
         help="Name of the environment to delete",
     )
 
+    # Temporary migrate argument
+    if sys.platform != "win32":
+        migrate = subparsers.add_parser(
+            "migrate",
+            help="migrate old ducktools-env folder"
+        )
+
+        migrate_mode = migrate.add_mutually_exclusive_group()
+        migrate_mode.add_argument("--overwrite", action="store_true")
+        migrate_mode.add_argument("--delete", action="store_true")
+
     return parser
 
 
@@ -431,6 +442,20 @@ def delete_env_command(manager, args):
     return 0
 
 
+def migrate_command(manager, args):
+    from .platform_paths import PACKAGE_SUBFOLDER, migrate_old_env
+    folder_base = os.path.join(manager.project_name, PACKAGE_SUBFOLDER)
+    if args.overwrite:
+        mode = "overwrite"
+    elif args.delete:
+        mode = "delete"
+    else:
+        mode = "error"
+
+    migrate_old_env(folder_base, mode=mode)
+    return 0
+
+
 def main_command() -> int:
     executable_name = os.path.splitext(os.path.basename(sys.executable))[0]
 
@@ -479,6 +504,8 @@ def main_command() -> int:
             return list_command(manager, args)
         case "delete_env":
             return delete_env_command(manager, args)
+        case "migrate":
+            return migrate_command(manager, args)
         case _:
             raise RuntimeError(f"Invalid Command {args.command!r}")
 
@@ -491,7 +518,7 @@ def main() -> int:
         if sys.stderr:
             sys.stderr.write(errors)
         return 1
-    return 0
+    return result
 
 
 if __name__ == "__main__":

src/ducktools/env/_run.py

@@ -39,6 +39,12 @@
 
 
 def run():
+    if len(sys.argv) < 2:
+        # Script path is required
+        sys.stderr.write("usage: dtrun script_filename [script_args ...]\n")
+        sys.stderr.write("dtrun: error: the following arguments are required: script_filename\n")
+        return 1
+
     # First argument is the path to this script
     _, app, *args = sys.argv
 
@@ -52,12 +58,12 @@ def run():
 
     try:
         if os.path.isfile(app):
-            manager.run_script(
+            returncode = manager.run_script(
                 script_path=app,
                 script_args=args,
             )
         else:
-            manager.run_registered_script(
+            returncode = manager.run_registered_script(
                 script_name=app,
                 script_args=args,
             )
@@ -67,4 +73,4 @@ def run():
             sys.stderr.write(msg)
         return 1
 
-    return 0
+    return returncode

src/ducktools/env/manager.py

@@ -534,7 +534,7 @@ def run_registered_script(
         script_args: list[str],
         generate_lock: bool = False,
         lock_path: str | None = None,
-    ) -> None:
+    ) -> int:
         try:
             row = self.script_registry.retrieve_script(script_name=script_name)
         except ScriptNotFound as e:
@@ -547,7 +547,7 @@ def run_registered_script(
 
         script_path = row.path
 
-        self.run_script(
+        return self.run_script(
             script_path=script_path,
             script_args=script_args,
             generate_lock=generate_lock,

src/ducktools/env/platform_paths.py

@@ -27,6 +27,7 @@
 import os
 import os.path
 
+from ._logger import log
 
 class UnsupportedPlatformError(Exception):
     pass
@@ -69,7 +70,7 @@ class UnsupportedPlatformError(Exception):
     USER_FOLDER = os.path.expanduser("~")
 
 
-def get_platform_python(venv_folder):
+def get_platform_python(venv_folder: str):
     if sys.platform == "win32":
         if sys.stdout:
             return os.path.join(venv_folder, "Scripts", "python.exe")
@@ -79,31 +80,70 @@ def get_platform_python(venv_folder):
         return os.path.join(venv_folder, "bin", "python")
 
 
-def get_platform_folder(name):
+def get_platform_folder(name: str, config: bool = False) -> str:
     if sys.platform == "win32":
-        return os.path.join(USER_FOLDER, name)
+        platform_folder = os.path.join(USER_FOLDER, name)
+    elif config:
+        platform_folder = os.path.join(USER_FOLDER, ".config", name)
     else:
-        return os.path.join(USER_FOLDER, f".{name}")
+        platform_folder = os.path.join(USER_FOLDER, ".local", "share", name)
+
+    return platform_folder
+
+
+def migrate_old_env(name: str, mode="error"):
+    if sys.platform != "win32":
+        old_folder = os.path.join(USER_FOLDER, f".{name}")
+        new_folder = os.path.join(USER_FOLDER, ".local", "share", name)
+        if os.path.exists(old_folder):
+            print(f"Migrating from {old_folder!r} to {new_folder!r}")
+            import shutil
+            if os.path.exists(new_folder):
+                if mode == "delete":
+                    print(f"Removing old data folder as new folder detected.")
+                    shutil.rmtree(old_folder)
+                elif mode == "overwrite":
+                    print(f"Overwriting new folder with old folder data")
+                    shutil.rmtree(new_folder)
+                    shutil.move(old_folder, new_folder)
+                else:
+                    raise RuntimeError(
+                        "Error: Both old and new env folders exist.\n"
+                        "Use --delete to remove the old folder or --overwrite to replace the new folder"
+                    )
+            else:
+                os.makedirs(os.path.dirname(new_folder), exist_ok=True)
+                shutil.move(old_folder, new_folder)
+                print(f"Moved old data to new folder")
+
+            # Try to remove the old folder, will only succeed if empty
+            try:
+                os.rmdir(os.path.dirname(old_folder))
+            except OSError:
+                pass
 
 
 class ManagedPaths:
     project_name: str
     project_folder: str
+
+    # WIN32: %LOCALAPPDATA%\ducktools\env
+    # OTHER: ~/.config/ducktools/env
     config_path: str
 
+    # WIN32: %LOCALAPPDATA%\ducktools\env
+    # OTHER: ~/.local/share/ducktools/env
     manager_folder: str
     pip_zipapp: str
     uv_executable: str
     env_folder: str
+    register_db: str
 
     application_folder: str
     application_db: str
-
     cache_folder: str
     cache_db: str
 
-    register_db: str
-
     build_base: str
 
     def __init__(self, project_name="ducktools"):
@@ -112,7 +152,18 @@ def __init__(self, project_name="ducktools"):
         folder_base = os.path.join(self.project_name, PACKAGE_SUBFOLDER)
 
         self.project_folder = get_platform_folder(folder_base)
-        self.config_path = os.path.join(self.project_folder, CONFIG_FILENAME)
+
+        if sys.platform != "win32":
+            if os.path.exists(os.path.join(USER_FOLDER, f".{folder_base}")):
+                log(
+                    "Old ducktools-env folder detected, "
+                    "use the migrate subcommand to copy data to the new path."
+                )
+
+        self.config_path = os.path.join(
+            get_platform_folder(folder_base, config=True),
+            CONFIG_FILENAME
+        )
 
         self.manager_folder = os.path.join(self.project_folder, MANAGER_FOLDERNAME)
         self.pip_zipapp = os.path.join(self.manager_folder, "pip.pyz")

tests/test_platform_paths.py

@@ -39,7 +39,11 @@ def test_get_platform_folder():
     if sys.platform == "win32":
         assert platform_folder == str(USER_PATH / "demo")
     else:
-        assert platform_folder == str(USER_PATH / ".demo")
+        assert platform_folder == str(USER_PATH / ".local/share/demo")
+
+    if sys.platform != "win32":
+        config_folder = get_platform_folder("demo", config=True)
+        assert config_folder == str(USER_PATH / ".config/demo")
 
 
 class TestManagedPaths:
@@ -52,9 +56,10 @@ def test_basic_paths(self):
         # they are not accidentally changed.
 
         project_folder = Path(get_platform_folder(self.project_name)) / "env"
+        config_folder = Path(get_platform_folder(self.project_name, config=True)) / "env"
 
         assert self.paths.project_folder == str(project_folder)
-        assert self.paths.config_path == str(project_folder / "config.json")
+        assert self.paths.config_path == str(config_folder / "config.json")
         assert self.paths.manager_folder == str(project_folder / "lib")
         assert self.paths.pip_zipapp == str(project_folder / "lib" / "pip.pyz")
         assert self.paths.env_folder == str(project_folder / "lib" / "ducktools-env")