rename lookup() API to details and add lookup call

[nominatim.git] / nominatim / api / core.py

diff --git a/nominatim/api/core.py b/nominatim/api/core.py
index c94b5ecb1c4edf18bb376959d21a1324ede5dfe8..29325b08089603106cb6dfae44dd731ae0908727 100644 (file)
--- a/nominatim/api/core.py
+++ b/nominatim/api/core.py
@@ -7,7 +7,7 @@
 """
 Implementation of classes for API access via libraries.
 """
 """
 Implementation of classes for API access via libraries.
 """

-from typing import Mapping, Optional, Any, AsyncIterator, Dict
+from typing import Mapping, Optional, Any, AsyncIterator, Dict, Sequence

 import asyncio
 import contextlib
 from pathlib import Path
 import asyncio
 import contextlib
 from pathlib import Path


@@ -20,9 +20,10 @@ from nominatim.db.sqlalchemy_schema import SearchTables
 from nominatim.config import Configuration
 from nominatim.api.connection import SearchConnection
 from nominatim.api.status import get_status, StatusResult
 from nominatim.config import Configuration
 from nominatim.api.connection import SearchConnection
 from nominatim.api.status import get_status, StatusResult

-from nominatim.api.lookup import get_place_by_id
-from nominatim.api.types import PlaceRef, LookupDetails
-from nominatim.api.results import DetailedResult
+from nominatim.api.lookup import get_detailed_place, get_simple_place
+from nominatim.api.reverse import ReverseGeocoder
+from nominatim.api.types import PlaceRef, LookupDetails, AnyPoint, DataLayer
+from nominatim.api.results import DetailedResult, ReverseResult, SearchResults

 
 
 class NominatimAPIAsync:
 
 
 class NominatimAPIAsync:


@@ -52,13 +53,16 @@ class NominatimAPIAsync:
 
             dsn = self.config.get_database_params()
 
 
             dsn = self.config.get_database_params()
 

+            query = {k: v for k, v in dsn.items()
+                      if k not in ('user', 'password', 'dbname', 'host', 'port')}
+            query['prepared_statement_cache_size'] = '0'
+

             dburl = sa.engine.URL.create(
                        'postgresql+asyncpg',
                        database=dsn.get('dbname'),
                        username=dsn.get('user'), password=dsn.get('password'),
                        host=dsn.get('host'), port=int(dsn['port']) if 'port' in dsn else None,
             dburl = sa.engine.URL.create(
                        'postgresql+asyncpg',
                        database=dsn.get('dbname'),
                        username=dsn.get('user'), password=dsn.get('password'),
                        host=dsn.get('host'), port=int(dsn['port']) if 'port' in dsn else None,

-                       query={k: v for k, v in dsn.items()
-                              if k not in ('user', 'password', 'dbname', 'host', 'port')})
+                       query=query)

             engine = sa_asyncio.create_async_engine(
                              dburl, future=True,
                              connect_args={'server_settings': {
             engine = sa_asyncio.create_async_engine(
                              dburl, future=True,
                              connect_args={'server_settings': {


@@ -126,14 +130,51 @@ class NominatimAPIAsync:
         return status
 
 
         return status
 
 

-    async def lookup(self, place: PlaceRef,
-                     details: LookupDetails) -> Optional[DetailedResult]:
+    async def details(self, place: PlaceRef,
+                      details: Optional[LookupDetails] = None) -> Optional[DetailedResult]:

         """ Get detailed information about a place in the database.
 
             Returns None if there is no entry under the given ID.
         """
         """ Get detailed information about a place in the database.
 
             Returns None if there is no entry under the given ID.
         """

-        async with self.begin() as db:
-            return await get_place_by_id(db, place, details)
+        async with self.begin() as conn:
+            return await get_detailed_place(conn, place, details or LookupDetails())
+
+
+    async def lookup(self, places: Sequence[PlaceRef],
+                      details: Optional[LookupDetails] = None) -> SearchResults:
+        """ Get simple information about a list of places.
+
+            Returns a list of place information for all IDs that were found.
+        """
+        if details is None:
+            details = LookupDetails()
+        async with self.begin() as conn:
+            return SearchResults(filter(None,
+                                        [await get_simple_place(conn, p, details) for p in places]))
+
+
+    async def reverse(self, coord: AnyPoint, max_rank: Optional[int] = None,
+                      layer: Optional[DataLayer] = None,
+                      details: Optional[LookupDetails] = None) -> Optional[ReverseResult]:
+        """ Find a place by its coordinates. Also known as reverse geocoding.
+
+            Returns the closest result that can be found or None if
+            no place matches the given criteria.
+        """
+        # The following negation handles NaN correctly. Don't change.
+        if not abs(coord[0]) <= 180 or not abs(coord[1]) <= 90:
+            # There are no results to be expected outside valid coordinates.
+            return None
+
+        if layer is None:
+            layer = DataLayer.ADDRESS | DataLayer.POI
+
+        max_rank = max(0, min(max_rank or 30, 30))
+
+        async with self.begin() as conn:
+            geocoder = ReverseGeocoder(conn, max_rank, layer,
+                                       details or LookupDetails())
+            return await geocoder.lookup(coord)

 
 
 class NominatimAPI:
 
 
 class NominatimAPI:


@@ -167,8 +208,29 @@ class NominatimAPI:
         return self._loop.run_until_complete(self._async_api.status())
 
 
         return self._loop.run_until_complete(self._async_api.status())
 
 

-    def lookup(self, place: PlaceRef,
-               details: LookupDetails) -> Optional[DetailedResult]:
+    def details(self, place: PlaceRef,
+                details: Optional[LookupDetails] = None) -> Optional[DetailedResult]:

         """ Get detailed information about a place in the database.
         """
         """ Get detailed information about a place in the database.
         """

-        return self._loop.run_until_complete(self._async_api.lookup(place, details))
+        return self._loop.run_until_complete(self._async_api.details(place, details))
+
+
+    def lookup(self, places: Sequence[PlaceRef],
+               details: Optional[LookupDetails] = None) -> SearchResults:
+        """ Get simple information about a list of places.
+
+            Returns a list of place information for all IDs that were found.
+        """
+        return self._loop.run_until_complete(self._async_api.lookup(places, details))
+
+
+    def reverse(self, coord: AnyPoint, max_rank: Optional[int] = None,
+                layer: Optional[DataLayer] = None,
+                details: Optional[LookupDetails] = None) -> Optional[ReverseResult]:
+        """ Find a place by its coordinates. Also known as reverse geocoding.
+
+            Returns the closest result that can be found or None if
+            no place matches the given criteria.
+        """
+        return self._loop.run_until_complete(
+                   self._async_api.reverse(coord, max_rank, layer, details))