config2py 0.1.38__py3-none-any.whl → 0.1.39__py3-none-any.whl

config2py/util.py

@@ -5,7 +5,7 @@ import os
 import ast
 from collections import ChainMap
 from pathlib import Path
-from typing import Optional, Union, Any, Callable, Set, Iterable
+from typing import Optional, Union, Any, Callable, Set, Literal, Iterable
 import getpass
 
 from dol import process_path
@@ -18,6 +18,8 @@ from i2 import mk_sentinel  # TODO: Only i2 dependency. Consider replacing.
 DFLT_APP_NAME = "config2py"
 DFLT_MASKING_INPUT = False
 
+AppFolderKind = Literal["data", "config", "cache"]
+
 not_found = mk_sentinel("not_found")
 no_default = mk_sentinel("no_default")
 
@@ -273,7 +275,7 @@ def create_directories(dirpath, max_dirs_to_make=None):
 
 
 # Note: First possible i2 dependency -- vendoring for now
-def get_app_data_rootdir(*, ensure_exists=False) -> str:
+def get_app_rootdir(*, ensure_exists=True) -> str:
     """
     Returns the full path of a directory suitable for storing application-specific data.
 
@@ -286,12 +288,13 @@ def get_app_data_rootdir(*, ensure_exists=False) -> str:
 
     See https://github.com/i2mint/i2mint/issues/1.
 
-    >>> get_app_data_rootdir()  # doctest: +SKIP
+    >>> get_app_rootdir()  # doctest: +SKIP
     '/Users/.../.config'
 
-    If ``ensure_exists`` is ``True``, the folder will be created if it doesn't exist.
+    If ``ensure_exists`` is ``True`` (the default), the folder will be created if
+    it doesn't exist.
 
-    >>> get_app_data_rootdir(ensure_exists=True)  # doctest: +SKIP
+    >>> get_app_rootdir(ensure_exists=True)  # doctest: +SKIP
     '/Users/.../.config'
 
     Note: The default app data folder is the system default for the current operating
@@ -300,7 +303,11 @@ def get_app_data_rootdir(*, ensure_exists=False) -> str:
     to use.
 
     """
-    return process_path(DFLT_APP_DATA_FOLDER, ensure_dir_exists=True)
+    return process_path(DFLT_APP_DATA_FOLDER, ensure_dir_exists=ensure_exists)
+
+
+# renaming get_app_data_rootdir to get_app_rootdir
+_legacy_app_data_rootdir = get_app_rootdir  # backwards compatibility alias
 
 
 def _default_folder_setup(directory_path: str) -> None:
@@ -322,11 +329,15 @@ def _default_folder_setup(directory_path: str) -> None:
         (Path(directory_path) / ".config2py").write_text("Created by config2py.")
 
 
+DFLT_APP_FOLDER_KIND: AppFolderKind = "config"
+
+
 def get_app_data_folder(
     app_name: str = DFLT_APP_NAME,
     *,
     setup_callback: Callable[[str], None] = _default_folder_setup,
     ensure_exists: bool = False,
+    folder_kind: AppFolderKind = DFLT_APP_FOLDER_KIND,
 ) -> str:
     """
     Retrieve or create the app data directory specific to the given app name.
@@ -361,9 +372,7 @@ def get_app_data_folder(
     '/Users/.../.config/another/app/and/subfolder'
 
     """
-    app_data_path = os.path.join(
-        get_app_data_rootdir(ensure_exists=ensure_exists), app_name
-    )
+    app_data_path = os.path.join(get_app_rootdir(ensure_exists=ensure_exists), app_name)
     app_data_folder_did_not_exist = not os.path.isdir(app_data_path)
     process_path(app_data_path, ensure_dir_exists=True)
 

{config2py-0.1.38.dist-info → config2py-0.1.39.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: config2py
-Version: 0.1.38
+Version: 0.1.39
 Summary: Simplified reading and writing configurations from various sources and formats
 Home-page: https://github.com/i2mint/config2py
 License: apache-2.0

{config2py-0.1.38.dist-info → config2py-0.1.39.dist-info}/RECORD

@@ -3,13 +3,13 @@ config2py/base.py,sha256=eQpRQjZYT-z6GhBemepaPUEyVVP8e_l04dghYeBBJdI,15880
 config2py/errors.py,sha256=QdwGsoJhv6LHDHp-_yyz4oUg1Fgu4S-S7O2nuA0a5cw,203
 config2py/s_configparser.py,sha256=-Sl2-J-QOLUiahwhCTiPsmjs4cKc79JuTbQ9gQcOiGY,15871
 config2py/tools.py,sha256=goDuHHXKJzdFgmHzDnLBGMZEhp0kKU-aK47c1-MpJT8,9199
-config2py/util.py,sha256=bchsJjaMnsfnplCJsg7i0Osyzuha3N-hExuc6gmS-7I,17188
+config2py/util.py,sha256=a3ynnasuO9DztfgAVmWwJfDVvfudKrWdFtJqxLIGbI8,17474
 config2py/scrap/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 config2py/tests/__init__.py,sha256=sk-yGJQOZES2z70M4xmZB57tsxSktX_84ybDuV8Cz5Q,297
 config2py/tests/test_tools.py,sha256=sdiBNTavuzxW2AsqBRTO9U21iWig5DEyV38r6lmaZak,3728
 config2py/tests/utils_for_testing.py,sha256=RcMiVtKK39rc8BsgIXQH3RCkd8qKo2o2MT7Rt0dJF2E,162
-config2py-0.1.38.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-config2py-0.1.38.dist-info/METADATA,sha256=cj4bH2tshyDKLOGqttbOXrNWV7zB_AjNr-1-dEYtfVg,14541
-config2py-0.1.38.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-config2py-0.1.38.dist-info/top_level.txt,sha256=DFnlOIKMIGWQRROr3voJFhWFViHaWgTTeWZjC5YC9QQ,10
-config2py-0.1.38.dist-info/RECORD,,
+config2py-0.1.39.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+config2py-0.1.39.dist-info/METADATA,sha256=Uvu5Fe6r2JteTAlVeGJgTQaPd61daxtXOMmapyPYh90,14541
+config2py-0.1.39.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+config2py-0.1.39.dist-info/top_level.txt,sha256=DFnlOIKMIGWQRROr3voJFhWFViHaWgTTeWZjC5YC9QQ,10
+config2py-0.1.39.dist-info/RECORD,,