organizing mostly to test updates

Author: Redbot

src/redfetch/meta.py

@@ -1,4 +1,5 @@
-# Standard
+#region Imports
+# standard imports
 import os
 import platform
 import subprocess
@@ -7,22 +8,25 @@
 import tempfile
 from pathlib import Path
 
-# Third-party
+# third-party imports
 import httpx
 from packaging import version
 
-# Rich library
+# rich library
 from rich.console import Console
 from rich.panel import Panel
 from rich.text import Text
 from rich.prompt import Confirm
 
-# Local
+# local imports
 from redfetch.__about__ import __version__
 from redfetch import config
 from diskcache import Cache
+#endregion Imports
 
 
+#region Module setup
+
 def _get_pypi_url() -> str:
     """Pick PyPI JSON URL, favouring `REDFETCH_PYPI_URL` if set."""
     env_url = os.getenv("REDFETCH_PYPI_URL")
@@ -41,6 +45,10 @@ def _get_pypi_url() -> str:
 def get_current_version():
     return __version__
 
+#endregion Module setup
+
+
+#region Version caching
 
 _UPDATE_CACHE_TTL_SECONDS = 10 * 60  # 10 minutes
 
@@ -72,6 +80,20 @@ def clear_pypi_cache() -> None:
         _meta_cache = None
 
 
+def fetch_latest_version_from_pypi():
+    response = httpx.get(PYPI_URL, timeout=10.0)
+    response.raise_for_status()
+    data = response.json()
+    # On TestPyPI, prefer the highest available release (including pre-releases)
+    if "test.pypi.org" in PYPI_URL:
+        releases = list(data.get("releases", {}).keys())
+        if releases:
+            releases.sort(key=version.parse)
+            return releases[-1]
+    # Default: whatever PyPI reports as the latest stable version
+    return data["info"]["version"]
+
+
 def fetch_latest_version_cached():
     """Fetch latest PyPI version with a 2-hour disk-backed cache."""
     global _meta_cache
@@ -85,20 +107,10 @@ def fetch_latest_version_cached():
     _meta_cache.set(cache_key, latest, expire=_UPDATE_CACHE_TTL_SECONDS)
     return latest
 
+#endregion Version caching
 
-def fetch_latest_version_from_pypi():
-    response = httpx.get(PYPI_URL, timeout=10.0)
-    response.raise_for_status()
-    data = response.json()
-    # On TestPyPI, prefer the highest available release (including pre-releases)
-    if "test.pypi.org" in PYPI_URL:
-        releases = list(data.get("releases", {}).keys())
-        if releases:
-            releases.sort(key=version.parse)
-            return releases[-1]
-    # Default: whatever PyPI reports as the latest stable version
-    return data["info"]["version"]
 
+#region Updating
 
 def get_executable_path():
     executable_path = os.environ.get('PYAPP')
@@ -167,56 +179,6 @@ def get_update_command():
     return commands.get(method)
 
 
-def check_for_update(relaunch: bool = False):
-    current_version = get_current_version()
-    
-    try:
-        latest_version = fetch_latest_version_cached()
-        
-        if version.parse(latest_version) > version.parse(current_version):
-            version_info = Panel(
-                Text.assemble(
-                    ("An update for redfetch is available! 🚡\n\n", "bold green"),
-                    ("Local version: ", "dim"),
-                    (f"{current_version}\n", "cyan"),
-                    ("Latest version: ", "dim"),
-                    (f"{latest_version}", "cyan bold")
-                ),
-                title="Update Available",
-                expand=False
-            )
-            console.print(version_info)
-            
-            # Handle PYAPP separately
-            if os.getenv('PYAPP'):
-                if Confirm.ask("Would you like to update now?"):
-                    return self_update(relaunch=relaunch)
-                else:
-                    console.print("[yellow]Update skipped. You can manually update later.[/yellow]")
-                return False
-            
-            # Get the appropriate update command
-            update_command = get_update_command()
-            if not update_command:
-                console.print("[red]Could not determine update method.[/red]")
-                return False
-                
-            command_panel = Panel(
-                Text(" ".join(update_command), style="bold cyan"),
-                title="Update Command",
-                expand=False
-            )
-            console.print(command_panel)
-            
-            if Confirm.ask("Would you like to run this command to update?"):
-                return pip_update_redfetch(update_command, latest_version)
-            else:
-                console.print("[yellow]Update skipped. You can manually update later.[/yellow]")
-    except Exception as e:
-        console.print(f"[bold red]Error checking for updates:[/bold red] {e}")
-    return False
-
-
 def pip_update_redfetch(update_command, latest_version):
     try:
         console.print(f"\n[bold]Updating redfetch to version {latest_version}...[/bold]\n")
@@ -289,6 +251,60 @@ def self_update(relaunch: bool = False):
         sys.exit(1)
 
 
+def check_for_update(relaunch: bool = False):
+    current_version = get_current_version()
+    
+    try:
+        latest_version = fetch_latest_version_cached()
+        
+        if version.parse(latest_version) > version.parse(current_version):
+            version_info = Panel(
+                Text.assemble(
+                    ("An update for redfetch is available! 🚡\n\n", "bold green"),
+                    ("Local version: ", "dim"),
+                    (f"{current_version}\n", "cyan"),
+                    ("Latest version: ", "dim"),
+                    (f"{latest_version}", "cyan bold")
+                ),
+                title="Update Available",
+                expand=False
+            )
+            console.print(version_info)
+            
+            # Handle PYAPP separately
+            if os.getenv('PYAPP'):
+                if Confirm.ask("Would you like to update now?"):
+                    return self_update(relaunch=relaunch)
+                else:
+                    console.print("[yellow]Update skipped. You can manually update later.[/yellow]")
+                return False
+            
+            # Get the appropriate update command
+            update_command = get_update_command()
+            if not update_command:
+                console.print("[red]Could not determine update method.[/red]")
+                return False
+                
+            command_panel = Panel(
+                Text(" ".join(update_command), style="bold cyan"),
+                title="Update Command",
+                expand=False
+            )
+            console.print(command_panel)
+            
+            if Confirm.ask("Would you like to run this command to update?"):
+                return pip_update_redfetch(update_command, latest_version)
+            else:
+                console.print("[yellow]Update skipped. You can manually update later.[/yellow]")
+    except Exception as e:
+        console.print(f"[bold red]Error checking for updates:[/bold red] {e}")
+    return False
+
+#endregion Updating
+
+
+#region Uninstalling
+
 def self_remove():
     """Remove with PYAPP."""
     try:
