Blender not recognizing crc32c library in add-on #106963

Closed
opened 2023-04-14 19:01:25 +02:00 by Ryan-Silverman · 2 comments

System Information
Operating system: macOS Big Sur
Graphics card: N/A

Blender Version
Broken: 3.0, 3.5
Worked: None

Short description of error
I am creating an add-on using the crc32c library. However, if I try to install it without doing anything else, I receive an error because Blender does not recognize the library. However, if I install a version of my add-on without the crc32c library, uninstall it, and then install my add-on with crc32c it works. However, this only works for the duration that Blender is open, once I close it crc32c no longer works again.

Exact steps for others to reproduce the error
Create a python add-on with the crc32c library ("import crc32c") and try to load it into Blender

**System Information** Operating system: macOS Big Sur Graphics card: N/A **Blender Version** Broken: 3.0, 3.5 Worked: None **Short description of error** I am creating an add-on using the crc32c library. However, if I try to install it without doing anything else, I receive an error because Blender does not recognize the library. However, if I install a version of my add-on without the crc32c library, uninstall it, and then install my add-on with crc32c it works. However, this only works for the duration that Blender is open, once I close it crc32c no longer works again. **Exact steps for others to reproduce the error** Create a python add-on with the crc32c library ("import crc32c") and try to load it into Blender
Ryan-Silverman added the
Priority
Normal
Type
Report
Status
Needs Triage
labels 2023-04-14 19:01:26 +02:00
Iliya Katushenock added the
Interest
Python API
label 2023-04-15 10:07:46 +02:00

It is not a Blender problem. site.getusersitepackages() was even included into sys.path by default recently: 72c012ab4a
It is in 3.5: 1be25cfff1/source/blender/python/intern/bpy_interface.c (L374-L381)

But you still have to check and install libraries.

bl_info = {
    "name": "test crc32c",
    "author": "",
    "version": (0, 0, 1),
    "blender": (2, 80, 0),
    "location": "",
    "description": "",
    "warning": "",
    "doc_url": "",
    "category": "Generic",
}

def ensure_site_packages(packages: list, directory: str):
    """ 
    `packages`: list of tuples (<import name>, <pip name>)
    `directory`: a folder for site packages, will be created if does not exist and added to `sys.path`
    """

    if not packages:
        return

    import bpy
    import os
    import sys
    import importlib
    import importlib.util

    os.makedirs(directory, exist_ok = True)

    if not directory in sys.path:
        sys.path.append(directory)

    modules_to_install = [module[1] for module in packages if not importlib.util.find_spec(module[0])]
    if not modules_to_install:
        return

    if bpy.app.version < (2,91,0):
        python_binary = bpy.app.binary_path_python
    else:
        python_binary = sys.executable

    import subprocess
    subprocess.run([python_binary, '-m', 'ensurepip'], check=True)
    subprocess.run([python_binary, '-m', 'pip', 'install', *modules_to_install, "--target", directory], check=True)

    importlib.invalidate_caches()

def register():

    import site

    ensure_site_packages([("crc32c", "crc32c")], directory = site.getusersitepackages())

    import  crc32c

    print(crc32c.crc32c(b'hello world'))
    # 3381945770
    crc = crc32c.crc32c(b'hello')
    print(crc32c.crc32c(b' world', crc))
    # 3381945770


    ensure_site_packages([("google_crc32c", "google-crc32c")], directory = site.getusersitepackages())

    import  google_crc32c

    print(google_crc32c.Checksum(b'hello world')._crc)
    # 3381945770
    checksum = google_crc32c.Checksum(b'hello')
    checksum.update(b' world')
    print(checksum._crc)
    # 3381945770

def unregister():
    pass

if __name__ == "__main__":
    register()

It is not a Blender problem. `site.getusersitepackages()` was even included into `sys.path` by default recently: https://projects.blender.org/blender/blender/commit/72c012ab4a3d2a7f7f59334f4912402338c82e3c It is in 3.5: https://projects.blender.org/blender/blender/blame/commit/1be25cfff18b2c55ad6c0c6389daf3891672476a/source/blender/python/intern/bpy_interface.c#L374-L381 But you still have to check and install libraries. ```py bl_info = { "name": "test crc32c", "author": "", "version": (0, 0, 1), "blender": (2, 80, 0), "location": "", "description": "", "warning": "", "doc_url": "", "category": "Generic", } def ensure_site_packages(packages: list, directory: str): """ `packages`: list of tuples (<import name>, <pip name>) `directory`: a folder for site packages, will be created if does not exist and added to `sys.path` """ if not packages: return import bpy import os import sys import importlib import importlib.util os.makedirs(directory, exist_ok = True) if not directory in sys.path: sys.path.append(directory) modules_to_install = [module[1] for module in packages if not importlib.util.find_spec(module[0])] if not modules_to_install: return if bpy.app.version < (2,91,0): python_binary = bpy.app.binary_path_python else: python_binary = sys.executable import subprocess subprocess.run([python_binary, '-m', 'ensurepip'], check=True) subprocess.run([python_binary, '-m', 'pip', 'install', *modules_to_install, "--target", directory], check=True) importlib.invalidate_caches() def register(): import site ensure_site_packages([("crc32c", "crc32c")], directory = site.getusersitepackages()) import crc32c print(crc32c.crc32c(b'hello world')) # 3381945770 crc = crc32c.crc32c(b'hello') print(crc32c.crc32c(b' world', crc)) # 3381945770 ensure_site_packages([("google_crc32c", "google-crc32c")], directory = site.getusersitepackages()) import google_crc32c print(google_crc32c.Checksum(b'hello world')._crc) # 3381945770 checksum = google_crc32c.Checksum(b'hello') checksum.update(b' world') print(checksum._crc) # 3381945770 def unregister(): pass if __name__ == "__main__": register() ```

Looks like the behavior has changed with 72c012ab4a3d2a7f7f59334f4912402338c82e3c?
Optionally you could manually include directories to be used by the interpreter installed with Blender.
Anyway, this seems to be a configuration issue set for the Python interpreter that comes with Blender and not really a bug.

So I'm closing the report.

Looks like the behavior has changed with 72c012ab4a3d2a7f7f59334f4912402338c82e3c? Optionally you could manually include directories to be used by the interpreter installed with Blender. Anyway, this seems to be a configuration issue set for the Python interpreter that comes with Blender and not really a bug. So I'm closing the report.
Blender Bot added
Status
Archived
and removed
Status
Needs Triage
labels 2023-04-17 21:00:38 +02: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
3 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#106963
No description provided.