config2py 0.1.26__tar.gz → 0.1.28__tar.gz

{config2py-0.1.26 → config2py-0.1.28}/PKG-INFO

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

{config2py-0.1.26 → config2py-0.1.28}/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-0.1.28/config2py/tests/util.py

@@ -0,0 +1,38 @@
+import tempfile
+import os
+import pytest
+
+
+def test_process_path():
+    # Create a temporary directory
+    with tempfile.TemporaryDirectory() as temp_dir:
+        temp_path = os.path.join(temp_dir, 'foo/bar')
+
+        output_path = process_path(temp_path)
+        assert output_path == temp_path
+        assert not os.path.exists(output_path)
+
+        output_path = process_path(temp_path, expanduser=False)
+        assert output_path == temp_path
+        assert not os.path.exists(output_path)
+
+        with pytest.raises(AssertionError):
+            output_path = process_path(temp_path, assert_exists=True)
+
+        output_path = process_path(temp_path, ensure_dir_exists=True)
+        assert output_path == temp_path
+        assert os.path.exists(output_path)
+
+        output_path = process_path(temp_path, assert_exists=True)
+        assert output_path == temp_path
+        assert os.path.exists(output_path)
+
+        # If path doesn't end with a (system file separator) slash, add one:
+        output_path = process_path(temp_path, ensure_endswith_slash=True)
+        assert output_path == temp_path + os.path.sep
+
+        # If path ends with a (system file separator) slash, remove it.
+        output_path = process_path(
+            temp_path + os.path.sep, ensure_does_not_end_with_slash=True
+        )
+        assert output_path == temp_path

{config2py-0.1.26 → config2py-0.1.28}/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-0.1.26 → config2py-0.1.28}/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'
@@ -167,6 +167,58 @@ DFLT_APP_DATA_FOLDER = os.getenv(
 )
 
 
+def process_path(
+    *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 (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.
+        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.
+
+    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:
+        if not path.endswith('/'):
+            path = path + '/'
+    if ensure_does_not_end_with_slash:
+        if path.endswith('/'):
+            path = path[:-1]
+    if ensure_dir_exists:
+        os.makedirs(path, exist_ok=True)
+    if assert_exists:
+        assert os.path.exists(path), f'Path does not exist: {path}'
+    return path
+
+
 # Note: First possible i2 dependency -- vendoring for now
 def get_app_data_rootdir(*, ensure_exists=False) -> str:
     """
@@ -195,9 +247,7 @@ def get_app_data_rootdir(*, ensure_exists=False) -> str:
     to use.
 
     """
-    if ensure_exists and not os.path.isdir(DFLT_APP_DATA_FOLDER):
-        os.mkdir(DFLT_APP_DATA_FOLDER)
-    return DFLT_APP_DATA_FOLDER
+    return process_path(DFLT_APP_DATA_FOLDER, ensure_dir_exists=True)
 
 
 def _default_folder_setup(directory_path: str) -> None:
@@ -223,6 +273,7 @@ def get_app_data_folder(
     app_name: str = DFLT_APP_NAME,
     *,
     setup_callback: Callable[[str], None] = _default_folder_setup,
+    ensure_exists: bool = False,
 ) -> str:
     """
     Retrieve or create the app data directory specific to the given app name.
@@ -231,13 +282,39 @@ def get_app_data_folder(
     - app_name (str): Name of the app for which the data directory is needed.
     - setup_callback (Callable[[str], None]): A callback function to initialize the directory.
                                               Default is _default_folder_setup.
+    - ensure_exists (bool): Whether to ensure the directory exists.
 
     Returns:
     - str: Path to the app data directory.
+
+    By default, the app will be "config2py":
+
+    >>> 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 
+    directory.
+
+    >>> path = get_app_data_folder('my_app', ensure_exists=True)  # doctest: +SKIP
+    >>> path  # doctest: +SKIP
+    '/Users/.../.config/my_app'
+    >>> os.path.exists(path)  # doctest: +SKIP
+
+    You can also specify a path relative to the app data root directory
+    (on linux/mac systems, this is typically ~/.config)
+
+    >>> get_app_data_folder('another/app/and/subfolder')  # doctest: +SKIP
+    '/Users/.../.config/another/app/and/subfolder'
+
     """
-    app_data_path = os.path.join(get_app_data_rootdir(ensure_exists=True), app_name)
+    app_data_path = os.path.join(
+        get_app_data_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)
 
-    if not os.path.isdir(app_data_path):
+    if app_data_folder_did_not_exist:
         setup_callback(app_data_path)
     return app_data_path
 

{config2py-0.1.26 → config2py-0.1.28}/config2py.egg-info/PKG-INFO

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

{config2py-0.1.26 → config2py-0.1.28}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = config2py
-version = 0.1.26
+version = 0.1.28
 url = https://github.com/i2mint/config2py
 platforms = any
 description_file = README.md

config2py-0.1.26/config2py/tests/util.py

@@ -1 +0,0 @@
-print(__name__)