Paths

Table of Contentst

Addons: Deprecate wiki_url
ClosedPublic
Actions

Authored by Aaron Carlisle (Blendify) on Mar 4 2020, 12:01 AM.

Details

Reviewers

Sybren A. Stüvel (sybren)
Campbell Barton (campbellbarton)

Summary

Now that addons are not documented on the wiki anymore wiki_url does not make much sense.

For 2.83 (LTS) a warning is hidden behind blender -d
2.90 always show the warning
2.93 (LTS) remove wiki_url

Diff Detail

Event Timeline

Aaron Carlisle (Blendify) created this revision.Mar 4 2020, 12:01 AM

Brecht Van Lommel (brecht) added a subscriber: Brecht Van Lommel (brecht).Mar 4 2020, 1:40 AM

Brecht Van Lommel (brecht) added inline comments.

release/scripts/modules/addon_utils.py
543	depercated -> deprecated

I'd prefer this be handled in addon_utils.module_bl_info, instead of the UI code, which gets a bit messy.

Made some other minor changes too:

Use the name "doc_url" since this is a URL which is useful to know (in keeping with "tracker_url").
Print the file path of the module with the warning, as this can be useful for quickly editing the add-on which needs updating.

P1281 Update to D7015

2 index

3 ---

4 +++

5 @@

9 -

10 +

14 diff

15 index

16 ---

17 +++

18 @@

22 -

23 +

27 @@

31 +

32 +

33 +

34 +

35 +

36 +

37 +

38 +

39 +

40 +

41 +

42 +

43 +

47 diff

48 index

49 ---

50 +++

51 @@

55 -

56 +

62 -

63 +

66 -

67 +

diff --git a/doc/python_api/examples/bpy.types.AddonPreferences.1.py b/doc/python_api/examples/bpy.types.AddonPreferences.1.py 95285e8ac0c..0c82ff924de 100644 a/doc/python_api/examples/bpy.types.AddonPreferences.1.py b/doc/python_api/examples/bpy.types.AddonPreferences.1.py -6,7 +6,7 @@ bl_info = { "location": "SpaceBar Search -> Add-on Preferences Example", "description": "Example Add-on", "warning": "", "wiki_url": "", "doc_url": "", "tracker_url": "", "category": "Object", } --git a/release/scripts/modules/addon_utils.py b/release/scripts/modules/addon_utils.py b58c683dc24..27680e54596 100644 a/release/scripts/modules/addon_utils.py b/release/scripts/modules/addon_utils.py -505,7 +505,7 @@ def module_bl_info(mod, info_basis=None): "blender": (), "location": "", "description": "", "wiki_url": "", "doc_url": "", "support": 'COMMUNITY', "category": "", "warning": "", -527,5 +527,19 @@ def module_bl_info(mod, info_basis=None): if not addon_info["name"]: addon_info["name"] = mod.__name__ # Replace 'wiki_url' with 'doc_url'. doc_url = addon_info.pop("wiki_url", None) if doc_url is not None: # Unlikely, but possible. if not addon_info["doc_url"]: addon_info["doc_url"] = doc_url if _bpy.app.debug: addon_name = addon_info['name'] addon_path = getattr(mod, "__file__", None) print( f"Warning: add-on {addon_name}: 'wiki_url' is deprecated please use " f"'doc_url' instead!\n {addon_path}" ) + addon_info["_init"] = None return addon_info --git a/release/scripts/startup/bl_ui/space_userpref.py b/release/scripts/startup/bl_ui/space_userpref.py 7e868b21e8a..c3c99ebb826 100644 a/release/scripts/startup/bl_ui/space_userpref.py b/release/scripts/startup/bl_ui/space_userpref.py -1873,16 +1873,16 @@ class USERPREF_PT_addons(AddOnPanel, Panel): split.label(text=" " + info["warning"], icon='ERROR') user_addon = USERPREF_PT_addons.is_user_addon(mod, user_addon_paths) tot_row = bool(info["wiki_url"]) + bool(user_addon) tot_row = bool(info["doc_url"]) + bool(user_addon) if tot_row: split = colsub.row().split(factor=0.15) split.label(text="Internet:") sub = split.row() if info["wiki_url"]: if info["doc_url"]: sub.operator( "wm.url_open", text="Documentation", icon='HELP', ).url = info["wiki_url"] ).url = info["doc_url"] # Only add "Report a Bug" button if tracker_url is set # or the add-on is bundled (use official tracker then). if info.get("tracker_url"):

This revision now requires changes to proceed.Mar 4 2020, 8:06 AM

From Campbell's patch:

print(
    "Warning: add-on {:s}: 'wiki_url' is deprecated please use 'doc_url' instead!\n"
    "         {!r}".format(
    addon_info["name"],
    getattr(mod, "__file__", "<unknown>"),
))

I wouldn't use .format() any more now that we have f-strings. Rather would do this:

filename = getattr(mod, "__file__", "<unknown>")
print(
    f"Warning: add-on {addon_info['name']}: 'wiki_url' is deprecated please use "
    f"'doc_url' instead!\n         {filename}"
)

Note that I also removed the !r format string. !r would cause all backslashes in Windows paths to be escaped, which means you wouldn't be able to just copy-paste the path to an editor or file manager.

@Aaron Carlisle (Blendify) Please provide more context in the patch description. We've just talked about these changes, so it's fresh in our minds, but when someone wants to know the reasoning behind this change months or years from now, it'll be hard to follow.

Updated based on Sybren's suggestion.

Update based on patch by @Campbell Barton (campbellbarton)

Thanks, committed rBae223ff52bed: Addons: deprecate 'wiki_url'

This revision is now accepted and ready to land.Mar 5 2020, 1:45 AM

Campbell Barton (campbellbarton) closed this revision.Mar 5 2020, 1:45 AM

Ray Molenkamp (LazyDodo) retitled this revision from Addons: Depricate wiki_url to Addons: Deprecate wiki_url.Mar 5 2020, 2:09 AM

Committed rBAbb977fbc723c: Update 'bl_info' use 'doc_url' instead of 'wiki_url', rBAC5c755ab594e7: Update 'bl_info' use 'doc_url' instead of 'wiki_url'

Riccardo Giovanetti (harvester) mentioned this in T77117: Wrong link in 2.83 release notes for deprecated wiki_url.May 27 2020, 10:26 PM