searxng/searx/plugins/time_zone.py
Markus Heiser e16b6cb148 [fix] JSON format: serialization of the result-types
The ``JSONEncoder`` (``format="json"``) must perform a conversion to the
built-in types for the ``msgspec.Struct``::

    if isinstance(o, msgspec.Struct):
        return msgspec.to_builtins(o)

The result types are already of type ``msgspec.Struct``, so they can be
converted into built-in types.

The field types (in the result type) that were not yet of type ``msgspec.Struct``
have been converted to::

    searx.weather.GeoLocation@dataclass -> msgspec.Struct
    searx.weather.DateTime              -> msgspec.Struct
    searx.weather.Temperature           -> msgspec.Struct
    searx.weather.PressureUnits         -> msgspec.Struct
    searx.weather.WindSpeed             -> msgspec.Struct
    searx.weather.RelativeHumidity      -> msgspec.Struct
    searx.weather.Compass               -> msgspec.Struct

BTW: Wherever it seemed sensible, the typing was also modernized in the modified
files.

Closes: https://github.com/searxng/searxng/issues/5250
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2025-10-01 07:13:10 +02:00

70 lines
2.3 KiB
Python

# SPDX-License-Identifier: AGPL-3.0-or-later
# pylint: disable=missing-module-docstring
import typing as t
import datetime
from flask_babel import gettext
from searx.result_types import EngineResults
from searx.weather import DateTime, GeoLocation
from . import Plugin, PluginInfo
if t.TYPE_CHECKING:
from searx.search import SearchWithPlugins
from searx.extended_types import SXNG_Request
from searx.plugins import PluginCfg
@t.final
class SXNGPlugin(Plugin):
"""Plugin to display the current time at different timezones (usually the
query city)."""
id: str = "time_zone"
keywords: list[str] = ["time", "timezone", "now", "clock", "timezones"]
def __init__(self, plg_cfg: "PluginCfg"):
super().__init__(plg_cfg)
self.info = PluginInfo(
id=self.id,
name=gettext("Timezones plugin"),
description=gettext("Display the current time on different time zones."),
preference_section="query",
examples=["time Berlin", "clock Los Angeles"],
)
def post_search(self, request: "SXNG_Request", search: "SearchWithPlugins") -> EngineResults:
"""The plugin uses the :py:obj:`searx.weather.GeoLocation` class, which
is already implemented in the context of weather forecasts, to determine
the time zone. The :py:obj:`searx.weather.DateTime` class is used for
the localized display of date and time."""
results = EngineResults()
if search.search_query.pageno > 1:
return results
# remove keywords from the query
query = search.search_query.query
query_parts = filter(lambda part: part.lower() not in self.keywords, query.split(" "))
search_term = " ".join(query_parts).strip()
if not search_term:
date_time = DateTime(datetime.datetime.now())
results.add(results.types.Answer(answer=date_time.l10n()))
return results
geo = GeoLocation.by_query(search_term=search_term)
if geo:
date_time = DateTime(datetime.datetime.now(tz=geo.zoneinfo))
tz_name = geo.timezone.replace('_', ' ')
results.add(
results.types.Answer(
answer=(f"{tz_name}:" f" {date_time.l10n()} ({date_time.datetime.strftime('%Z')})")
)
)
return results