Skip to content
This repository was archived by the owner on Oct 7, 2025. It is now read-only.

plugins: handle exceptions in walk_package, ignore hidden directories #1010

Merged
cecpk merged 2 commits into from
Dec 20, 2020
Merged

plugins: handle exceptions in walk_package, ignore hidden directories #1010

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
85afecc
plugins: handle exceptions in walk_package, ignore hidden directories
crhbetz Sep 21, 2020
1bc0fac
exclude hidden files/folders from plugin zipping
crhbetz Sep 23, 2020
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
65 changes: 35 additions & 30 deletions mapadroid/utils/pluginBase.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,37 +79,42 @@ def apply_all_plugins_on_value(self):
def walk_package(self, package):
"""Recursively walk the supplied package to retrieve all plugins
"""
imported_package = __import__(package, fromlist=['MAD'])

for _, pluginname, ispkg in pkgutil.iter_modules(imported_package.__path__, imported_package.__name__ + '.'):
if not ispkg:
plugin_module = __import__(pluginname, fromlist=['MAD'])
clsmembers = inspect.getmembers(plugin_module, inspect.isclass)
for (_, plugin) in clsmembers:
# Only add classes that are a sub class of Plugin, but NOT Plugin itself
if issubclass(plugin, Plugin) & (plugin is not Plugin):
self._logger.info(f'Found plugin class: {plugin.__name__}')
self.plugins.append({"plugin": plugin(self._mad),
"path": [package for package in imported_package.__path__][0]})

# Now that we have looked at all the modules in the current package, start looking
# recursively for additional modules in sub packages
all_current_paths = []
if isinstance(imported_package.__path__, str):
all_current_paths.append(imported_package.__path__)
else:
all_current_paths.extend([x for x in imported_package.__path__])
try:
imported_package = __import__(package, fromlist=['MAD'])

for _, pluginname, ispkg in pkgutil.iter_modules(imported_package.__path__,
imported_package.__name__ + '.'):
if not ispkg:
plugin_module = __import__(pluginname, fromlist=['MAD'])
clsmembers = inspect.getmembers(plugin_module, inspect.isclass)
for (_, plugin) in clsmembers:
# Only add classes that are a sub class of Plugin, but NOT Plugin itself
if issubclass(plugin, Plugin) & (plugin is not Plugin):
self._logger.info(f'Found plugin class: {plugin.__name__}')
self.plugins.append({"plugin": plugin(self._mad),
"path": [package for package in imported_package.__path__][0]})

# Now that we have looked at all the modules in the current package, start looking
# recursively for additional modules in sub packages
all_current_paths = []
if isinstance(imported_package.__path__, str):
all_current_paths.append(imported_package.__path__)
else:
all_current_paths.extend([x for x in imported_package.__path__])

for pkg_path in all_current_paths:
if pkg_path not in self.seen_paths:
self.seen_paths.append(pkg_path)
for pkg_path in all_current_paths:
if pkg_path not in self.seen_paths:
self.seen_paths.append(pkg_path)

# Get all sub directory of the current package path directory
child_pkgs = [p for p in os.listdir(pkg_path) if os.path.isdir(os.path.join(pkg_path, p))]
# Get all sub directory of the current package path directory
child_pkgs = [p for p in os.listdir(pkg_path) if os.path.isdir(os.path.join(pkg_path, p))
and not p.startswith(".")]

# For each sub directory, apply the walk_package method recursively
for child_pkg in child_pkgs:
self.walk_package(package + '.' + child_pkg)
# For each sub directory, apply the walk_package method recursively
for child_pkg in child_pkgs:
self.walk_package(package + '.' + child_pkg)
except Exception as e:
self._logger.opt(exception=True).error("Exception in walk_package on package {}: {}", package, e)

def zip_plugin(self, plugin_name, folder, version):
plugin_file_temp = os.path.join(self._mad['args'].temp_path, str(plugin_name) + '.tmp')
Expand All @@ -127,9 +132,9 @@ def zip_plugin(self, plugin_name, folder, version):
zipobj = zipfile.ZipFile(plugin_file_temp, 'w', zipfile.ZIP_DEFLATED)
rootlen = len(folder) + 1
for base, _, files in os.walk(folder):
if "__pycache__" not in base:
if "__pycache__" not in base and "/." not in base:
for file_to_zip in files:
if file_to_zip != "plugin.ini":
if file_to_zip != "plugin.ini" and not file_to_zip.startswith("."):
fn = os.path.join(base, file_to_zip)
zipobj.write(fn, fn[rootlen:])

Expand Down