config2py 0.1.33__py3-none-any.whl → 0.1.35__py3-none-any.whl

config2py/base.py

@@ -19,14 +19,10 @@ from typing import (
 )
 from dataclasses import dataclass
 from functools import lru_cache, partial
-from i2 import mk_sentinel  # TODO: Only i2 dependency. Consider replacing.
 
-from config2py.util import always_true, ask_user_for_input
+from config2py.util import always_true, ask_user_for_input, no_default, not_found
 from config2py.errors import ConfigNotFound
 
-# def mk_sentinel(name):  # TODO: Only i2 dependency. Here's replacement, but not picklable
-#     return type(name, (), {'__repr__': lambda self: name})()
-
 Exceptions = Tuple[Type[Exception], ...]
 
 
@@ -95,9 +91,6 @@ GetConfigEgress = Callable[[KT, VT], VT]
 #     )
 # openai.api_key = _api_key
 
-config_not_found = mk_sentinel('config_not_found')
-no_default = mk_sentinel('no_default')
-
 
 def is_not_none_nor_empty(x):
     if isinstance(x, str):
@@ -111,8 +104,8 @@ def get_config(
     sources: Sources = None,
     *,
     default: VT = no_default,
-    egress: GetConfigEgress = None,
-    val_is_valid: Callable[[VT], bool] = always_true,
+    egress: Optional[GetConfigEgress] = None,
+    val_is_valid: Optional[Callable[[VT], bool]] = always_true,
     config_not_found_exceptions: Exceptions = (Exception,),
 ):
     """Get a config value from a list of sources
@@ -215,8 +208,8 @@ def get_config(
         get_config_.sources = sources
         return get_config_
     chain_map = sources_chainmap(sources, val_is_valid, config_not_found_exceptions)
-    value = chain_map.get(key, config_not_found)
-    if value is config_not_found:
+    value = chain_map.get(key, not_found)
+    if value is not_found:
         if default is no_default:
             raise ConfigNotFound(f'Could not find config for key: {key}')
         else:
@@ -290,12 +283,16 @@ class FuncBasedGettableContainer:
     getter: Callable[[KT], VT]
     val_is_valid: Callable[[VT], bool] = always_true
     config_not_found_exceptions: Exceptions = (Exception,)
+    cache_getter = False
 
     def __post_init__(self):
-        # Note: The only purpose of the cache is to avoid calling the getter function
-        # twice when doing a ``in`` check before doing a ``[]`` lookup, for instance,
-        # in a``collections.ChainMap``.
-        self.getter = lru_cache(maxsize=1)(self.getter)
+        if self.cache_getter:
+            # Note: The only purpose of the cache is to avoid calling the getter function
+            # twice when doing a ``in`` check before doing a ``[]`` lookup, for instance,
+            # in a``collections.ChainMap``.
+            # But this caching can lead to unexpected behavior if the getter function
+            # has side effects, or if the value it returns changes over time.
+            self.getter = lru_cache(maxsize=1)(self.getter)
 
     def __getitem__(self, k: KT) -> VT:
         try:
@@ -384,6 +381,7 @@ def ask_user_for_key(
             ask_user_for_key,
             prompt_template=prompt_template,
             save_to=save_to,
+            save_condition=save_condition,
             user_asker=user_asker,
             egress=egress,
         )
@@ -403,7 +401,7 @@ def user_gettable(
     prompt_template='Enter a value for {}: ',
     egress: Optional[Callable] = None,
     user_asker=ask_user_for_input,
-    val_is_valid: Callable[[VT], bool] = always_true,
+    val_is_valid: Callable[[VT], bool] = is_not_empty,
     config_not_found_exceptions: Exceptions = (Exception,),
 ):
     """

config2py/tests/test_tools.py

@@ -3,9 +3,11 @@
 import os
 from unittest.mock import patch
 
+import tempfile
 import pytest
 
 from config2py.tools import simple_config_getter, source_config_params
+from config2py.tests.utils_for_testing import user_input_patch
 
 
 @pytest.fixture
@@ -41,6 +43,48 @@ def test_simple_config_getter(mock_config_store_factory):
     # assert config_getter.configs is mock_config_store
 
 
