Fix #112788: python modules should have ModuleType attributes #112813

Leonardo Covarrubias · 2023-09-24T20:16:25+02:00

2023-09-24 20:16:25 +02:00

First-time contributor

This addresses: #112788

Problem:
Some bpy python modules are not actually modules defined with PyModuleDef and so they lack many of the attributes described by the ModuleType interface.
This is problematic when code tries to inspect them using importlib.import_module(...) or custom MetaPathFinder and Loader and for example read the __name__ attribute (it does not exist).
Conceptually: if something can be imported like: import bpy.app.translations then it should behave like a module in some basic ways.

The problematic sudo-modules are:

bpy.app
bpy.app.handlers
bpy.app.translations

Solution:
Its straightforward to add these attributes to the objects standing in as modules so that they are available for use.
These additions should not impact any internal or external code.
I've chosen to add valid values for some but not all of the ModuleType attributes so that the end result is equivalent to other bpy modules generated with PyModuleDef

Added:

__name__ with the correct string value
__spec__ with None value
__package__ with None value
__loader__ with None value

This addresses: https://projects.blender.org/blender/blender/issues/112788 **Problem:** Some `bpy` python modules are not actually modules defined with `PyModuleDef` and so they lack many of the attributes described by the [ModuleType](https://docs.python.org/3/library/types.html#types.ModuleType) interface. This is problematic when code tries to inspect them using `importlib.import_module(...)` or custom `MetaPathFinder` and `Loader` and for example read the `__name__` attribute (it does not exist). Conceptually: if something can be imported like: `import bpy.app.translations` then it should behave like a module in some basic ways. The problematic sudo-modules are: - bpy.app - bpy.app.handlers - bpy.app.translations **Solution:** Its straightforward to add these attributes to the objects standing in as modules so that they are available for use. These additions should not impact any internal or external code. I've chosen to add valid values for some but not all of the `ModuleType` attributes so that the end result is equivalent to other `bpy` modules generated with `PyModuleDef` Added: - `__name__` with the correct string value - `__spec__` with None value - `__package__` with None value - `__loader__` with None value

Leonardo Covarrubias changed title from ~~WIP #112788: python modules should have ModuleType attributes~~ to Fix #112788: python modules should have ModuleType attributes

2023-09-24 20:22:59 +02:00

Iliya Katushenock added this to the Python API project 2023-09-24 20:49:48 +02:00

Leonardo Covarrubias force-pushed 112788-add-bpy-module-attrs from a5c669963a to 7526655507

2023-09-25 22:26:58 +02:00

Compare

Merge conflict checking is in progress. Try again in few moments.

View command line instructions.

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u 112788-add-bpy-module-attrs:leocov-112788-add-bpy-module-attrs

git checkout leocov-112788-add-bpy-module-attrs

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

Fix #112788: python modules should have ModuleType attributes #112813

Checkout