src/nominatim_db/clicmd/args.py

   1 # SPDX-License-Identifier: GPL-3.0-or-later
   2 #
   3 # This file is part of Nominatim. (https://nominatim.org)
   4 #
   5 # Copyright (C) 2025 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 """
   8 Provides custom functions over command-line arguments.
   9 """
  10 from typing import Optional, List, Dict, Any, Sequence, Tuple
  11 import argparse
  12 import logging
  13 from pathlib import Path
  14
  15 from ..errors import UsageError
  16 from ..config import Configuration
  17 from ..typing import Protocol
  18
  19
  20 LOG = logging.getLogger()
  21
  22
  23 class Subcommand(Protocol):
  24     """
  25     Interface to be implemented by classes implementing a CLI subcommand.
  26     """
  27
  28     def add_args(self, parser: argparse.ArgumentParser) -> None:
  29         """
  30         Fill the given parser for the subcommand with the appropriate
  31         parameters.
  32         """
  33
  34     def run(self, args: 'NominatimArgs') -> int:
  35         """
  36         Run the subcommand with the given parsed arguments.
  37         """
  38
  39
  40 class NominatimArgs:
  41     """ Customized namespace class for the nominatim command line tool
  42         to receive the command-line arguments.
  43     """
  44     # Basic environment set by root program.
  45     config: Configuration
  46     project_dir: Path
  47
  48     # Global switches
  49     version: bool
  50     subcommand: Optional[str]
  51     command: Subcommand
  52
  53     # Shared parameters
  54     osm2pgsql_cache: Optional[int]
  55     socket_timeout: int
  56
  57     # Arguments added to all subcommands.
  58     verbose: int
  59     threads: Optional[int]
  60
  61     # Arguments to 'add-data'
  62     file: Optional[str]
  63     diff: Optional[str]
  64     node: Optional[int]
  65     way: Optional[int]
  66     relation: Optional[int]
  67     tiger_data: Optional[str]
  68     use_main_api: bool
  69
  70     # Arguments to 'admin'
  71     warm: bool
  72     check_database: bool
  73     migrate: bool
  74     collect_os_info: bool
  75     clean_deleted: str
  76     analyse_indexing: bool
  77     target: Optional[str]
  78     osm_id: Optional[str]
  79     place_id: Optional[int]
  80
  81     # Arguments to 'import'
  82     osm_file: List[str]
  83     continue_at: Optional[str]
  84     reverse_only: bool
  85     no_partitions: bool
  86     no_updates: bool
  87     offline: bool
  88     ignore_errors: bool
  89     index_noanalyse: bool
  90     prepare_database: bool
  91
  92     # Arguments to 'index'
  93     boundaries_only: bool
  94     no_boundaries: bool
  95     minrank: int
  96     maxrank: int
  97
  98     # Arguments to 'export'
  99     output_type: str
 100     output_format: str
 101     output_all_postcodes: bool
 102     language: Optional[str]
 103     restrict_to_country: Optional[str]
 104
 105     # Arguments to 'convert'
 106     output: Path
 107
 108     # Arguments to 'refresh'
 109     postcodes: bool
 110     word_tokens: bool
 111     word_counts: bool
 112     address_levels: bool
 113     functions: bool
 114     wiki_data: bool
 115     secondary_importance: bool
 116     importance: bool
 117     website: bool
 118     diffs: bool
 119     enable_debug_statements: bool
 120     data_object: Sequence[Tuple[str, int]]
 121     data_area: Sequence[Tuple[str, int]]
 122
 123     # Arguments to 'replication'
 124     init: bool
 125     update_functions: bool
 126     check_for_updates: bool
 127     once: bool
 128     catch_up: bool
 129     do_index: bool
 130
 131     # Arguments to 'serve'
 132     server: str
 133     engine: str
 134
 135     # Arguments to 'special-phrases
 136     import_from_wiki: bool
 137     import_from_csv: Optional[str]
 138     no_replace: bool
 139     min: int
 140
 141     # Arguments to all query functions
 142     format: str
 143     list_formats: bool
 144     addressdetails: bool
 145     extratags: bool
 146     namedetails: bool
 147     lang: Optional[str]
 148     polygon_output: Optional[str]
 149     polygon_threshold: Optional[float]
 150
 151     # Arguments to 'search'
 152     query: Optional[str]
 153     amenity: Optional[str]
 154     street: Optional[str]
 155     city: Optional[str]
 156     county: Optional[str]
 157     state: Optional[str]
 158     country: Optional[str]
 159     postalcode: Optional[str]
 160     countrycodes: Optional[str]
 161     exclude_place_ids: Optional[str]
 162     limit: int
 163     viewbox: Optional[str]
 164     bounded: bool
 165     dedupe: bool
 166
 167     # Arguments to 'reverse'
 168     lat: float
 169     lon: float
 170     zoom: Optional[int]
 171     layers: Optional[Sequence[str]]
 172
 173     # Arguments to 'lookup'
 174     ids: Sequence[str]
 175
 176     # Arguments to 'details'
 177     object_class: Optional[str]
 178     linkedplaces: bool
 179     hierarchy: bool
 180     keywords: bool
 181     polygon_geojson: bool
 182     group_hierarchy: bool
 183
 184     def osm2pgsql_options(self, default_cache: int,
 185                           default_threads: int) -> Dict[str, Any]:
 186         """ Return the standard osm2pgsql options that can be derived
 187             from the command line arguments. The resulting dict can be
 188             further customized and then used in `run_osm2pgsql()`.
 189         """
 190         return dict(osm2pgsql=self.config.OSM2PGSQL_BINARY,
 191                     osm2pgsql_cache=self.osm2pgsql_cache or default_cache,
 192                     osm2pgsql_style=self.config.get_import_style_file(),
 193                     osm2pgsql_style_path=self.config.lib_dir.lua,
 194                     threads=self.threads or default_threads,
 195                     dsn=self.config.get_libpq_dsn(),
 196                     flatnode_file=str(self.config.get_path('FLATNODE_FILE') or ''),
 197                     tablespaces=dict(slim_data=self.config.TABLESPACE_OSM_DATA,
 198                                      slim_index=self.config.TABLESPACE_OSM_INDEX,
 199                                      main_data=self.config.TABLESPACE_PLACE_DATA,
 200                                      main_index=self.config.TABLESPACE_PLACE_INDEX
 201                                      )
 202                     )
 203
 204     def get_osm_file_list(self) -> Optional[List[Path]]:
 205         """ Return the --osm-file argument as a list of Paths or None
 206             if no argument was given. The function also checks if the files
 207             exist and raises a UsageError if one cannot be found.
 208         """
 209         if not self.osm_file:
 210             return None
 211
 212         files = [Path(f) for f in self.osm_file]
 213         for fname in files:
 214             if not fname.is_file():
 215                 LOG.fatal("OSM file '%s' does not exist.", fname)
 216                 raise UsageError('Cannot access file.')
 217
 218         return files