+from functools import partial
+
+
+def test_simple_config_getter_with_user_input(monkeypatch):
+    user_inputs = partial(user_input_patch, monkeypatch)
+    local_config_dir = tempfile.mkdtemp()
+
+    # Note, at the time of writing this, the default is ask_user_if_key_not_found=None,
+    # which has the effect of NOT asking the user for a config value if we're not in
+    # a REPL (interactive mode). Therefore, the test worked in the notebook, but not here.
+    # So now, we're forcing ask_user_if_key_not_found=True
+    my_get_config = simple_config_getter(
+        local_config_dir, ask_user_if_key_not_found=True
+    )
+    config_name = 'SOME_CONFIG_NAME'
+
+    # make sure config_name not in environment or local_config_dir
+    assert config_name not in os.environ
+    assert config_name not in os.listdir(local_config_dir)
+
+    # since config_name doesn't exist, the following attempt to get this config
+    # should try to get it from the user
+
+    # Use monkeypatch to replace the input function with the mock_input function
+    user_inputs('')  # user enters nothing
+    val = my_get_config(config_name, default='default_value')
+
+    # This the user didn't enter anything, the default value should be returned:
+    assert val == 'default_value'
+
+    # Still no config_name in the local_config_dir
+    assert config_name not in os.listdir(local_config_dir)
+
+    user_inputs('user_value')  # user enters user_value
+    val = my_get_config(config_name, default='default_value')
+    # Now the user entered a value, so that value should be returned:
+    assert val == 'user_value'
+
+    # And now there's a config_name in the local_config_dir
+    assert config_name in os.listdir(local_config_dir)
+
+
 def test_source_config_params():
     @source_config_params('a', 'b')
     def foo(a, b, c):

config2py/tests/{util.py → test_util.py}

@@ -1,6 +1,7 @@
 import tempfile
 import os
 import pytest
+from config2py.util import process_path
 
 
 def test_process_path():

config2py/tests/utils_for_testing.py

@@ -0,0 +1,5 @@
+from functools import partial
+
+
+def user_input_patch(monkeypatch, user_input_string: str):
+    monkeypatch.setattr('builtins.input', lambda _: user_input_string)

config2py/tools.py

