hans/Nominatim
1
0
Fork 1
mirror of https://github.com/osm-search/Nominatim.git synced 2026-02-16 15:47:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

initial configuration documentation

Browse Source
This commit is contained in:
Sarah Hoffmann
2023-08-20 10:42:33 +02:00
parent 75513a23a8
commit 399b04596e
1 changed files with 27 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
nominatim/config.py
View File

@@ -47,17 +47,22 @@ def flatten_config_list(content: Any, section: str = '') -> List[Any]:
class Configuration: class Configuration:
""" Load and manage the project configuration. """ The `Configuration` class wraps access to the local configuration
options as described in the [Configuration page](../customize/Settings.md).
Nominatim uses dotenv to configure the software. Configuration options Nominatim uses dotenv to configure the software. Configuration options
are resolved in the following order: are resolved in the following order:
* from the OS environment (or the dictionary given in `environ`) * from the OS environment (or the dictionary given in `environ`)
* from the .env file in the project directory of the installation * from the .env file in the project directory of the installation
* from the default installation in the configuration directory * from the default installation in the configuration directory
All Nominatim configuration options are prefixed with 'NOMINATIM_' to All Nominatim configuration options are prefixed with 'NOMINATIM_' to
avoid conflicts with other environment variables. avoid conflicts with other environment variables. All settings can
be accessed as properties of the class under the same name as the
setting but with the `NOMINATIM_` prefix removed. In addition, there
are accessor functions that convert the setting values to types
other than string.
""" """
def __init__(self, project_dir: Optional[Path], def __init__(self, project_dir: Optional[Path],
@@ -101,12 +106,29 @@ class Configuration:
""" Return the given configuration parameter as a boolean. """ Return the given configuration parameter as a boolean.
Values of '1', 'yes' and 'true' are accepted as truthy values, Values of '1', 'yes' and 'true' are accepted as truthy values,
everything else is interpreted as false. everything else is interpreted as false.
Parameters:
name: Name of the configuration parameter with the NOMINATIM_
prefix removed.
Returns:
`True` for values of '1', 'yes' and 'true', `False` otherwise.
""" """
return getattr(self, name).lower() in ('1', 'yes', 'true') return getattr(self, name).lower() in ('1', 'yes', 'true')
def get_int(self, name: str) -> int: def get_int(self, name: str) -> int:
""" Return the given configuration parameter as an int. """ Return the given configuration parameter as an int.
Parameters:
name: Name of the configuration parameter with the NOMINATIM_
prefix removed.
Returns:
The configuration value converted to int.
Raises:
ValueError: when the value is not a number.
""" """
try: try:
return int(getattr(self, name)) return int(getattr(self, name))