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

config2py/util.py

@@ -7,6 +7,8 @@ from pathlib import Path
 from typing import Optional, Union, Any, Callable, Set, Iterable
 import getpass
 
+from dol import process_path
+
 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
@@ -183,65 +185,66 @@ 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,
-    expandvars=True,
-    abspath=True,
-    rootdir: str = '',
-) -> str:
+def create_directories(dirpath, max_dirs_to_make=None):
     """
-    Process a path string, ensuring it exists, and optionally expanding user.
+    Create directories up to a specified limit.
 
-    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.
-        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.
+    Parameters:
+    dirpath (str): The directory path to create.
+    max_dirs_to_make (int, optional): The maximum number of directories to create. If None, there's no limit.
 
     Returns:
-        str: The processed path.
+    bool: True if the directory was created successfully, False otherwise.
+
+    Raises:
+    ValueError: If max_dirs_to_make is negative.
+
+    Examples:
+    >>> import tempfile, shutil
+    >>> temp_dir = tempfile.mkdtemp()
+    >>> target_dir = os.path.join(temp_dir, 'a', 'b', 'c')
+    >>> create_directories(target_dir, max_dirs_to_make=2)
+    False
+    >>> create_directories(target_dir, max_dirs_to_make=3)
+    True
+    >>> os.path.isdir(target_dir)
+    True
+    >>> shutil.rmtree(temp_dir)  # Cleanup
+
+    >>> temp_dir = tempfile.mkdtemp()
+    >>> target_dir = os.path.join(temp_dir, 'a', 'b', 'c', 'd')
+    >>> create_directories(target_dir)
+    True
+    >>> os.path.isdir(target_dir)
+    True
+    >>> shutil.rmtree(temp_dir)  # Cleanup
+    """
+    if max_dirs_to_make is not None and max_dirs_to_make < 0:
+        raise ValueError('max_dirs_to_make must be non-negative or None')
 
-    >>> 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/'
+    if os.path.exists(dirpath):
+        return True
 
-    """
-    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 expandvars:
-        path = os.path.expandvars(path)
-    if abspath:
-        path = os.path.abspath(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
+    if max_dirs_to_make is None:
+        os.makedirs(dirpath, exist_ok=True)
+        return True
+
+    # Calculate the number of directories to create
+    dirs_to_make = []
+    current_path = dirpath
+
+    while not os.path.exists(current_path):
+        dirs_to_make.append(current_path)
+        current_path, _ = os.path.split(current_path)
+
+    if len(dirs_to_make) > max_dirs_to_make:
+        return False
+
+    # Create directories from the top level down
+    for dir_to_make in reversed(dirs_to_make):
+        os.mkdir(dir_to_make)
+
+    return True
 
 
 # Note: First possible i2 dependency -- vendoring for now

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: config2py
-Version: 0.1.35
+Version: 0.1.36
 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 → config2py-0.1.36.dist-info}/RECORD

@@ -3,14 +3,13 @@ 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/util.py,sha256=xVxfOduKsv1BdNIFVVdPMmA0wxBYyipCFYpPD-r6A6Y,16136
 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.36.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+config2py-0.1.36.dist-info/METADATA,sha256=VGU8KFs1Xt3w8HL2cp-895nDZhbmXxgpTjBMhc_2lR0,14559
+config2py-0.1.36.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+config2py-0.1.36.dist-info/top_level.txt,sha256=DFnlOIKMIGWQRROr3voJFhWFViHaWgTTeWZjC5YC9QQ,10
+config2py-0.1.36.dist-info/RECORD,,

config2py/tests/test_util.py

@@ -1,39 +0,0 @@
-import tempfile
-import os
-import pytest
-from config2py.util import process_path
-
-
-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