Addons search also search addon description #27356

New Issue

Davis Sorenson · 2011-05-10T19:58:52+02:00

Davis Sorenson commented

2011-05-10 19:58:52 +02:00

%%%This patch makes the addons search also search the addon descriptions, allowing for more detailed searches. Very simple patch, only affects two lines.%%%

Davis Sorenson commented

2011-05-10 19:58:52 +02:00

Changed status to: 'Open'

Thomas Dinges commented

2011-05-15 11:44:10 +02:00

%%% Patch is fine.

But would like to hear your opinion Luca if this is useful. Assigning to you. %%%

%%% Patch is fine. But would like to hear your opinion Luca if this is useful. Assigning to you. %%%

Campbell Barton commented

2011-05-29 12:54:50 +02:00

%%%I prefer that more advanced search options cache results rather then updating them on draw.%%%

Kyle Mills commented

2011-08-05 20:53:51 +02:00

%%%But it's not that much to search in this case, and it's not slow. Caching could be better used elsewhere.%%%

Bastien Montagne commented

2014-09-23 14:10:43 +02:00

Added subscriber: @mont29

Bastien Montagne commented

2014-09-23 14:10:43 +02:00

Is this patch still relevant/alive?

Davis Sorenson commented

2014-09-23 14:46:14 +02:00

Patch still applies and works. If nobody has objections to the patch as it is, I would like to see it applied to master.

mindrones was unassigned by Bastien Montagne

2014-09-23 14:50:20 +02:00

Bastien Montagne self-assigned this 2014-09-23 14:50:20 +02:00

Bastien Montagne commented

2014-09-23 14:50:20 +02:00

Ok, but would do it a bit differently then (and as suggested by campbell, making a search cache could help here too, maybe build a set with all words from title + author + description when scanning addons, e.g.).

Will see that after release.

Ok, but would do it a bit differently then (and as suggested by campbell, making a search cache could help here too, maybe build a set with all words from title + author + description when scanning addons, e.g.). Will see that after release.

michael knubben commented

2014-09-23 14:54:08 +02:00

Added subscriber: @michaelknubben

michael knubben commented

2014-09-23 14:54:08 +02:00

If it doesn't impact the speed of searching, this seems like a definite improvement!

Davis Sorenson commented

2014-09-24 12:04:47 +02:00

After investigating this, I don't think that performance is an issue.
I ran the attached performance test on all the addon author/name/description data, which runs the search a total of 20k times (10k with a findable search, 10k with a randomly generated string) and got the following result (I selected the worst-performing one):

$ python timer.py
('Searching 10k findable and 10k (probably) unfindable items takes:', 1.913896083831787, 'seconds')

After investigating this, I don't think that performance is an issue. I ran the attached performance test on all the addon author/name/description data, which runs the search a total of 20k times (10k with a findable search, 10k with a randomly generated string) and got the following result (I selected the worst-performing one): ``` $ python timer.py ('Searching 10k findable and 10k (probably) unfindable items takes:', 1.913896083831787, 'seconds') ``` [timer.py](https://archive.blender.org/developer/F111991/timer.py) [names.txt](https://archive.blender.org/developer/F111992/names.txt) [descriptions.txt](https://archive.blender.org/developer/F111993/descriptions.txt) [authors.txt](https://archive.blender.org/developer/F111994/authors.txt)

Bastien Montagne commented

2014-09-26 17:19:17 +02:00

Here is a quick cached implementation:
P147: (An Untitled Masterwork)

diff --git a/release/scripts/startup/bl_ui/space_userpref.py b/release/scripts/startup/bl_ui/space_userpref.py
index 59b842a..f4b9cd6 100644
--- a/release/scripts/startup/bl_ui/space_userpref.py
+++ b/release/scripts/startup/bl_ui/space_userpref.py
@@ -1171,6 +1171,10 @@ class USERPREF_PT_addons(Panel):
         'TESTING': 'MOD_EXPLODE',
         }
 
+    # Class var is not ideal (becomes useless in case more than one addons panel is used),
+    # but should be good enough in most cases!
+    _search_cache = ["", set()]
+
     @classmethod
     def poll(cls, context):
         userpref = context.user_preferences
@@ -1201,6 +1205,26 @@ class USERPREF_PT_addons(Panel):
         for l in lines[1:]:
             box.label(l)
 
+    def filter_search_addons(self, search, addons):
+        old_search, results = self._search_cache
+        if not search:
+            for addon in addons:
+                yield addon
+        elif old_search != search:
+            results.clear()
+            self._search_cache- [x] = search
+            for addon in addons:
+                mod, info = addon
+                if (search in info["name"].lower() or
+                    (info["author"] and search in info["author"].lower()) or
+                    (info["description"] and search in info["description"].lower())):
+                        results.add(mod.__name__)
+                        yield addon
+        else:
+            for addon in addons:
+                if addon- [x].__name__ in results:
+                    yield addon
+
     def draw(self, context):
         import os
         import addon_utils
@@ -1249,7 +1273,7 @@ class USERPREF_PT_addons(Panel):
         # initialized on demand
         user_addon_paths = []
 
-        for mod, info in addons:
+        for mod, info in self.filter_search_addons(search, addons):
             module_name = mod.__name__
 
             is_enabled = module_name in used_ext
