searx.weather.GeoLocation Class Reference

Public Member Functions
zoneinfo.ZoneInfo	zoneinfo (self)
	__str__ (self)
babel.Locale	locale (self)
"GeoLocation"	by_query (cls, str search_term)

Public Attributes
	timezone
	country_code

Protected Member Functions
dict[str, str]	_query_open_meteo (cls, str search_term)

Detailed Description

Minimal implementation of Geocoding.

Definition at line 123 of file weather.py.

Member Function Documentation

__str__()

searx.weather.GeoLocation.__str__

(

self

)

Definition at line 144 of file weather.py.

    def __str__(self):
        return self.name
 

References searx.engines.wikidata.WDAmountAttribute.name, searx.engines.wikidata.WDAttribute.name, searx.engines.wikidata.WDDateAttribute.name, searx.engines.wikidata.WDGeoAttribute.name, searx.engines.wikidata.WDLabelAttribute.name, searx.preferences.BooleanChoices.name, and searx.search.models.EngineRef.name.

_query_open_meteo()

dict[str, str] searx.weather.GeoLocation._query_open_meteo ( cls, str search_term )

protected

Definition at line 187 of file weather.py.

    def _query_open_meteo(cls, search_term: str) -> dict[str, str]:
        url = f"https://geocoding-api.open-meteo.com/v1/search?name={quote_plus(search_term)}"
        resp = network.get(url, timeout=3)
        if resp.status_code != 200:
            raise ValueError(f"unknown geo location: '{search_term}'")
        results = resp.json().get("results")
        if not results:
            raise ValueError(f"unknown geo location: '{search_term}'")
        location = results[0]
        return {field.name: location[field.name] for field in dataclasses.fields(cls)}
 
 

Referenced by by_query().

Here is the caller graph for this function:

by_query()

"GeoLocation" searx.weather.GeoLocation.by_query	(		cls,
		str	search_term )

Factory method to get a GeoLocation object by a search term.  If no
location can be determined for the search term, a :py:obj:`ValueError`
is thrown.

Definition at line 170 of file weather.py.

    def by_query(cls, search_term: str) -> "GeoLocation":
        """Factory method to get a GeoLocation object by a search term.  If no
        location can be determined for the search term, a :py:obj:`ValueError`
        is thrown.
        """
 
        ctx = "weather_geolocation_by_query"
        cache = get_WEATHER_DATA_CACHE()
        geo_props = cache.get(search_term, ctx=ctx)
 
        if not geo_props:
            geo_props = cls._query_open_meteo(search_term=search_term)
            cache.set(key=search_term, value=geo_props, expire=None, ctx=ctx)
 
        return cls(**geo_props)  # type: ignore
 

References _query_open_meteo(), and searx.weather.get_WEATHER_DATA_CACHE().

Here is the call graph for this function:

locale()

babel.Locale searx.weather.GeoLocation.locale

(

self

)

Definition at line 147 of file weather.py.

    def locale(self) -> babel.Locale:
 
        # by region of the search language
        sxng_tag = _get_sxng_locale_tag()
        if "-" in sxng_tag:
            locale = babel.Locale.parse(_get_sxng_locale_tag(), sep='-')
            return locale
 
        # by most popular language in the region (country code)
        for lang in babel.languages.get_official_languages(self.country_code):
            try:
                locale = babel.Locale.parse(f"{lang}_{self.country_code}")
                return locale
            except babel.UnknownLocaleError:
                continue
 
        # No locale could be determined.  This does not actually occur, but if
        # it does, the English language is used by default.  But not region US.
        # US has some units that are only used in US but not in the rest of the
        # world (e.g. °F instead of °C)
        return babel.Locale("en", territory="DE")
 

References searx.weather._get_sxng_locale_tag().

Here is the call graph for this function:

zoneinfo()

zoneinfo.ZoneInfo searx.weather.GeoLocation.zoneinfo

(

self

)

Definition at line 141 of file weather.py.

    def zoneinfo(self) -> zoneinfo.ZoneInfo:
        return zoneinfo.ZoneInfo(self.timezone)
 

Member Data Documentation

country_code

searx.weather.GeoLocation.country_code

Definition at line 156 of file weather.py.

timezone

searx.weather.GeoLocation.timezone

Definition at line 142 of file weather.py.

---

The documentation for this class was generated from the following file:

• /home/andrew/Documents/code/public/searxng/searx/weather.py