config2py 0.1.40__py3-none-any.whl → 0.1.42__py3-none-any.whl

config2py/__init__.py

@@ -15,7 +15,9 @@ from config2py.base import get_config, user_gettable, sources_chainmap
 from config2py.util import (
     envvar,  # os.environ, but with dict display override to hide secrets
     ask_user_for_input,
+    get_app_config_folder,
     get_app_data_folder,
+    get_app_folder,
     get_configs_folder_for_app,
     is_repl,
     parse_assignments_from_py_source,

config2py/util.py

@@ -1,10 +1,14 @@
-"""Utility functions for config2py."""
+"""
+Utility functions for config2py.
+
+"""
 
 import re
 import os
 import ast
 from collections import ChainMap, namedtuple
 from pathlib import Path
+from functools import partial
 from typing import Optional, Union, Any, Callable, Set, Literal, get_args
 from types import SimpleNamespace
 import getpass
@@ -340,7 +344,16 @@ def get_app_rootdir(
     - 'runtime': %TEMP%
 
     Args:
-        folder_kind: Type of folder ('config', 'data', 'cache', 'state', or 'runtime')
+        folder_kind (str): The kind of folder to get. One of 'config', 'data', 'cache', 'state', 'runtime'.
+            Defaults to 'config'.
+            Here are concise explanations for each folder kind:
+            **config**: User preferences and settings files (e.g., API keys, theme preferences, editor settings). Files users might edit manually or that define how the app behaves.
+            **data**: Essential user-created content and application state (e.g., databases, saved games, user documents, session files). Data that should be backed up and persists across updates.
+            **cache**: Temporary, regeneratable files (e.g., downloaded images, compiled assets, web cache). Can be safely deleted to free space without losing user work.
+            **state**: Application state and logs that persist between sessions but aren't critical user data (e.g., command history, undo history, recently opened files, log files). Unlike cache, shouldn't be auto-deleted.
+            **runtime**: Temporary runtime files that only exist while the app runs (e.g., PID files, Unix sockets, lock files, named pipes). Typically cleared on logout/reboot.
+            **TL;DR**: config = settings, data = user files, cache = disposable, state = logs/history, runtime = process files.
+
         ensure_exists: Whether to create the directory if it doesn't exist
 
     Returns:
@@ -355,6 +368,7 @@ def get_app_rootdir(
     - If neither is set, uses platform defaults
 
     Examples:
+
         >>> get_app_rootdir('config')  # doctest: +SKIP
         '/Users/.../.config'
         >>> get_app_rootdir('data')  # doctest: +SKIP
@@ -395,7 +409,7 @@ def _default_folder_setup(directory_path: str) -> None:
         (Path(directory_path) / ".config2py").write_text("Created by config2py.")
 
 
-def get_app_data_folder(
+def get_app_folder(
     app_name: str = DFLT_APP_NAME,
     *,
     setup_callback: Callable[[str], None] = _default_folder_setup,
@@ -403,45 +417,49 @@ def get_app_data_folder(
     folder_kind: AppFolderKind = DFLT_APP_FOLDER_KIND,
 ) -> str:
     """
-    Retrieve or create the app data directory specific to the given app name and folder kind.
+    Retrieve or create the app directory specific to the given app name and folder kind.
 
     The folder kind determines where the app's files are stored:
-    - 'config': For configuration/settings files
-    - 'data': For essential user data, databases, sessions
-    - 'cache': For temporary/regeneratable data
+    Here are concise explanations for each folder kind:
+        **config**: User preferences and settings files (e.g., API keys, theme preferences, editor settings). Files users might edit manually or that define how the app behaves.
+        **data**: Essential user-created content and application state (e.g., databases, saved games, user documents, session files). Data that should be backed up and persists across updates.
+        **cache**: Temporary, regeneratable files (e.g., downloaded images, compiled assets, web cache). Can be safely deleted to free space without losing user work.
+        **state**: Application state and logs that persist between sessions but aren't critical user data (e.g., command history, undo history, recently opened files, log files). Unlike cache, shouldn't be auto-deleted.
+        **runtime**: Temporary runtime files that only exist while the app runs (e.g., PID files, Unix sockets, lock files, named pipes). Typically cleared on logout/reboot.
+        **TL;DR**: config = settings, data = user files, cache = disposable, state = logs/history, runtime = process files.
 
     Args:
-        app_name: Name of the app for which the data directory is needed.
+        app_name: Name of the app for which the directory is needed.
         setup_callback: A callback function to initialize the directory.
                        Default is _default_folder_setup.
         ensure_exists: Whether to ensure the directory exists.
-        folder_kind: Type of folder ('config', 'data', or 'cache').
+        folder_kind: Type of folder ('config', 'data', 'cache', 'state', or 'runtime').
                     Default is 'config' for backward compatibility.
 
     Returns:
-        str: Path to the app data directory.
+        str: Path to the app directory.
 
     By default, the app will be "config2py" and folder_kind will be "config":
 
-    >>> get_app_data_folder()  # doctest: +ELLIPSIS
+    >>> get_app_folder()  # doctest: +ELLIPSIS
     '.../.config/config2py'
 
     You can specify a different app name and folder kind:
 
-    >>> get_app_data_folder('my_app', folder_kind='data')  # doctest: +SKIP
+    >>> get_app_folder('my_app', folder_kind='data')  # doctest: +SKIP
     '/Users/.../.local/share/my_app'
-    >>> get_app_data_folder('my_app', folder_kind='cache')  # doctest: +SKIP
+    >>> get_app_folder('my_app', folder_kind='cache')  # doctest: +SKIP
     '/Users/.../.cache/my_app'
 
     You can also specify a path relative to the app root directory:
 
-    >>> get_app_data_folder('another/app/subfolder', folder_kind='data')  # doctest: +SKIP
+    >>> get_app_folder('another/app/subfolder', folder_kind='data')  # doctest: +SKIP
     '/Users/.../.local/share/another/app/subfolder'
 
     If ensure_exists is True, the directory will be created and initialized
     with the setup_callback:
 
-    >>> path = get_app_data_folder('my_app', ensure_exists=True)  # doctest: +SKIP
+    >>> path = get_app_folder('my_app', ensure_exists=True)  # doctest: +SKIP
     >>> os.path.exists(path)  # doctest: +SKIP
     True
     """
@@ -456,10 +474,14 @@ def get_app_data_folder(
     return app_data_path
 
 
+get_app_config_folder = partial(get_app_folder, folder_kind="config")
+get_app_data_folder = partial(get_app_folder, folder_kind="data")
+
 DFLT_CONFIGS_NAME = "configs"
 
 
 # TODO: is "get" the right word, since it makes the folder too?
+# TODO: Merge get_configs_folder_for_app and get_app_config_folder
 def get_configs_folder_for_app(
     app_name: str = DFLT_APP_NAME,
     *,
@@ -478,13 +500,13 @@ def get_configs_folder_for_app(
     - config_dir_setup_callback (Callable[[str], None]): A callback function to initialize the configs directory.
                                                          Default is _default_folder_setup.
     """
-    app_dir = get_app_data_folder(app_name, setup_callback=app_dir_setup_callback)
+    app_dir = get_app_config_folder(app_name, setup_callback=app_dir_setup_callback)
     configs_dir = os.path.join(app_dir, configs_name)
     config_dir_setup_callback(configs_dir)
     return configs_dir
 
 
-get_app_data_directory = get_app_data_folder  # backwards compatibility alias
+get_app_data_directory = get_app_config_folder  # backwards compatibility alias
 get_configs_directory_for_app = (
     get_configs_folder_for_app  # backwards compatibility alias
 )

{config2py-0.1.40.dist-info → config2py-0.1.42.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: config2py
-Version: 0.1.40
+Version: 0.1.42
 Summary: Simplified reading and writing configurations from various sources and formats
 Home-page: https://github.com/i2mint/config2py
 License: apache-2.0
@@ -110,7 +110,7 @@ In fact, `simple_config_getter` is a function to make configuration getters that
 
 <img width="341" alt="image" src="https://github.com/i2mint/config2py/assets/1906276/09f287a8-05f9-4590-8664-10feda9ad617">
 
-But where you can control what the central store (by default "Local App Data Files" store) is, and whether to first search in environment variables or not, and whether to ask the user for the value, if not found before, or not. 
+But where you can control what the central store (by default a local configuration files store) is, and whether to first search in environment variables or not, and whether to ask the user for the value, if not found before, or not. 
 
 ```python
 from config2py import simple_config_getter, get_configs_local_store
@@ -130,7 +130,7 @@ print(*str(Sig(simple_config_getter)).split(','), sep='\n')
 `ask_user_if_key_not_found` specifies whether to ask the user if a configuration key is not found. The default is `None`, which will result in checking if you're running in an interactive environment or not. 
 When you use `config2py` in production though, you should definitely specify `ask_user_if_key_not_found=False` to make that choice explicit.
 
-The `configs_src` default is automatically set to be the `config2py/configs` folder of your systems's "App Data" folder (also configurable via a `CONFIG2PY_APP_DATA_FOLDER` environment variable). 
+The `configs_src` default is automatically set to be the `config2py/configs` folder of your system's config directory (following XDG standards on Unix/Linux/macOS). You can override this with environment variables like `CONFIG2PY_CONFIG_DIR`, `CONFIG2PY_DATA_DIR`, etc., or the standard XDG variables. 
 
 Your central store will be `config_store_factory(configs_src)`, and since you can also specify `config_store_factory`, you have total control over the store.
 
@@ -215,7 +215,9 @@ user again.
 * `get_config`: Get a config value from a list of sources. See more below.
 * `user_gettable`: Create a ``GettableContainer`` that asks the user for a value, optionally saving it.
 * `ask_user_for_input`: Ask the user for input, optionally masking, validating and transforming the input.
-* `get_app_data_folder`: Returns the full path of a directory suitable for storing application-specific data for a given app name.
+* `get_app_folder`: Returns the full path of a directory suitable for storing application-specific data for a given app name and folder kind (config, data, cache, state, runtime).
+* `get_app_config_folder`: Specialized version of `get_app_folder` for configuration files.
+* `get_app_data_folder`: Specialized version of `get_app_folder` for application data.
 * `get_configs_local_store`: Get a local store (mapping interface of local files) of configs for a given app or package name
 * `configs`: A default store instance for configs, defaulting to a local store under a default configuration local directory.
 

{config2py-0.1.40.dist-info → config2py-0.1.42.dist-info}/RECORD

@@ -1,15 +1,15 @@
-config2py/__init__.py,sha256=GZ8lkm8TOKrV-zVd_Tc_8XVXDzFePECacjhOSGe2xcs,844
+config2py/__init__.py,sha256=cxBsWlH6hy_xWP5pWUGN6ASfdz6LRwwxTleqqCVRcwg,891
 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=pnYRq7OnjOJfa3u0vhRXrleybJ6JCr39tByDsyB_qfA,20917
+config2py/util.py,sha256=B4hhPH3DJSME7HfgOBYjnhDRU0pO8lvfwDhE3VX68VI,23290
 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.40.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-config2py-0.1.40.dist-info/METADATA,sha256=5HPEIPtjVwB-QsYyNtgIRjACB4OKGPyrBAl48i-h_Ik,14541
-config2py-0.1.40.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-config2py-0.1.40.dist-info/top_level.txt,sha256=DFnlOIKMIGWQRROr3voJFhWFViHaWgTTeWZjC5YC9QQ,10
-config2py-0.1.40.dist-info/RECORD,,
+config2py-0.1.42.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+config2py-0.1.42.dist-info/METADATA,sha256=Cd00j8Y99fIxAf3rvVogrINNp_3PNrrMcBzwy9Cyrv8,14880
+config2py-0.1.42.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+config2py-0.1.42.dist-info/top_level.txt,sha256=DFnlOIKMIGWQRROr3voJFhWFViHaWgTTeWZjC5YC9QQ,10
+config2py-0.1.42.dist-info/RECORD,,