@@ -377,6 +393,59 @@ def _release_disk_caches() -> None:
         raise RuntimeError("; ".join(errors))
 
 
+def generate_removal_commands(paths):
+    """Generate OS-specific commands to remove the given directories."""
+    system = platform.system()
+    if system == 'Windows':
+        # Generate PowerShell commands
+        console.print("[bold]These directories may be removed manually after you make sure there's nothing you need from them, you can do so by running the following PowerShell commands:[/bold]\n")
+        commands = []
+        for path in sorted(paths):
+            # Escape quotes and handle special characters
+            escaped_path = path.replace("'", "''")
+            command = f"Remove-Item -LiteralPath '{escaped_path}' -Recurse -Force"
+            commands.append(command)
+            console.print(f"  {command}")
+    else:
+        # Assuming Unix-like system
+        console.print("[bold]You can remove these directories by running the following commands in your terminal:[/bold]\n")
+        commands = []
+        for path in sorted(paths):
+            # Escape single quotes
+            escaped_path = path.replace("'", "'\\''")
+            command = f"rm -rf '{escaped_path}'"
+            commands.append(command)
+            console.print(f"  {command}")
+    console.print("\n[bold yellow]These directories must be removed manually.[/bold yellow]")
+    return commands
+
+
+def write_commands_to_file(commands, paths):
+    """Write the removal commands and additional information to a text file and open it on Windows."""
+    # Only write and open the file on Windows
+    if platform.system() == 'Windows':
+        file_path = os.path.join(os.path.expanduser("~"), "redfetch_removal_commands.txt")
+        with open(file_path, 'w') as file:
+            file.write("Manual Cleanup Instructions:\n")
+            file.write("The following directories may contain files downloaded by redfetch. You can remove them manually if you want:\n")
+            for path in sorted(paths):
+                file.write(f" - {path}\n")
+            file.write("\nMake sure there's nothing you want in them. When ready to delete, you can use:\n\n")
+            
+            for command in commands:
+                file.write(command + '\n')
+        
+        # Automatically open the file with the default text editor
+        try:
+            os.startfile(file_path)
+        except Exception as e:
+            console.print(f"[red]Failed to open the file: {e}[/red]")
+            console.print(f"Please open the file manually: [cyan]{file_path}[/cyan]")
+    else:
+        # On non-Windows systems, the important information is already printed to the console
+        console.print("[yellow]After that, you can remove the redfetch package.[/yellow]")
+
+
 def uninstall():
     """Guide the user through the uninstallation process."""
     # Import the logout function from auth module
@@ -530,55 +599,4 @@ def should_print_path(path):
         # Optionally, exit the program
         sys.exit(0)
 
-
-def generate_removal_commands(paths):
-    """Generate OS-specific commands to remove the given directories."""
-    system = platform.system()
-    if system == 'Windows':
-        # Generate PowerShell commands
-        console.print("[bold]These directories may be removed manually after you make sure there's nothing you need from them, you can do so by running the following PowerShell commands:[/bold]\n")
-        commands = []
-        for path in sorted(paths):
-            # Escape quotes and handle special characters
-            escaped_path = path.replace("'", "''")
-            command = f"Remove-Item -LiteralPath '{escaped_path}' -Recurse -Force"
-            commands.append(command)
-            console.print(f"  {command}")
-    else:
-        # Assuming Unix-like system
-        console.print("[bold]You can remove these directories by running the following commands in your terminal:[/bold]\n")
-        commands = []
-        for path in sorted(paths):
-            # Escape single quotes
-            escaped_path = path.replace("'", "'\\''")
-            command = f"rm -rf '{escaped_path}'"
-            commands.append(command)
-            console.print(f"  {command}")
-    console.print("\n[bold yellow]These directories must be removed manually.[/bold yellow]")
-    return commands
-
-
-def write_commands_to_file(commands, paths):
-    """Write the removal commands and additional information to a text file and open it on Windows."""
-    # Only write and open the file on Windows
-    if platform.system() == 'Windows':
-        file_path = os.path.join(os.path.expanduser("~"), "redfetch_removal_commands.txt")
-        with open(file_path, 'w') as file:
-            file.write("Manual Cleanup Instructions:\n")
-            file.write("The following directories may contain files downloaded by redfetch. You can remove them manually if you want:\n")
-            for path in sorted(paths):
-                file.write(f" - {path}\n")
-            file.write("\nMake sure there's nothing you want in them. When ready to delete, you can use:\n\n")
-            
-            for command in commands:
-                file.write(command + '\n')
-        
-        # Automatically open the file with the default text editor
-        try:
-            os.startfile(file_path)
-        except Exception as e:
-            console.print(f"[red]Failed to open the file: {e}[/red]")
-            console.print(f"Please open the file manually: [cyan]{file_path}[/cyan]")
-    else:
-        # On non-Windows systems, the important information is already printed to the console
-        console.print("[yellow]After that, you can remove the redfetch package.[/yellow]")
+#endregion Uninstalling