config2py 0.1.27__py3-none-any.whl → 0.1.29__py3-none-any.whl

config2py/__init__.py

@@ -18,4 +18,5 @@ from config2py.util import (
     get_configs_folder_for_app,
     is_repl,
     parse_assignments_from_py_source,
+    process_path,
 )

config2py/base.py

@@ -1,6 +1,7 @@
 """
 Base for getting configs from various sources and formats
 """
+
 from collections import ChainMap
 from typing import (
     Callable,
@@ -317,6 +318,15 @@ class FuncBasedGettableContainer:
         else:
             return True
 
+    def __iter__(self):
+        raise TypeError(
+            f'Iteration is NOT ACTUALLY implemented for {type(self).__name__}. '
+            'The reason we still stuck it in the class is because python will '
+            'automatically try to use __getitem__ on 0, 1, ... to iterate over the '
+            'object, and we want to avoid that, since this would result in an obscure '
+            "error message saying that the getter function can't be called on 0"
+        )
+
 
 def gettable_containers(
     sources: Sources,
@@ -353,11 +363,19 @@ KTSaver = Callable[[KT, VT], Any]
 SaveTo = Optional[Union[MutableMapping, KTSaver]]
 
 
+def is_not_empty(val) -> bool:
+    if isinstance(val, str):
+        return val != ''
+    else:
+        return val is not None
+
+
 def ask_user_for_key(
     key=None,
     *,
     prompt_template='Enter a value for {}: ',
     save_to: SaveTo = None,
+    save_condition=is_not_empty,
     user_asker=ask_user_for_input,
     egress: Optional[Callable] = None,
 ):
@@ -372,7 +390,7 @@ def ask_user_for_key(
     val = user_asker(prompt_template.format(key))
     if isinstance(egress, Callable):
         val = egress(key, val)
-    if save_to is not None:
+    if save_to is not None and save_condition(val):
         if hasattr(save_to, '__setitem__'):
             save_to_func = save_to.__setitem__
         save_to_func(key, val)
@@ -397,7 +415,7 @@ def user_gettable(
         contain a placeholder for the key, e.g. ``"Enter a value for {}: "``.
     :param egress: A function to apply to the user's response before returning it.
         This can be used to validate the response, for example.
-    :param user_asker: A function that asks the user for input. It should take a    
+    :param user_asker: A function that asks the user for input. It should take a
         prompt string and return the user's response.
     :param val_is_valid: A function that takes a value and returns a boolean. If it
         returns ``False``, the user will be asked for a new value.
@@ -408,7 +426,7 @@ def user_gettable(
         it.
 
     Example:
-    
+
     >>> s = user_gettable()
     >>> v = s['SOME_KEY']  # doctest: +SKIP
     'SOME_VAL'
@@ -416,8 +434,8 @@ def user_gettable(
     This will trigger a prompt for the user to enter the value of ``SOME_KEY``.
     When they do (say they entered 'SOME_VAL') it will return that value.
 
-    And if you specify a save_to store (usually a persistent MutableMapping made with 
-    the ``dol`` package) then it will save the value to that store for future use. 
+    And if you specify a save_to store (usually a persistent MutableMapping made with
+    the ``dol`` package) then it will save the value to that store for future use.
 
     >>> d = dict(some='store')
     >>> s = user_gettable(save_to=d)

config2py/tools.py

@@ -37,6 +37,7 @@ def get_configs_local_store(
             from config2py.s_configparser import ConfigStore
 
             return ConfigStore(config_src)
+
     elif os.path.sep not in config_src:  # it's just a string
         # TODO: is "get" the right word, since it makes the folder too
         path = get_configs_folder_for_app(config_src, configs_name=configs_name)

config2py/util.py

@@ -4,7 +4,7 @@ import re
 import os
 import ast
 from pathlib import Path
-from typing import Optional, Union, Any, Callable, Set
+from typing import Optional, Union, Any, Callable, Set, Iterable
 import getpass
 
 DFLT_APP_NAME = 'config2py'
@@ -21,6 +21,11 @@ def identity(x: Any) -> Any:
     return x
 
 
+def is_not_empty(x: Any) -> bool:
+    """Function that returns True if x is not empty."""
+    return bool(x)
+
+
 # TODO: Make this into an open-closed mini-framework
 def ask_user_for_input(
     prompt: str,
@@ -55,9 +60,12 @@ def ask_user_for_input(
     if default:
         prompt = prompt + f' [{default}]: '
     if mask_input:
-        response = getpass.getpass(prompt)
+        _prompt_func = getpass.getpass
     else:
-        response = input(prompt)
+        _prompt_func = input
+
+    response = _prompt_func(prompt)
+
     if masking_toggle_str is not None and response == masking_toggle_str:
         return ask_user_for_input(
             _original_prompt,
@@ -168,19 +176,19 @@ DFLT_APP_DATA_FOLDER = os.getenv(
 
 
 def process_path(
-    path: str,
-    *,
+    *path: Iterable[str],
     ensure_dir_exists=False,
     assert_exists=False,
     ensure_endswith_slash=False,
     ensure_does_not_end_with_slash=False,
     expanduser=True,
+    rootdir: str = '',
 ) -> str:
     """
     Process a path string, ensuring it exists, and optionally expanding user.
 
     Args:
-        path (str): The path to process.
+        path (Iterable[str]): The path to process. Can be multiple components of a path.
         ensure_dir_exists (bool): Whether to ensure the path exists.
         assert_exists (bool): Whether to assert that the path exists.
         ensure_endswith_slash (bool): Whether to ensure the path ends with a slash.
@@ -190,11 +198,20 @@ def process_path(
     Returns:
         str: The processed path.
 
+    >>> process_path('a', 'b', 'c')
+    'a/b/c'
+    >>> from functools import partial
+    >>> process_path('a', 'b', 'c', rootdir='/root/dir/', ensure_endswith_slash=True)
+    '/root/dir/a/b/c/'
+
     """
+    path = os.path.join(*path)
     if ensure_endswith_slash and ensure_does_not_end_with_slash:
         raise ValueError(
             'Cannot ensure both ends with slash and does not end with slash.'
         )
+    if rootdir:
+        path = os.path.join(rootdir, path)
     if expanduser:
         path = os.path.expanduser(path)
     if ensure_endswith_slash:
@@ -283,8 +300,8 @@ def get_app_data_folder(
     >>> get_app_data_folder()  # doctest: +ELLIPSIS
     '.../.config/config2py'
 
-    You can specify a different app name though. 
-    And if you want, you can also specify a callback function to initialize the 
+    You can specify a different app name though.
+    And if you want, you can also specify a callback function to initialize the
     directory.
 
     >>> path = get_app_data_folder('my_app', ensure_exists=True)  # doctest: +SKIP
@@ -303,7 +320,7 @@ def get_app_data_folder(
         get_app_data_rootdir(ensure_exists=ensure_exists), app_name
     )
     app_data_folder_did_not_exist = not os.path.isdir(app_data_path)
-    app_data_folder = process_path(app_data_path, ensure_dir_exists=True)
+    process_path(app_data_path, ensure_dir_exists=True)
 
     if app_data_folder_did_not_exist:
         setup_callback(app_data_path)

{config2py-0.1.27.dist-info → config2py-0.1.29.dist-info}/METADATA

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

config2py-0.1.29.dist-info/RECORD

@@ -0,0 +1,15 @@
+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=k-PcyvcWFaO_vQn9gbkHf41CDh_sEtZYAWGRno7xsxo,8425
+config2py/util.py,sha256=XW0kIu8MulBx9WbnEBJnByZ-wv08vqFJRtm2mzkRwok,15729
+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.29.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+config2py-0.1.29.dist-info/METADATA,sha256=-Rdx2t-wJ1rxNGDzXlNuBz4FsWyhOyR-a4oNLtPe6s4,14559
+config2py-0.1.29.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+config2py-0.1.29.dist-info/top_level.txt,sha256=DFnlOIKMIGWQRROr3voJFhWFViHaWgTTeWZjC5YC9QQ,10
+config2py-0.1.29.dist-info/RECORD,,

{config2py-0.1.27.dist-info → config2py-0.1.29.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

config2py-0.1.27.dist-info/RECORD

@@ -1,15 +0,0 @@
-config2py/__init__.py,sha256=pIRwstYdRf794ew7o8zgb057dV-RSMi7uQYiod2IhHU,752
-config2py/base.py,sha256=hqXR0KeCsss24X7O_rxklWVBw-Gea1uUY7K-0ByNZvo,15244
-config2py/errors.py,sha256=QdwGsoJhv6LHDHp-_yyz4oUg1Fgu4S-S7O2nuA0a5cw,203
-config2py/s_configparser.py,sha256=XhxFz6-PG4-QsecJfbjLFdBWHcPU6dwgqwkTZyY_y3E,15873
-config2py/tools.py,sha256=G31ed8MrCPIMFNUuXeIkSQVWnfRgdK94d7Dmtg1vrDY,8424
-config2py/util.py,sha256=3nUgRmzJg7sXnutB1rR8BRHhRmJ9t_7xYCGWvwr1HOM,15237
-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.27.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-config2py-0.1.27.dist-info/METADATA,sha256=HGBgqpSEVM4Afh_RhF1e4uvFVNK5Zg29Mna_sn--kO8,14559
-config2py-0.1.27.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-config2py-0.1.27.dist-info/top_level.txt,sha256=DFnlOIKMIGWQRROr3voJFhWFViHaWgTTeWZjC5YC9QQ,10
-config2py-0.1.27.dist-info/RECORD,,