X-Git-Url: https://git.openstreetmap.org/nominatim.git/blobdiff_plain/c42273a4db2d7b4fe05a0be9210901d35e038887..886374d7790aece685fdf85ff04ea2c63af31e52:/nominatim/api/types.py?ds=sidebyside diff --git a/nominatim/api/types.py b/nominatim/api/types.py index ff7457ec..43e83c1f 100644 --- a/nominatim/api/types.py +++ b/nominatim/api/types.py @@ -14,6 +14,7 @@ import dataclasses import enum import math from struct import unpack +from binascii import unhexlify from nominatim.errors import UsageError @@ -70,11 +71,13 @@ class Point(NamedTuple): @staticmethod - def from_wkb(wkb: bytes) -> 'Point': + def from_wkb(wkb: Union[str, bytes]) -> 'Point': """ Create a point from EWKB as returned from the database. """ + if isinstance(wkb, str): + wkb = unhexlify(wkb) if len(wkb) != 25: - raise ValueError("Point wkb has unexpected length") + raise ValueError(f"Point wkb has unexpected length {len(wkb)}") if wkb[0] == 0: gtype, srid, x, y = unpack('>iidd', wkb[1:]) elif wkb[0] == 1: @@ -119,6 +122,12 @@ class Point(NamedTuple): return Point(x, y) + def to_wkt(self) -> str: + """ Return the WKT representation of the point. + """ + return f'POINT({self.x} {self.y})' + + AnyPoint = Union[Point, Tuple[float, float]] @@ -163,20 +172,39 @@ class Bbox: return self.coords[2] + @property + def area(self) -> float: + """ Return the area of the box in WGS84. + """ + return (self.coords[2] - self.coords[0]) * (self.coords[3] - self.coords[1]) + + def contains(self, pt: Point) -> bool: """ Check if the point is inside or on the boundary of the box. """ return self.coords[0] <= pt[0] and self.coords[1] <= pt[1]\ and self.coords[2] >= pt[0] and self.coords[3] >= pt[1] + + def to_wkt(self) -> str: + """ Return the WKT representation of the Bbox. This + is a simple polygon with four points. + """ + return 'POLYGON(({0} {1},{0} {3},{2} {3},{2} {1},{0} {1}))'\ + .format(*self.coords) # pylint: disable=consider-using-f-string + + @staticmethod - def from_wkb(wkb: Optional[bytes]) -> 'Optional[Bbox]': + def from_wkb(wkb: Union[None, str, bytes]) -> 'Optional[Bbox]': """ Create a Bbox from a bounding box polygon as returned by the database. Return s None if the input value is None. """ if wkb is None: return None + if isinstance(wkb, str): + wkb = unhexlify(wkb) + if len(wkb) != 97: raise ValueError("WKB must be a bounding box polygon") if wkb.startswith(WKB_BBOX_HEADER_LE): @@ -273,16 +301,17 @@ def format_excluded(ids: Any) -> List[int]: """ plist: Sequence[str] if isinstance(ids, str): - plist = ids.split(',') + plist = [s.strip() for s in ids.split(',')] elif isinstance(ids, abc.Sequence): plist = ids else: raise UsageError("Parameter 'excluded' needs to be a comma-separated list " "or a Python list of numbers.") - if any(not isinstance(i, int) or (isinstance(i, str) and not i.isdigit()) for i in plist): + if not all(isinstance(i, int) or + (isinstance(i, str) and (not i or i.isdigit())) for i in plist): raise UsageError("Parameter 'excluded' only takes place IDs.") - return [int(id) for id in plist if id] + return [int(id) for id in plist if id] or [0] def format_categories(categories: List[Tuple[str, str]]) -> List[Tuple[str, str]]: @@ -377,7 +406,8 @@ class SearchDetails(LookupDetails): ) """ Highest address rank to return. """ - layers: Optional[DataLayer] = None + layers: Optional[DataLayer] = dataclasses.field(default=None, + metadata={'transform': lambda r : r}) """ Filter which kind of data to include. When 'None' (the default) then filtering by layers is disabled. """ @@ -404,7 +434,8 @@ class SearchDetails(LookupDetails): metadata={'transform': Point.from_param}) """ Order results by distance to the given point. """ - near_radius: Optional[float] = None + near_radius: Optional[float] = dataclasses.field(default=None, + metadata={'transform': lambda r : r}) """ Use near point as a filter and drop results outside the given radius. Radius is given in degrees WSG84. """ @@ -413,12 +444,13 @@ class SearchDetails(LookupDetails): """ Restrict search to places with one of the given class/type categories. An empty list (the default) will disable this filter. """ + viewbox_x2: Optional[Bbox] = None def __post_init__(self) -> None: if self.viewbox is not None: xext = (self.viewbox.maxlon - self.viewbox.minlon)/2 yext = (self.viewbox.maxlat - self.viewbox.minlat)/2 - self.viewbox_x2 = Bbox(self.viewbox.minlon - xext, self.viewbox.maxlon - yext, + self.viewbox_x2 = Bbox(self.viewbox.minlon - xext, self.viewbox.minlat - yext, self.viewbox.maxlon + xext, self.viewbox.maxlat + yext)