merge 21447: closes #21447

[arvados.git] / sdk / python / arvados / config.py

diff --git a/sdk/python/arvados/config.py b/sdk/python/arvados/config.py
index ea45a48813395851acd878f815562d7ff7408842..9b2483bcfe972d056f0fb91eb31c169cd8128dd9 100644 (file)
--- a/sdk/python/arvados/config.py
+++ b/sdk/python/arvados/config.py
@@ -1,3 +1,7 @@
+# Copyright (C) The Arvados Authors. All rights reserved.
+#
+# SPDX-License-Identifier: Apache-2.0
+

 # config.py - configuration settings and global variables for Arvados clients
 #
 # Arvados configuration settings are taken from $HOME/.config/arvados.
 # config.py - configuration settings and global variables for Arvados clients
 #
 # Arvados configuration settings are taken from $HOME/.config/arvados.


@@ -6,30 +10,63 @@
 import os
 import re
 
 import os
 import re
 

+from typing import (
+    Callable,
+    Iterable,
+    Union,
+)
+
+from . import util
+

 _settings = None
 _settings = None

-if os.environ.get('HOME') != None:
-    default_config_file = os.environ['HOME'] + '/.config/arvados/settings.conf'
-else:
-    default_config_file = ''
+default_config_file = ''
+""".. WARNING: Deprecated
+   Default configuration initialization now searches for the "default"
+   configuration in several places. This value no longer has any effect.
+"""

 
 

+KEEP_BLOCK_SIZE = 2**26

 EMPTY_BLOCK_LOCATOR = 'd41d8cd98f00b204e9800998ecf8427e+0'
 
 EMPTY_BLOCK_LOCATOR = 'd41d8cd98f00b204e9800998ecf8427e+0'
 

-def initialize(config_file=default_config_file):
+def initialize(
+        config_file: Union[
+            str,
+            os.PathLike,
+            Callable[[str], Iterable[os.PathLike]],
+        ]=util._BaseDirectories('CONFIG').search,
+) -> None:

     global _settings
     _settings = {}
     global _settings
     _settings = {}

-    if os.path.exists(config_file):
-        with open(config_file, "r") as f:
-            for config_line in f:
-                if re.match('^\s*#', config_line):
-                    continue
-                var, val = config_line.rstrip().split('=', 2)
-                _settings[var] = val
+
+    if callable(config_file):
+        search_paths = iter(config_file('settings.conf'))
+        config_file = next(search_paths, '')
+
+    # load the specified config file if available
+    try:
+        _settings = load(config_file)
+    except IOError:
+        pass
+
+    # override any settings with environment vars

     for var in os.environ:
         if var.startswith('ARVADOS_'):
             _settings[var] = os.environ[var]
 
     for var in os.environ:
         if var.startswith('ARVADOS_'):
             _settings[var] = os.environ[var]
 

-def flag_is_true(key):
-    return get(key, '').lower() in set(['1', 't', 'true', 'y', 'yes'])
+def load(config_file):
+    cfg = {}
+    with open(config_file, "r") as f:
+        for config_line in f:
+            if re.match(r'^\s*(?:#|$)', config_line):
+                continue
+            var, val = config_line.rstrip().split('=', 2)
+            cfg[var] = val
+    return cfg
+
+def flag_is_true(key, d=None):
+    if d is None:
+        d = settings()
+    return d.get(key, '').lower() in set(['1', 't', 'true', 'y', 'yes'])

 
 def get(key, default_val=None):
     return settings().get(key, default_val)
 
 def get(key, default_val=None):
     return settings().get(key, default_val)