Extensions Platform: support bundling wheels (.whl) #119681

Open
opened 2024-03-20 01:11:41 +01:00 by Campbell Barton · 0 comments

Python developers often depend on Python modules from the Python package index: https://pypi.org, therefor it is important to provide a way for add-ons to depend on these packages.

This can be supported by bundling wheels (.whl files) which are a zipped module.

This task doesn't go into details about the rationale and is mainly to keep track of related tasks.

  • Initial wheel support:

    An extension should be able to include a .whl file which is installed & available to that extension.

  • Shared wheels:

    Multiple extensions must be able to share a wheel which is removed when none of the installed extensions depend on that wheel.

  • Handle version conflicts:

    Since the wheels are shared in Python's main module name-space,
    there is no practical way we can have both versions installed at once.

    Installing an extension with a conflicting version will fail with an error.

    Note that we could consider allowing an extension to specify a version range, to avoid hard-failing in the case of a version conflict.

  • Binary wheel support:

    Support bundling multiple architectures in an extension, extracting the appropriate wheel for the target system.

    Note that we might not need this if system-architecture is handled by optionally splitting a single extension by architecture.

  • Document the process of bundling wheels with an extension.

Python developers often depend on Python modules from the Python package index: https://pypi.org, therefor it is important to provide a way for add-ons to depend on these packages. This can be supported by bundling wheels (`.whl` files) which are a zipped module. This task doesn't go into details about the rationale and is mainly to keep track of related tasks. - [ ] Initial wheel support: An extension should be able to include a `.whl` file which is installed & available to that extension. - [ ] Shared wheels: Multiple extensions must be able to share a wheel which is removed when none of the installed extensions depend on that wheel. - [ ] Handle version conflicts: Since the wheels are shared in Python's main module name-space, there is no practical way we can have both versions installed at once. Installing an extension with a conflicting version will fail with an error. _Note that we could consider allowing an extension to specify a version range, to avoid hard-failing in the case of a version conflict._ - [ ] Binary wheel support: Support bundling multiple architectures in an extension, extracting the appropriate wheel for the target system. _Note that we might not need this if system-architecture is handled by optionally splitting a single extension by architecture._ - [ ] Document the process of bundling wheels with an extension.
Campbell Barton added the
Type
To Do
label 2024-03-20 01:11:41 +01:00
Sign in to join this conversation.
No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset Browser
Interest
Asset Browser Project Overview
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
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#119681
No description provided.