src/nominatim_db/version.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) 2024 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 """
   8 Version information for Nominatim.
   9 """
  10 from typing import NamedTuple, Optional
  11
  12
  13 class NominatimVersion(NamedTuple):
  14     """ Version information for Nominatim. We follow semantic versioning.
  15
  16         Major, minor and patch_level refer to the last released version.
  17         The database patch level tracks important changes between releases
  18         and must always be increased when there is a change to the database or code
  19         that requires a migration.
  20
  21         When adding a migration on the development branch, raise the patch level
  22         to 99 to make sure that the migration is applied when updating from a
  23         patch release to the next minor version. Patch releases usually shouldn't
  24         have migrations in them. When they are needed, then make sure that the
  25         migration can be reapplied and set the migration version to the appropriate
  26         patch level when cherry-picking the commit with the migration.
  27     """
  28
  29     major: int
  30     minor: int
  31     patch_level: int
  32     db_patch_level: int
  33
  34     def __str__(self) -> str:
  35         if self.db_patch_level is None:
  36             return f"{self.major}.{self.minor}.{self.patch_level}"
  37
  38         return f"{self.major}.{self.minor}.{self.patch_level}-{self.db_patch_level}"
  39
  40     def release_version(self) -> str:
  41         """ Return the release version in semantic versioning format.
  42
  43             The release version does not include the database patch version.
  44         """
  45         return f"{self.major}.{self.minor}.{self.patch_level}"
  46
  47
  48 def parse_version(version: str) -> NominatimVersion:
  49     """ Parse a version string into a version consisting of a tuple of
  50         four ints: major, minor, patch level, database patch level
  51
  52         This is the reverse operation of `version_str()`.
  53     """
  54     parts = version.split('.')
  55     return NominatimVersion(*[int(x) for x in parts[:2] + parts[2].split('-')])
  56
  57
  58 NOMINATIM_VERSION = parse_version('4.5.0-0')
  59
  60 POSTGRESQL_REQUIRED_VERSION = (12, 0)
  61 POSTGIS_REQUIRED_VERSION = (3, 0)
  62 OSM2PGSQL_REQUIRED_VERSION = (1, 8)
  63
  64 # Cmake sets a variable @GIT_HASH@ by executing 'git --log'. It is not run
  65 # on every execution of 'make'.
  66 # cmake/tool-installed.tmpl is used to build the binary 'nominatim'. Inside
  67 # there is a call to set the variable value below.
  68 GIT_COMMIT_HASH: Optional[str] = None