nominatim/clicmd/args.py

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