Addon: catch certain ZIP packaging errors in addon_install #117664

Scurest · 2024-01-30T10:36:43+01:00

Scurest commented

2024-01-30 10:36:43 +01:00

One error that occurs when packaging a multi-file addon into a
ZIP is zipping the contents of the addon folder, instead of the
addon folder itself. When installing the ZIP using addon_install,
the files that should be inside a folder instead get extracted
into the top-level of the script directory. There is also no user
feedback about what went wrong.

addon_install can detect this error by the presence of an
init.py file at the top-level of the ZIP archive, and report
an error. AFAIK there is no use-case for having an init.py
in the top-level of the script directory, so there are no false
positives.

Inspired by this bug.

One error that occurs when packaging a multi-file addon into a ZIP is zipping the contents of the addon folder, instead of the addon folder itself. When installing the ZIP using addon_install, the files that should be inside a folder instead get extracted into the top-level of the script directory. There is also no user feedback about what went wrong. addon_install can detect this error by the presence of an __init__.py file at the top-level of the ZIP archive, and report an error. AFAIK there is no use-case for having an __init__.py in the top-level of the script directory, so there are no false positives. ------ Inspired by [this bug](https://github.com/Luctaris/blender-import-glr/issues/7).

Scurest added 1 commit 2024-01-30 10:36:50 +01:00

e17a51dbda Addon: catch certain ZIP packaging errors in addon_install

One error that occurs when packaging a multi-file addon into a
ZIP is zipping the contents of the addon folder, instead of the
addon folder itself. When installing the ZIP using addon_install,
the files that should be inside a folder instead get extracted
into the top-level of the script directory. There is also no user
feedback about what went wrong.

addon_install can detect this error by the presence of an
__init__.py file at the top-level of the ZIP archive, and report
an error. AFAIK there is no use-case for having an __init__.py
in the top-level of the script directory, so there are no false
positives.

Iliya Katushenock added this to the Python API project 2024-01-30 12:54:46 +01:00

Brecht Van Lommel requested review from Campbell Barton 2024-01-30 14:13:32 +01:00

Campbell Barton referenced this issue from a commit

2024-01-31 00:03:51 +01:00

Addon: catch certain ZIP packaging errors in addon_install

Campbell Barton manually merged commit f87cc8ca8f into main

2024-01-31 00:04:13 +01:00

Scurest deleted branch addon-install-zip-error

2024-01-31 01:21:03 +01:00

Sign in to join this conversation.

No reviewers

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Addon: catch certain ZIP packaging errors in addon_install #117664