Using IPluginPaths and core's extract_review.py profile

tanh · 7 August 2025 23:56

Hullo AYONerds,

For the AYON Harmony plugin, we created a custom launcher action to remove the old extracted Harmony ZIP file from the local cache.

We got this custom launcher action to appear by adding IPluginPaths to the HarmonyAddon class definition here:
ayon-harmony/client/ayon_harmony/addon.py

However, we’ve just discovered that this interferes with the core’s extract_review.py functionality. Specifically, in the core’s extract_review, self.profile always returns None, even when the context is not in the Harmony host.

We suspect this happens because there’s also an extract_review.py inside the Harmony plugin’s publish folder. Renaming Harmony’s extract_review.py makes the core’s version work again.

What’s the best (and least disruptive) way to create a custom launcher action for a specific addon in AYON without causing this kind of conflict?

Regards,
Tu

mustafa_jafar · 8 August 2025 08:32

I don’t think harmony has a plugin named ExtractReview but it has CollectAudio, see ayon-harmony/client/ayon_harmony/plugins/publish folder.

for refrence plugins with the same name may cause a conflict with plugin discovery. as explained in this issue Potential conflict in project settings detection per pyblish plugins · Issue #1389 · ynput/ayon-core · GitHub . it’s worth mentioning that it’s not about the file names, it’s about the class names.

Yul · 8 August 2025 12:12

As PR66 added settings_category = "resolve" , I guess it’s also related to this :

github.com/ynput/ayon-core

Chore: Define settings category on core publish plugins

ynput:develop ← ynput:bugfix/apply-core-plugin-settings

opened 02:39PM - 25 Jul 25 UTC

iLLiCiTiT

+44 -3

## Changelog Description Make sure that plugins that should have applied settin…gs have filled `settings_category` to avoid guessing. ## Additional info Right now there migh be issues related to discovery of plugins as their module path may not correspond to their real path. Side effect was that settings were not applied automatically leading to skip of crutial production parts. Added deprecation warning for plugins that do have applied settings automatically by guessing. ### Issue being resolved with this If you have an addon with publish plugins and the plugins folder contains e.g. `extract_burnin.py` it would break path of the plugin in core's `extract_review.py`. That is related to how we store plugins in `sys.modules`. Which requires different PR to fix it properly, but that doesn't make this PR less valuable. ## Testing notes: 1. Plugins are discovered and settings are applied as expected.

tanh · 11 August 2025 23:23

Thank you @mustafa_jafar and @Yul for the quick response.

We’ve just realized that the extract_review .py in harmony was created as a custom plugin that we made.

We have changed both the filename and the class name to avoid conflict, and it worked as expected now.

@mustafa_jafar about your note with regards to file names and class name, we did noticed with our earlier tests that changing the class name without changing the file name will still produces the bug/issue with extract_review.