Addon: catch certain ZIP packaging errors in addon_install #117664

Manually merged
Campbell Barton merged 1 commits from scurest/blender:addon-install-zip-error into main 2024-01-31 00:04:13 +01:00
Contributor

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
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 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
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset System
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
EEVEE & Viewport
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Asset Browser Project
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
EEVEE & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
No Milestone
No project
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#117664
No description provided.