mirror of
https://github.com/searxng/searxng.git
synced 2024-11-26 04:41:00 +00:00
[mod] clarify the difference of the default category and subgrouping
This PR does no functional change it is just an attempt to make more clear in the code, what a default category is and what a subcategory is. The previous name 'others' leads to confusion with the **category 'other'**. If a engine is not assigned to a category, the default is assigned:: DEFAULT_CATEGORY = 'other' If an engine has only one category and this category is shown as tab in the user interface, this engine has no further subgrouping:: NO_SUBGROUPING = 'without further subgrouping' Related: - https://github.com/searxng/searxng/issues/1604 - https://github.com/searxng/searxng/pull/1545 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
parent
f46d0584ef
commit
2ffd446e5c
8 changed files with 26 additions and 28 deletions
|
@ -45,7 +45,7 @@ ENGINE_DEFAULT_ARGS = {
|
|||
"about": {},
|
||||
}
|
||||
# set automatically when an engine does not have any tab category
|
||||
OTHER_CATEGORY = 'other'
|
||||
DEFAULT_CATEGORY = 'other'
|
||||
|
||||
|
||||
# Defaults for the namespace of an engine module, see :py:func:`load_engine`
|
||||
|
@ -132,7 +132,7 @@ def load_engine(engine_data: dict) -> Optional[Engine]:
|
|||
set_loggers(engine, engine_name)
|
||||
|
||||
if not any(cat in settings['categories_as_tabs'] for cat in engine.categories):
|
||||
engine.categories.append(OTHER_CATEGORY)
|
||||
engine.categories.append(DEFAULT_CATEGORY)
|
||||
|
||||
return engine
|
||||
|
||||
|
|
|
@ -36,7 +36,7 @@ about = {
|
|||
send_accept_language_header = True
|
||||
|
||||
# engine dependent config
|
||||
categories = ["others"]
|
||||
categories = ["weather"]
|
||||
URL = "https://duckduckgo.com/js/spice/forecast/{query}/{lang}"
|
||||
|
||||
|
||||
|
|
|
@ -15,7 +15,7 @@ about = {
|
|||
"results": "JSON",
|
||||
}
|
||||
|
||||
categories = ["others"]
|
||||
categories = ["weather"]
|
||||
|
||||
url = "https://wttr.in/{query}?format=j1&lang={lang}"
|
||||
|
||||
|
|
|
@ -17,7 +17,7 @@ from searx.enginelib import Engine
|
|||
from searx.plugins import Plugin
|
||||
from searx.locales import LOCALE_NAMES
|
||||
from searx.webutils import VALID_LANGUAGE_CODE
|
||||
from searx.engines import OTHER_CATEGORY
|
||||
from searx.engines import DEFAULT_CATEGORY
|
||||
|
||||
|
||||
COOKIE_MAX_AGE = 60 * 60 * 24 * 365 * 5 # 5 years
|
||||
|
@ -259,7 +259,7 @@ class EnginesSetting(BooleanChoices):
|
|||
choices = {}
|
||||
for engine in engines:
|
||||
for category in engine.categories:
|
||||
if not category in list(settings['categories_as_tabs'].keys()) + [OTHER_CATEGORY]:
|
||||
if not category in list(settings['categories_as_tabs'].keys()) + [DEFAULT_CATEGORY]:
|
||||
continue
|
||||
choices['{}__{}'.format(engine.name, category)] = not engine.disabled
|
||||
super().__init__(default_value, choices)
|
||||
|
|
|
@ -15,8 +15,8 @@ __all__ = [
|
|||
|
||||
CONSTANT_NAMES = {
|
||||
# Constants defined in other modules
|
||||
'DEFAULT_GROUP_NAME': webutils.DEFAULT_GROUP_NAME,
|
||||
'OTHER_CATEGORY': engines.OTHER_CATEGORY,
|
||||
'NO_SUBGROUPING': webutils.NO_SUBGROUPING,
|
||||
'DEFAULT_CATEGORY': engines.DEFAULT_CATEGORY,
|
||||
}
|
||||
|
||||
CATEGORY_NAMES = {
|
||||
|
|
|
@ -298,18 +298,18 @@
|
|||
<p>{{ _('Currently used search engines') }}</p>
|
||||
{{ tabs_open() }}
|
||||
{% set ns = namespace(checked=true) %}
|
||||
{% for categ in categories_as_tabs + [OTHER_CATEGORY] %}
|
||||
{% for categ in categories_as_tabs + [DEFAULT_CATEGORY] %}
|
||||
{{ tab_header('enginetab', 'category' + categ, _(categ), ns.checked )}}
|
||||
{% set ns.checked = false %}
|
||||
{% if categ == OTHER_CATEGORY %}
|
||||
<p>{{_('This tab does not show up for search results, but you can search the engines listed here via bangs.')}}</p>
|
||||
{% endif %}
|
||||
{% if categ == DEFAULT_CATEGORY %}
|
||||
<p>{{_('This tab dues not exists in the user interface, but you can search in these engines by its !bangs.')}} <a href="{{ url_for('info', pagename='search-syntax') }}">ⓘ</a></p>
|
||||
{% endif %}
|
||||
<div class="scrollx">
|
||||
<table class="striped table_engines">
|
||||
<tr>{{- "" -}}
|
||||
<th class="engine_checkbox">{{ _("Allow") }}</th>{{- "" -}}
|
||||
<th class="name">{{ _("Engine name") }}</th>{{- "" -}}
|
||||
<th class="shortcut">{{ _("Shortcut") }}</th>{{- "" -}}
|
||||
<th class="shortcut">{{ _("!bang") }}</th>{{- "" -}}
|
||||
<th>{{ _("Supports selected language") }}</th>{{- "" -}}
|
||||
<th>{{ _("SafeSearch") }}</th>{{- "" -}}
|
||||
<th>{{ _("Time range") }}</th>{{- "" -}}
|
||||
|
|
|
@ -63,7 +63,7 @@ from searx.settings_defaults import OUTPUT_FORMATS
|
|||
from searx.settings_loader import get_default_settings_path
|
||||
from searx.exceptions import SearxParameterException
|
||||
from searx.engines import (
|
||||
OTHER_CATEGORY,
|
||||
DEFAULT_CATEGORY,
|
||||
categories,
|
||||
engines,
|
||||
engine_shortcuts,
|
||||
|
@ -435,7 +435,7 @@ def render(template_name: str, **kwargs):
|
|||
kwargs['method'] = request.preferences.get_value('method')
|
||||
kwargs['categories_as_tabs'] = list(settings['categories_as_tabs'].keys())
|
||||
kwargs['categories'] = _get_enable_categories(categories.keys())
|
||||
kwargs['OTHER_CATEGORY'] = OTHER_CATEGORY
|
||||
kwargs['DEFAULT_CATEGORY'] = DEFAULT_CATEGORY
|
||||
|
||||
# i18n
|
||||
kwargs['sxng_locales'] = [l for l in sxng_locales if l[0] in settings['search']['languages']]
|
||||
|
|
|
@ -18,7 +18,7 @@ from codecs import getincrementalencoder
|
|||
from flask_babel import gettext, format_date
|
||||
|
||||
from searx import logger, settings
|
||||
from searx.engines import OTHER_CATEGORY
|
||||
from searx.engines import DEFAULT_CATEGORY
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from searx.enginelib import Engine
|
||||
|
@ -222,26 +222,24 @@ def is_flask_run_cmdline():
|
|||
return frames[-2].filename.endswith('flask/cli.py')
|
||||
|
||||
|
||||
DEFAULT_GROUP_NAME = 'others'
|
||||
NO_SUBGROUPING = 'without further subgrouping'
|
||||
|
||||
|
||||
def group_engines_in_tab(engines: Iterable[Engine]) -> List[Tuple[str, Iterable[Engine]]]:
|
||||
"""Groups an Iterable of engines by their first non tab category"""
|
||||
"""Groups an Iterable of engines by their first non tab category (first subgroup)"""
|
||||
|
||||
def get_group(eng):
|
||||
non_tab_categories = [
|
||||
c for c in eng.categories if c not in list(settings['categories_as_tabs'].keys()) + [OTHER_CATEGORY]
|
||||
]
|
||||
return non_tab_categories[0] if len(non_tab_categories) > 0 else DEFAULT_GROUP_NAME
|
||||
|
||||
groups = itertools.groupby(sorted(engines, key=get_group), get_group)
|
||||
def get_subgroup(eng):
|
||||
non_tab_categories = [c for c in eng.categories if c not in tabs + [DEFAULT_CATEGORY]]
|
||||
return non_tab_categories[0] if len(non_tab_categories) > 0 else NO_SUBGROUPING
|
||||
|
||||
def group_sort_key(group):
|
||||
return (group[0] == DEFAULT_GROUP_NAME, group[0].lower())
|
||||
|
||||
sorted_groups = sorted(((name, list(engines)) for name, engines in groups), key=group_sort_key)
|
||||
return (group[0] == NO_SUBGROUPING, group[0].lower())
|
||||
|
||||
def engine_sort_key(engine):
|
||||
return (engine.about.get('language', ''), engine.name)
|
||||
|
||||
tabs = list(settings['categories_as_tabs'].keys())
|
||||
subgroups = itertools.groupby(sorted(engines, key=get_subgroup), get_subgroup)
|
||||
sorted_groups = sorted(((name, list(engines)) for name, engines in subgroups), key=group_sort_key)
|
||||
|
||||
return [(groupname, sorted(engines, key=engine_sort_key)) for groupname, engines in sorted_groups]
|
||||
|
|
Loading…
Reference in a new issue