Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PICARD-2354: DeprecationWarning: the imp module is deprecated in favour of importlib #2134

Closed
wants to merge 10 commits into from
Closed

PICARD-2354: DeprecationWarning: the imp module is deprecated in favour of importlib #2134

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
3a2a3d2
imp removed, importlib replacements for review
skelly37 Jul 22, 2022
1421170
linter + unused variable warning removed
skelly37 Jul 22, 2022
b71e9e0
__init__.py import bypass
skelly37 Jul 22, 2022
093e65e
find_spec try
skelly37 Jul 22, 2022
45ce327
sys path mock try
skelly37 Jul 22, 2022
3af0686
Snippet from stack seems to help
skelly37 Jul 22, 2022
9a7a3b0
unnecessary sys removed
skelly37 Jul 22, 2022
64934d5
just dirname in path
skelly37 Jul 22, 2022
7813493
dirname replacement only for modules
skelly37 Jul 22, 2022
fa36ca4
PICARD-2354: Exec plugin module when loading
phw Dec 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 18 additions & 13 deletions picard/pluginmanager.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@


from functools import partial
import imp
import importlib
import json
import os.path
Expand Down Expand Up @@ -123,10 +122,8 @@ def _plugin_name_from_path(path):

def load_manifest(archive_path):
archive = zipfile.ZipFile(archive_path)
manifest_data = None
with archive.open('MANIFEST.json') as f:
manifest_data = json.loads(str(f.read().decode()))
return manifest_data
return json.loads(str(f.read().decode()))


def zip_import(path):
Expand Down Expand Up @@ -232,7 +229,7 @@ def _get_plugin_index_by_name(self, name):
return (None, None)

def _load_plugin_from_directory(self, name, plugindir):
module_file = None
info = None
zipfilename = os.path.join(plugindir, name + '.zip')
(zip_importer, module_name, manifest_data) = zip_import(zipfilename)
if zip_importer:
Expand All @@ -243,15 +240,23 @@ def _load_plugin_from_directory(self, name, plugindir):
return None
module_pathname = zip_importer.get_filename(name)
else:
try:
info = imp.find_module(name, [plugindir])
module_file = info[0]
module_pathname = info[1]
except ImportError:
# instead of looking for a module in the whole directory, we have to provide an explicit path to it
# e.g. for Picard in /home/user/picard it'd be:
# importlib.util.spec_from_file_location("picard", "/home/user/picard/picard/__init__.py")
# alternatively we could use importlib.find_loader, which works pretty much the same but is unfortunately
# deprecated since 3.4
#
# comment to be deleted, just for the PR purposes
info = importlib.machinery.PathFinder().find_spec(name, [plugindir])
if not info.loader:
error = _("Failed loading plugin %r in %r")
self.plugin_error(name, error, name, [plugindir])
return None

module_pathname = info.origin
if module_pathname.endswith("__init__.py"):
module_pathname = os.path.dirname(module_pathname)

plugin = None
try:
existing_plugin, existing_plugin_index = self._get_plugin_index_by_name(name)
Expand All @@ -267,7 +272,9 @@ def _load_plugin_from_directory(self, name, plugindir):
if zip_importer:
plugin_module = zip_importer.load_module(full_module_name)
else:
plugin_module = imp.load_module(full_module_name, *info)
plugin_module = importlib.util.module_from_spec(info)
info.loader.exec_module(plugin_module)

plugin = PluginWrapper(plugin_module, plugindir,
file=module_pathname, manifest_data=manifest_data)
compatible_versions = _compatible_api_versions(plugin.api_versions)
Expand All @@ -293,8 +300,6 @@ def _load_plugin_from_directory(self, name, plugindir):
except BaseException:
error = _("Plugin %r")
self.plugin_error(name, error, name, log_func=log.exception)
if module_file is not None:
module_file.close()
return plugin

def _get_existing_paths(self, plugin_name, fileexts):
Expand Down