PICARD-1861: Use pathlib.Path for plugins paths

Author: phw

picard/plugin3/manager.py

@@ -2,7 +2,7 @@
 #
 # Picard, the next-generation MusicBrainz tagger
 #
-# Copyright (C) 2024 Philipp Wolfer
+# Copyright (C) 2024-2025 Philipp Wolfer
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License
@@ -19,6 +19,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
 import os
+from pathlib import Path
 from typing import List
 
 from picard import (
@@ -31,8 +32,8 @@
 class PluginManager:
     """Installs, loads and updates plugins from multiple plugin directories."""
 
-    _primary_plugin_dir: str = None
-    _plugin_dirs: List[str] = []
+    _primary_plugin_dir: Path = None
+    _plugin_dirs: List[Path] = []
     _plugins: List[Plugin] = []
 
     def __init__(self, tagger):
@@ -42,9 +43,12 @@ def __init__(self, tagger):
 
     def add_directory(self, dir_path: str, primary: bool = False) -> None:
         log.debug('Registering plugin directory %s', dir_path)
-        dir_path = os.path.normpath(dir_path)
+        dir_path = Path(os.path.normpath(dir_path))
 
-        for entry in os.scandir(dir_path):
+        if not dir_path.exists():
+            os.makedirs(dir_path)
+
+        for entry in dir_path.iterdir():
             if entry.is_dir():
                 plugin = self._load_plugin(dir_path, entry.name)
                 if plugin:
@@ -64,7 +68,7 @@ def init_plugins(self):
             except Exception as ex:
                 log.error('Failed initializing plugin %s from %s', plugin.name, plugin.local_path, exc_info=ex)
 
-    def _load_plugin(self, plugin_dir: str, plugin_name: str):
+    def _load_plugin(self, plugin_dir: Path, plugin_name: str):
         plugin = Plugin(plugin_dir, plugin_name)
         try:
             plugin.read_manifest()
@@ -79,7 +83,7 @@ def _load_plugin(self, plugin_dir: str, plugin_name: str):
                     plugin.local_path,
                 )
         except Exception as ex:
-            log.warning('Could not read plugin manifest from %r', os.path.join(plugin_dir, plugin_name), exc_info=ex)
+            log.warning('Could not read plugin manifest from %r', plugin_dir.joinpath(plugin_name), exc_info=ex)
             return None
 
 

picard/plugin3/plugin.py

@@ -3,7 +3,7 @@
 # Picard, the next-generation MusicBrainz tagger
 #
 # Copyright (C) 2024 Laurent Monin
-# Copyright (C) 2024 Philipp Wolfer
+# Copyright (C) 2024-2025 Philipp Wolfer
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License
@@ -20,7 +20,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
 import importlib.util
-import os
+from pathlib import Path
 import sys
 
 from picard.plugin3.api import PluginApi
@@ -41,7 +41,7 @@ class PluginSourceSyncError(Exception):
 class PluginSource:
     """Abstract class for plugin sources"""
 
-    def sync(self, target_directory: str):
+    def sync(self, target_directory: Path):
         raise NotImplementedError
 
 
@@ -54,15 +54,15 @@ def __init__(self, url: str, ref: str = None):
         self.url = url
         self.ref = ref or 'main'
 
-    def sync(self, target_directory: str):
-        if os.path.isdir(target_directory):
+    def sync(self, target_directory: Path):
+        if target_directory.is_dir():
             print(f'{target_directory} exists, fetch changes')
-            repo = pygit2.Repository(target_directory)
+            repo = pygit2.Repository(target_directory.absolute())
             for remote in repo.remotes:
                 remote.fetch(callbacks=GitRemoteCallbacks())
         else:
             print(f'Cloning {self.url} to {target_directory}')
-            repo = pygit2.clone_repository(self.url, target_directory, callbacks=GitRemoteCallbacks())
+            repo = pygit2.clone_repository(self.url, target_directory.absolute(), callbacks=GitRemoteCallbacks())
             print(list(repo.references))
             print(list(repo.branches))
             print(list(repo.remotes))
@@ -81,27 +81,24 @@ def sync(self, target_directory: str):
 class PluginSourceLocal(PluginSource):
     """Plugin is stored in a local directory, but is not a git repo"""
 
-    def sync(self, target_directory: str):
+    def sync(self, target_directory: Path):
         # TODO: copy tree to plugin directory (?)
         pass
 
 
 class Plugin:
-    local_path: str = None
+    local_path: Path = None
     remote_url: str = None
     ref = None
     name: str = None
     module_name: str = None
     manifest: PluginManifest = None
     _module = None
 
-    def __init__(self, plugins_dir: str, plugin_name: str):
-        if not os.path.exists(plugins_dir):
-            os.makedirs(plugins_dir)
-        self.plugins_dir = plugins_dir
+    def __init__(self, plugins_dir: Path, plugin_name: str):
         self.name = plugin_name
         self.module_name = f'picard.plugins.{self.name}'
-        self.local_path = os.path.join(self.plugins_dir, self.name)
+        self.local_path = plugins_dir.joinpath(self.name)
 
     def sync(self, plugin_source: PluginSource = None):
         """Sync plugin source"""
@@ -113,13 +110,13 @@ def sync(self, plugin_source: PluginSource = None):
 
     def read_manifest(self):
         """Reads metadata for the plugin from the plugin's MANIFEST.toml"""
-        manifest_path = os.path.join(self.local_path, 'MANIFEST.toml')
+        manifest_path = self.local_path.joinpath('MANIFEST.toml')
         with open(manifest_path, 'rb') as manifest_file:
             self.manifest = PluginManifest(self.name, manifest_file)
 
     def load_module(self):
         """Load corresponding module from source path"""
-        module_file = os.path.join(self.local_path, '__init__.py')
+        module_file = self.local_path.joinpath('__init__.py')
         spec = importlib.util.spec_from_file_location(self.module_name, module_file)
         module = importlib.util.module_from_spec(spec)
         sys.modules[self.module_name] = module