Fix Python operator templates are not accessible from menus #90866

New Issue

Philipp Oeser · 2021-08-23T10:26:50+02:00

Philipp Oeser commented

2021-08-23 10:26:50 +02:00

This addresses:

In #74157#1208583, @cessen wrote:
I'd like to second what @alefor above said:

The Python operator templates (such as operator_simple.py in the text editor's "Templates" menu ) should be updated to include the minimal code needed to make the operator accessible to the user.

Just defining an operator isn't useful if it can't be accessed, and that makes those templates a bit of an educational stumbling block now. It also makes them no longer nearly as useful as a starting point for just knocking out a custom operator quickly.

This addresses: > In #74157#1208583, @cessen wrote: > I'd like to second what @alefor above said: > > The Python operator templates (such as operator_simple.py in the text editor's "Templates" menu ) should be updated to include the minimal code needed to make the operator accessible to the user. > > Just defining an operator isn't useful if it can't be accessed, and that makes those templates a bit of an educational stumbling block now. It also makes them no longer nearly as useful as a starting point for just knocking out a custom operator quickly.

Philipp Oeser commented

2021-08-23 10:26:50 +02:00

Changed status from 'Needs Triage' to: 'Confirmed'

Philipp Oeser commented

2021-08-23 10:26:50 +02:00

Added subscribers: @alefor, @cessen, @lichtwerk, @ideasman42

Philipp Oeser self-assigned this 2021-08-23 10:27:05 +02:00

Aaron Carlisle commented

2021-09-21 05:15:35 +02:00

Added subscriber: @Blendify

Aaron Carlisle commented

2021-09-21 05:15:35 +02:00

Not really a documentation issue, I have already updated the documentation here to recommend developers enable developer extras to go around this issue.

Diptangshu Dey commented

2021-10-29 06:23:04 +02:00

Added subscriber: @Tha_Hobbist

Diptangshu Dey commented

2021-10-29 06:23:04 +02:00

Hello, I'm new to blender development community and I would like to work on this issue to get started. Some guidance will be useful.

Philipp Oeser commented

2021-10-29 15:21:48 +02:00

Hi @Tha_Hobbist and thx for interest in contributing.

So you would go over all the operators in
https://developer.blender.org/diffusion/B/browse/master/doc/python_api/examples/
https://developer.blender.org/diffusion/B/browse/master/release/scripts/templates_py/
and make sure the all show up in some suiting menu (and thus in {key F3} search as well)
Adding a comment like "Add to the "XYZ" menu, use F3 search "ZXY" for quick access" could help, too.

For an example of how this works, have a look at operator_file_export.py
So there are these parts to it:

def menu_func_export(self, context):
    self.layout.operator(ExportSomeData.bl_idname, text="Text Export Operator")

pick a menu this should be added to when registering:

bpy.types.TOPBAR_MT_file_export.append(menu_func_export)

and remove when unregistering.

Then put up a patch here (See https://wiki.blender.org/wiki/Process/Contributing_Code also)

Hi @Tha_Hobbist and thx for interest in contributing. So you would go over all the operators in https://developer.blender.org/diffusion/B/browse/master/doc/python_api/examples/ https://developer.blender.org/diffusion/B/browse/master/release/scripts/templates_py/ and make sure the all show up in some suiting menu (and thus in {key F3} search as well) Adding a comment like "Add to the "XYZ" menu, use F3 search "ZXY" for quick access" could help, too. For an example of how this works, have a look at `operator_file_export.py` So there are these parts to it: ``` def menu_func_export(self, context): self.layout.operator(ExportSomeData.bl_idname, text="Text Export Operator") ``` pick a menu this should be added to when registering: ``` bpy.types.TOPBAR_MT_file_export.append(menu_func_export) ``` and remove when unregistering. Then put up a patch here (See https://wiki.blender.org/wiki/Process/Contributing_Code also)

Philipp Oeser removed their assignment 2021-11-02 08:56:28 +01:00

Diptangshu Dey was assigned by Philipp Oeser

2021-11-02 08:56:28 +01:00

blender-admin commented

2021-11-16 10:45:23 +01:00

This issue was referenced by da14a482f2

This issue was referenced by da14a482f281e8d330ef5210ef22335a43eb726c

Philipp Oeser commented

2021-11-16 10:56:53 +01:00

Changed status from 'Confirmed' to: 'Resolved'

Philipp Oeser closed this issue

2021-11-16 10:56:53 +01:00

Thomas Dinges added this to the 3.0 milestone 2023-02-08 15:59:05 +01:00

Sign in to join this conversation.

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Fix Python operator templates are not accessible from menus #90866