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 d00e6639da202ef15b7236a903b369c2c870d3b7..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,10 +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_detailed_place
+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.reverse import ReverseGeocoder
 from nominatim.api.types import PlaceRef, LookupDetails, AnyPoint, DataLayer

-from nominatim.api.results import DetailedResult, ReverseResult
+from nominatim.api.results import DetailedResult, ReverseResult, SearchResults

 
 
 class NominatimAPIAsync:
 
 
 class NominatimAPIAsync:


@@ -130,8 +130,8 @@ class NominatimAPIAsync:
         return status
 
 
         return status
 
 

-    async def lookup(self, place: PlaceRef,
-                     details: Optional[LookupDetails] = None) -> 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.


@@ -140,6 +140,19 @@ class NominatimAPIAsync:
             return await get_detailed_place(conn, place, details or LookupDetails())
 
 
             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]:
     async def reverse(self, coord: AnyPoint, max_rank: Optional[int] = None,
                       layer: Optional[DataLayer] = None,
                       details: Optional[LookupDetails] = None) -> Optional[ReverseResult]:


@@ -195,11 +208,20 @@ 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: Optional[LookupDetails] = None) -> 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,
 
 
     def reverse(self, coord: AnyPoint, max_rank: Optional[int] = None,