@@ -1265,13 +1289,6 @@ class USERPREF_PT_addons(Panel):
                 (filter == "User" and (mod.__file__.startswith((scripts_addons_folder, userpref_addons_folder))))
                 ):
 
-                if search and search not in info["name"].lower():
-                    if info["author"]:
-                        if search not in info["author"].lower():
-                            continue
-                    else:
-                        continue
-
                 # Addon UI Code
                 col_box = col.column()
                 box = col_box.box()

About speed: cached is about ten times quicker than uncached (~0.12sec instead of 1.2sec for 10K here, with all addons) - and without description search, uncached search is about five times slower (~0.7 secs)... So caching is worth it!

However, not sure clas var is OK here… Campbell, what do you say?

Here is a quick cached implementation: [P147: (An Untitled Masterwork)](https://archive.blender.org/developer/P147.txt) ``` diff --git a/release/scripts/startup/bl_ui/space_userpref.py b/release/scripts/startup/bl_ui/space_userpref.py index 59b842a..f4b9cd6 100644 --- a/release/scripts/startup/bl_ui/space_userpref.py +++ b/release/scripts/startup/bl_ui/space_userpref.py @@ -1171,6 +1171,10 @@ class USERPREF_PT_addons(Panel): 'TESTING': 'MOD_EXPLODE', } + # Class var is not ideal (becomes useless in case more than one addons panel is used), + # but should be good enough in most cases! + _search_cache = ["", set()] + @classmethod def poll(cls, context): userpref = context.user_preferences @@ -1201,6 +1205,26 @@ class USERPREF_PT_addons(Panel): for l in lines[1:]: box.label(l) + def filter_search_addons(self, search, addons): + old_search, results = self._search_cache + if not search: + for addon in addons: + yield addon + elif old_search != search: + results.clear() + self._search_cache- [x] = search + for addon in addons: + mod, info = addon + if (search in info["name"].lower() or + (info["author"] and search in info["author"].lower()) or + (info["description"] and search in info["description"].lower())): + results.add(mod.__name__) + yield addon + else: + for addon in addons: + if addon- [x].__name__ in results: + yield addon + def draw(self, context): import os import addon_utils @@ -1249,7 +1273,7 @@ class USERPREF_PT_addons(Panel): # initialized on demand user_addon_paths = [] - for mod, info in addons: + for mod, info in self.filter_search_addons(search, addons): module_name = mod.__name__ is_enabled = module_name in used_ext @@ -1265,13 +1289,6 @@ class USERPREF_PT_addons(Panel): (filter == "User" and (mod.__file__.startswith((scripts_addons_folder, userpref_addons_folder)))) ): - if search and search not in info["name"].lower(): - if info["author"]: - if search not in info["author"].lower(): - continue - else: - continue - # Addon UI Code col_box = col.column() box = col_box.box() ``` About speed: cached is about ten times quicker than uncached (~0.12sec instead of 1.2sec for 10K here, with all addons) - and without description search, uncached search is about five times slower (~0.7 secs)... So caching is worth it! However, not sure clas var is OK here… Campbell, what do you say?

Campbell Barton commented

2014-09-28 16:47:33 +02:00

It makes sense to cache, but would be nice if we could throw away the cache too (when the UI is no longer active).

For this only - its not big deal, but rather each panel doesnt store cache for the entire blender session.

It could be made so the classes __del__ method can handle that, though at the moment IIRC the panel is created for each draw.

It makes sense to cache, but would be nice if we could throw away the cache too (when the UI is no longer active). For this only - its not big deal, but rather each panel doesnt store cache for the entire blender session. It could be made so the classes `__del__` method can handle that, though at the moment IIRC the panel is created for each draw.

Bastien Montagne commented

2014-09-30 15:18:57 +02:00

@Campbell yes, panels are recreated at each draw, that’s why I used the panel's class itself as storage… Not really good I know.

But anyway, I don't think we have any way to achieve a nice clearing of the cache currently, adding it to Space (if it was possible - afaik it is not currently) would not really solve it, since I think spaces are never freed once created (unless you close the related 'window', would work for userprefs, but…)?

@Campbell yes, panels are recreated at each draw, that’s why I used the panel's class itself as storage… Not really good I know. But anyway, I don't think we have any way to achieve a nice clearing of the cache currently, adding it to Space (if it was possible - afaik it is not currently) would not really solve it, since I think spaces are never freed once created (unless you close the related 'window', would work for userprefs, but…)?

Campbell Barton commented

2015-02-26 11:09:05 +01:00

I think its reasonable to have some way to free the cache at some point (when the window closes or the addons are navigated away from). but this means we have to add some way for the UI to handle cache.

We could look into a way to have some time-out which clears the cache, though currently Blender/Python thread stuff is risky business.

I think its reasonable to have some way to free the cache at some point (when the window closes or the addons are navigated away from). but this means we have to add some way for the UI to handle cache. We could look into a way to have some time-out which clears the cache, though currently Blender/Python thread stuff is risky business.

Campbell Barton commented

2016-02-25 23:37:44 +01:00

Changed status from 'Open' to: 'Archived'

Campbell Barton closed this issue

2016-02-25 23:37:44 +01:00

Campbell Barton commented

2016-02-25 23:37:44 +01:00

No response on this in a long time, closing.

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

Addons search also search addon description #27356