Classes
class	Compass
class	DateTime
class	GeoLocation
class	Pressure
class	RelativeHumidity
class	Temperature
class	WindSpeed

Functions
	get_WEATHER_DATA_CACHE ()
str	_get_sxng_locale_tag ()
str\|None	symbol_url ("WeatherConditionType" condition)

Variables
list	__all__
ExpireCache	WEATHER_DATA_CACHE = None
str	YR_WEATHER_SYMBOL_URL = "https://raw.githubusercontent.com/nrkno/yr-weather-symbols/refs/heads/master/symbols/outline"
	DateTimeFormats = typing.Literal["full", "long", "medium", "short"]
	DateTimeLocaleTypes = typing.Literal["UI"]
	WeatherConditionType
dict	YR_WEATHER_SYMBOL_MAP
	condition
	_cache = get_WEATHER_DATA_CACHE()
str	title = "cached weather condition symbols"

Detailed Description

Implementations used for weather conditions and forecast.

Function Documentation

◆ _get_sxng_locale_tag()

str searx.weather._get_sxng_locale_tag ( )

protected

Definition at line 58 of file weather.py.

def _get_sxng_locale_tag() -> str:
    # The function should return a locale (the sxng-tag: de-DE.en-US, ..) that
    # can later be used to format and convert measured values for the output of
    # weather data to the user.
    #
    # In principle, SearXNG only has two possible parameters for determining
    # the locale: the UI language or the search- language/region.  Since the
    # conversion of weather data and time information is usually
    # region-specific, the UI language is not suitable.
    #
    # It would probably be ideal to use the user's geolocation, but this will
    # probably never be available in SearXNG (privacy critical).
    #
    # Therefore, as long as no "better" parameters are available, this function
    # returns a locale based on the search region.
 
    # pylint: disable=import-outside-toplevel,disable=cyclic-import
    from searx import query
    from searx.preferences import ClientPref
 
    query = query.RawTextQuery(sxng_request.form.get("q", ""), [])
    if query.languages and query.languages[0] not in ["all", "auto"]:
        return query.languages[0]
 
    search_lang = sxng_request.form.get("language")
    if search_lang and search_lang not in ["all", "auto"]:
        return search_lang
 
    client_pref = ClientPref.from_http_request(sxng_request)
    search_lang = client_pref.locale_tag
    if search_lang and search_lang not in ["all", "auto"]:
        return search_lang
    return "en"
 
 

Referenced by searx.weather.Compass.l10n(), searx.weather.DateTime.l10n(), searx.weather.Pressure.l10n(), searx.weather.RelativeHumidity.l10n(), searx.weather.Temperature.l10n(), searx.weather.WindSpeed.l10n(), searx.weather.DateTime.l10n_date(), and searx.weather.GeoLocation.locale().

Here is the caller graph for this function:

◆ get_WEATHER_DATA_CACHE()

searx.weather.get_WEATHER_DATA_CACHE ( )

Definition at line 43 of file weather.py.

def get_WEATHER_DATA_CACHE():
 
    global WEATHER_DATA_CACHE  # pylint: disable=global-statement
 
    if WEATHER_DATA_CACHE is None:
        WEATHER_DATA_CACHE = ExpireCache.build_cache(
            ExpireCacheCfg(
                name="WEATHER_DATA_CACHE",
                MAX_VALUE_LEN=1024 * 200,  # max. 200kB per icon (icons have most often 10-20kB)
                MAXHOLD_TIME=60 * 60 * 24 * 7 * 4,  # 4 weeks
            )
        )
    return WEATHER_DATA_CACHE
 
 

Referenced by searx.weather.GeoLocation.by_query(), and symbol_url().

Here is the caller graph for this function:

◆ symbol_url()

str | None searx.weather.symbol_url ( "WeatherConditionType" condition )

Returns ``data:`` URL for the weather condition symbol or ``None`` if
the condition is not of type :py:obj:`WeatherConditionType`.

If symbol (SVG) is not already in the :py:obj:`WEATHER_DATA_CACHE` its
fetched from https://github.com/nrkno/yr-weather-symbols

Definition at line 93 of file weather.py.

def symbol_url(condition: "WeatherConditionType") -> str | None:
    """Returns ``data:`` URL for the weather condition symbol or ``None`` if
    the condition is not of type :py:obj:`WeatherConditionType`.
 
    If symbol (SVG) is not already in the :py:obj:`WEATHER_DATA_CACHE` its
    fetched from https://github.com/nrkno/yr-weather-symbols
    """
    # Symbols for darkmode/lightmode? .. and day/night symbols? .. for the
    # latter we need a geopoint (critical in sense of privacy)
 
    fname = YR_WEATHER_SYMBOL_MAP.get(condition)
    if fname is None:
        return None
 
    ctx = "weather_symbol_url"
    cache = get_WEATHER_DATA_CACHE()
    origin_url = f"{YR_WEATHER_SYMBOL_URL}/{fname}.svg"
 
    data_url = cache.get(origin_url, ctx=ctx)
    if data_url is not None:
        return data_url
 
    response = network.get(origin_url, timeout=3)
    if response.status_code == 200:
        mimetype = response.headers['Content-Type']
        data_url = f"data:{mimetype};base64,{str(base64.b64encode(response.content), 'utf-8')}"
        cache.set(key=origin_url, value=data_url, expire=None, ctx=ctx)
    return data_url
 
 
@dataclasses.dataclass

References get_WEATHER_DATA_CACHE().

Here is the call graph for this function:

Variable Documentation

◆ all

list searx.weather.__all__

private

Initial value:

=  [
    "symbol_url",
    "Temperature",
    "Pressure",
    "WindSpeed",
    "RelativeHumidity",
    "Compass",
    "WeatherConditionType",
    "DateTime",
    "GeoLocation",
]

Definition at line 5 of file weather.py.

◆ _cache

searx.weather._cache = get_WEATHER_DATA_CACHE()

protected

Definition at line 638 of file weather.py.

◆ condition

searx.weather.condition

Definition at line 636 of file weather.py.

◆ DateTimeFormats

searx.weather.DateTimeFormats = typing.Literal["full", "long", "medium", "short"]

Definition at line 200 of file weather.py.

◆ DateTimeLocaleTypes

searx.weather.DateTimeLocaleTypes = typing.Literal["UI"]

Definition at line 201 of file weather.py.

◆ title

str searx.weather.title = "cached weather condition symbols"

Definition at line 639 of file weather.py.

◆ WEATHER_DATA_CACHE

ExpireCache searx.weather.WEATHER_DATA_CACHE = None

Definition at line 37 of file weather.py.

◆ WeatherConditionType

searx.weather.WeatherConditionType

Definition at line 517 of file weather.py.

◆ YR_WEATHER_SYMBOL_MAP

dict searx.weather.YR_WEATHER_SYMBOL_MAP

Definition at line 575 of file weather.py.

◆ YR_WEATHER_SYMBOL_URL

str searx.weather.YR_WEATHER_SYMBOL_URL = "https://raw.githubusercontent.com/nrkno/yr-weather-symbols/refs/heads/master/symbols/outline"

Definition at line 40 of file weather.py.

Classes

Functions

Variables