@@ -27,7 +27,7 @@ def get_configs_local_store(
         If it's a file, it's assumed to be an ini or cfg file.
         If it's a string, it's assumed to be an app name, from which to create a folder
     """
-    if os.path.isdir(config_src):
+    if os.path.sep in config_src and os.path.isdir(config_src):
         # TODO: This was a quick fix to avoid unknowingly making directories in the
         #   wrong place. Broke stuff so leaving this for later.
         # if os.path.sep not in config_src:
@@ -76,7 +76,7 @@ def simple_config_getter(
     default) asks the user for the value and stores it in the central config store.
 
     :param configs_src: A specification of the central config store. By default:
-        If it's a directory, it's assumed to be a folder of text files.
+        If it's a directory (with at least a slash), it's assumed to be a folder of text files.
         If it's a file, it's assumed to be an ini or cfg file.
         If it's a string, it's assumed to be an app name, from which to create a folder
     :param first_look_in_env_vars: Whether to look in environment variables first

config2py/util.py

@@ -7,9 +7,17 @@ from pathlib import Path
 from typing import Optional, Union, Any, Callable, Set, Iterable
 import getpass
 
+from i2 import mk_sentinel  # TODO: Only i2 dependency. Consider replacing.
+
+# def mk_sentinel(name):  # TODO: Only i2 dependency. Here's replacement, but not picklable
+#     return type(name, (), {'__repr__': lambda self: name})()
+
 DFLT_APP_NAME = 'config2py'
 DFLT_MASKING_INPUT = False
 
+not_found = mk_sentinel('not_found')
+no_default = mk_sentinel('no_default')
+
 
 def always_true(x: Any) -> bool:
     """Function that just returns True."""
@@ -29,7 +37,7 @@ def is_not_empty(x: Any) -> bool:
 # TODO: Make this into an open-closed mini-framework
 def ask_user_for_input(
     prompt: str,
-    default: str = None,
+    default: str = '',
     *,
     mask_input=DFLT_MASKING_INPUT,
     masking_toggle_str: str = None,
@@ -57,7 +65,7 @@ def ask_user_for_input(
             f"    (Input masking is {'ENABLED' if mask_input else 'DISABLED'}. "
             f"Enter '{masking_toggle_str}' (without quotes) to toggle input masking)\n"
         )
-    if default:
+    if default not in {''}:
         prompt = prompt + f' [{default}]: '
     if mask_input:
         _prompt_func = getpass.getpass
@@ -182,6 +190,8 @@ def process_path(
     ensure_endswith_slash=False,
     ensure_does_not_end_with_slash=False,
     expanduser=True,
+    expandvars=True,
+    abspath=True,
     rootdir: str = '',
 ) -> str:
     """
@@ -194,12 +204,15 @@ def process_path(
         ensure_endswith_slash (bool): Whether to ensure the path ends with a slash.
         ensure_does_not_end_with_slash (bool): Whether to ensure the path does not end with a slash.
         expanduser (bool): Whether to expand the user in the path.
+        expandvars (bool): Whether to expand environment variables in the path.
+        abspath (bool): Whether to convert the path to an absolute path.
+        rootdir (str): The root directory to prepend to the path.
 
     Returns:
         str: The processed path.
 
-    >>> process_path('a', 'b', 'c')
-    'a/b/c'
+    >>> process_path('a', 'b', 'c')  # doctest: +ELLIPSIS
+    '...a/b/c'
     >>> from functools import partial
     >>> process_path('a', 'b', 'c', rootdir='/root/dir/', ensure_endswith_slash=True)
     '/root/dir/a/b/c/'
@@ -214,6 +227,10 @@ def process_path(
         path = os.path.join(rootdir, path)
     if expanduser:
         path = os.path.expanduser(path)
+    if expandvars:
+        path = os.path.expandvars(path)
+    if abspath:
+        path = os.path.abspath(path)
     if ensure_endswith_slash:
         if not path.endswith('/'):
             path = path + '/'

{config2py-0.1.33.dist-info → config2py-0.1.35.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: config2py
-Version: 0.1.33
+Version: 0.1.35
 Summary: Simplified reading and writing configurations from various sources and formats
 Home-page: https://github.com/i2mint/config2py
 Author: OtoSense

config2py-0.1.35.dist-info/RECORD

@@ -0,0 +1,16 @@
+config2py/__init__.py,sha256=ru-bUQk5EuOLzHmNAcElSN8P2saSUEb5KFRkfTkzsUo,770
+config2py/base.py,sha256=fDKClGpgNecWFL9a7Y_FpqwuRxAAD_XCuByW68Yq5KE,15880
+config2py/errors.py,sha256=QdwGsoJhv6LHDHp-_yyz4oUg1Fgu4S-S7O2nuA0a5cw,203
+config2py/s_configparser.py,sha256=XhxFz6-PG4-QsecJfbjLFdBWHcPU6dwgqwkTZyY_y3E,15873
+config2py/tools.py,sha256=W2YQm-PerKRN8prsxVfcBCChx75pZ9H8UqWH8pGxECE,9191
+config2py/util.py,sha256=C9JiGlMcSQozq6H-nuaS02sh49i4irRzSVqofW9Bq74,16460
+config2py/scrap/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+config2py/tests/__init__.py,sha256=sk-yGJQOZES2z70M4xmZB57tsxSktX_84ybDuV8Cz5Q,297
+config2py/tests/test_tools.py,sha256=km9RNh-gDtSJNjYiLQdkWcRi9IB5MwpijD3U2XCyi1Y,3728
+config2py/tests/test_util.py,sha256=DNJn60dvyr7xb86Spoz_VDS4cwU2mtcRo1_MgoCrKCY,1391
+config2py/tests/utils_for_testing.py,sha256=Vz6EDY27uy_RZCSceZ7jqXkp_CXe52KAZSXcYKivazM,162
+config2py-0.1.35.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+config2py-0.1.35.dist-info/METADATA,sha256=LN--FD2SE3BMV8vAfAq5CUSaksGY5DbXKw8qyZagzbs,14559
+config2py-0.1.35.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+config2py-0.1.35.dist-info/top_level.txt,sha256=DFnlOIKMIGWQRROr3voJFhWFViHaWgTTeWZjC5YC9QQ,10
+config2py-0.1.35.dist-info/RECORD,,

config2py-0.1.33.dist-info/RECORD

@@ -1,15 +0,0 @@
-config2py/__init__.py,sha256=ru-bUQk5EuOLzHmNAcElSN8P2saSUEb5KFRkfTkzsUo,770
-config2py/base.py,sha256=saq1YVbeRg8jBoXcmc0y-maNJ5vHHeWwu5tc_EbOetE,15895
-config2py/errors.py,sha256=QdwGsoJhv6LHDHp-_yyz4oUg1Fgu4S-S7O2nuA0a5cw,203
-config2py/s_configparser.py,sha256=XhxFz6-PG4-QsecJfbjLFdBWHcPU6dwgqwkTZyY_y3E,15873
-config2py/tools.py,sha256=6wPAdnossxMPeQ6T0eqUilP3VnHAfbrJcFsg4xmaahA,9137
-config2py/util.py,sha256=mzIsU2ozkatWx61NphsbD502IrwuI2Vi0V8NEjpNRXQ,15745
-config2py/scrap/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-config2py/tests/__init__.py,sha256=sk-yGJQOZES2z70M4xmZB57tsxSktX_84ybDuV8Cz5Q,297
-config2py/tests/test_tools.py,sha256=T0rBy8s6wHgQXnnr7Z1xkF1so3XkdGVASerEQ27ByxE,1950
-config2py/tests/util.py,sha256=vO1VIepbH6vY2e-VHP7HX6jnVzzIDyFsp6md_uBnIXw,1351
-config2py-0.1.33.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-config2py-0.1.33.dist-info/METADATA,sha256=kg26LOTcSczZ0pjFwn6sHUtnJDPI6UO-Bhf8qDO0-2Q,14559
-config2py-0.1.33.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-config2py-0.1.33.dist-info/top_level.txt,sha256=DFnlOIKMIGWQRROr3voJFhWFViHaWgTTeWZjC5YC9QQ,10
-config2py-0.1.33.dist-info/RECORD,,