]> git.openstreetmap.org Git - nominatim.git/commitdiff
Merge pull request #3063 from lonvia/variable-parameters
authorSarah Hoffmann <lonvia@denofr.de>
Thu, 18 May 2023 20:27:18 +0000 (22:27 +0200)
committerGitHub <noreply@github.com>
Thu, 18 May 2023 20:27:18 +0000 (22:27 +0200)
Rework how search parameters are handed to the Python API

1  2 
nominatim/api/core.py

diff --combined nominatim/api/core.py
index 3e4b175a014408357881a197614dcbdda13d3069,b69946c5c048212e7b546ba61832d5a890a0a86e..f1a656da483eda6fecf3b5f2038b3c1806b38142
@@@ -14,16 -14,15 +14,16 @@@ from pathlib import Pat
  
  import sqlalchemy as sa
  import sqlalchemy.ext.asyncio as sa_asyncio
 -import asyncpg
 +
  
  from nominatim.db.sqlalchemy_schema import SearchTables
 +from nominatim.db.async_core_library import PGCORE_LIB, PGCORE_ERROR
  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, get_simple_place
  from nominatim.api.reverse import ReverseGeocoder
- from nominatim.api.types import PlaceRef, LookupDetails, AnyPoint, DataLayer
+ import nominatim.api.types as ntyp
  from nominatim.api.results import DetailedResult, ReverseResult, SearchResults
  
  
@@@ -56,22 -55,26 +56,22 @@@ class NominatimAPIAsync
  
              query = {k: v for k, v in dsn.items()
                        if k not in ('user', 'password', 'dbname', 'host', 'port')}
 -            query['prepared_statement_cache_size'] = '0'
 +            if PGCORE_LIB == 'asyncpg':
 +                query['prepared_statement_cache_size'] = '0'
  
              dburl = sa.engine.URL.create(
 -                       'postgresql+asyncpg',
 +                       f'postgresql+{PGCORE_LIB}',
                         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=query)
 -            engine = sa_asyncio.create_async_engine(
 -                             dburl, future=True,
 -                             connect_args={'server_settings': {
 -                                'DateStyle': 'sql,european',
 -                                'max_parallel_workers_per_gather': '0'
 -                             }})
 +            engine = sa_asyncio.create_async_engine(dburl, future=True)
  
              try:
                  async with engine.begin() as conn:
                      result = await conn.scalar(sa.text('SHOW server_version_num'))
                      server_version = int(result)
 -            except asyncpg.PostgresError:
 +            except (PGCORE_ERROR, sa.exc.OperationalError):
                  server_version = 0
  
              if server_version >= 110000:
@@@ -79,7 -82,6 +79,7 @@@
                  def _on_connect(dbapi_con: Any, _: Any) -> None:
                      cursor = dbapi_con.cursor()
                      cursor.execute("SET jit_above_cost TO '-1'")
 +                    cursor.execute("SET max_parallel_workers_per_gather TO '0'")
                  # Make sure that all connections get the new settings
                  await self.close()
  
          try:
              async with self.begin() as conn:
                  status = await get_status(conn)
 -        except asyncpg.PostgresError:
 +        except (PGCORE_ERROR, sa.exc.OperationalError):
              return StatusResult(700, 'Database connection failed')
  
          return status
  
  
-     async def details(self, place: PlaceRef,
-                       details: Optional[LookupDetails] = None) -> Optional[DetailedResult]:
+     async def details(self, place: ntyp.PlaceRef, **params: Any) -> Optional[DetailedResult]:
          """ 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 conn:
-             return await get_detailed_place(conn, place, details or LookupDetails())
+             return await get_detailed_place(conn, place,
+                                             ntyp.LookupDetails.from_kwargs(params))
  
  
-     async def lookup(self, places: Sequence[PlaceRef],
-                       details: Optional[LookupDetails] = None) -> SearchResults:
+     async def lookup(self, places: Sequence[ntyp.PlaceRef], **params: Any) -> 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()
+         details = ntyp.LookupDetails.from_kwargs(params)
          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: ntyp.AnyPoint, **params: Any) -> Optional[ReverseResult]:
          """ Find a place by its coordinates. Also known as reverse geocoding.
  
              Returns the closest result that can be found or None if
              # 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())
+             geocoder = ReverseGeocoder(conn, ntyp.ReverseDetails.from_kwargs(params))
              return await geocoder.lookup(coord)
  
  
@@@ -206,29 -198,24 +196,24 @@@ class NominatimAPI
          return self._loop.run_until_complete(self._async_api.status())
  
  
-     def details(self, place: PlaceRef,
-                 details: Optional[LookupDetails] = None) -> Optional[DetailedResult]:
+     def details(self, place: ntyp.PlaceRef, **params: Any) -> Optional[DetailedResult]:
          """ Get detailed information about a place in the database.
          """
-         return self._loop.run_until_complete(self._async_api.details(place, details))
+         return self._loop.run_until_complete(self._async_api.details(place, **params))
  
  
-     def lookup(self, places: Sequence[PlaceRef],
-                details: Optional[LookupDetails] = None) -> SearchResults:
+     def lookup(self, places: Sequence[ntyp.PlaceRef], **params: Any) -> 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))
+         return self._loop.run_until_complete(self._async_api.lookup(places, **params))
  
  
-     def reverse(self, coord: AnyPoint, max_rank: Optional[int] = None,
-                 layer: Optional[DataLayer] = None,
-                 details: Optional[LookupDetails] = None) -> Optional[ReverseResult]:
+     def reverse(self, coord: ntyp.AnyPoint, **params: Any) -> 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))
+         return self._loop.run_until_complete(self._async_api.reverse(coord, **params))