X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/815e3cccf6840d935e5a708588700cca23b976e9..fa44f7bcb308bfe51cc68ad15c2e4574f2182a09:/nominatim/tools/exec_utils.py diff --git a/nominatim/tools/exec_utils.py b/nominatim/tools/exec_utils.py index a81a8d6b..610e2182 100644 --- a/nominatim/tools/exec_utils.py +++ b/nominatim/tools/exec_utils.py @@ -7,17 +7,22 @@ """ Helper functions for executing external programs. """ +from typing import Any, Union, Optional, Mapping, IO +from pathlib import Path import logging import subprocess import urllib.request as urlrequest from urllib.parse import urlencode +from nominatim.typing import StrPath from nominatim.version import version_str from nominatim.db.connection import get_pg_env LOG = logging.getLogger() -def run_legacy_script(script, *args, nominatim_env=None, throw_on_fail=False): +def run_legacy_script(script: StrPath, *args: Union[int, str], + nominatim_env: Any, + throw_on_fail: bool = False) -> int: """ Run a Nominatim PHP script with the given arguments. Returns the exit code of the script. If `throw_on_fail` is True @@ -40,8 +45,10 @@ def run_legacy_script(script, *args, nominatim_env=None, throw_on_fail=False): return proc.returncode -def run_api_script(endpoint, project_dir, extra_env=None, phpcgi_bin=None, - params=None): +def run_api_script(endpoint: str, project_dir: Path, + extra_env: Optional[Mapping[str, str]] = None, + phpcgi_bin: Optional[Path] = None, + params: Optional[Mapping[str, Any]] = None) -> int: """ Execute a Nominatim API function. The function needs a project directory that contains the website @@ -96,14 +103,14 @@ def run_api_script(endpoint, project_dir, extra_env=None, phpcgi_bin=None, return 0 -def run_php_server(server_address, base_dir): +def run_php_server(server_address: str, base_dir: StrPath) -> None: """ Run the built-in server from the given directory. """ subprocess.run(['/usr/bin/env', 'php', '-S', server_address], cwd=str(base_dir), check=True) -def run_osm2pgsql(options): +def run_osm2pgsql(options: Mapping[str, Any]) -> None: """ Run osm2pgsql with the given options. """ env = get_pg_env(options['dsn']) @@ -147,13 +154,14 @@ def run_osm2pgsql(options): env=env, check=True) -def get_url(url): +def get_url(url: str) -> str: """ Get the contents from the given URL and return it as a UTF-8 string. """ headers = {"User-Agent": f"Nominatim/{version_str()}"} try: - with urlrequest.urlopen(urlrequest.Request(url, headers=headers)) as response: + request = urlrequest.Request(url, headers=headers) + with urlrequest.urlopen(request) as response: # type: IO[bytes] return response.read().decode('utf-8') except Exception: LOG.fatal('Failed to load URL: %s', url)